Atenção! Esta versão da API
/v3do Software de Facturação CloudInvoice não será mais suportada e dará lugar a uma mais completa e robusta. Alguns endpoints e todo o output de resultados e erros irá alterar e, como tal, deverá efectuar as devidas alterações de acordo com a nova documentação já disponível aqui.
Por forma a garantirmos o pleno funcionamento de todas as integrações efectuadas até hoje, iremos continuar a disponibilizar a api antiga, assim como toda a sua documentação. Esta manutenção irá permitir também uma migração gradual e estável para a nova api, mais eficiente, rápida e robusta.
Para mais informação, por favor Contacte-nos através dos canais disponíveis.
Início
A API CloudInvoice dá-lhe a oportunidade de interagir com a sua conta CloudInvoice a partir de aplicações externas. Existe para permitir e facilitar o processo de criação de aplicações web e desktop que se desejem integrar e interagir com o CloudInvoice.
Importante:
Tanto a API como esta documentação estão em constante desenvolvimento.
É possível que hajam entradas em falta na documentação que já existem na API assim como endpoints
da API cuja existência melhoraria grandemente a experiência de quem usar a API.
Caso pretenda alguma informção ou endpoint que não conste na nossa documentação, por favor
visite a secção Suporte
para saber como deixar as suas sugestões.
Quem pode utilizar a API?
Qualquer utilizador registado no CloudInvoice poderá ter acesso à API, limitado pelas permissões dadas pelos seus administradores de empresa. De acordo com o plano da empresa, poderá ter acesso limitado a algumas funcionalidades da api. Para confirmar quais as funcionalidades disponíveis, poderá sempre consultar os nossos planos e as suas características.
Funcionamento:
A API CloudInvoice funciona com pedidos HTTP normais em GET ou POST,
que poderão ser realizados a partir de qualquer ferramenta própria (como cURL, HTTPie, qualquer REST client ou mesmo Ajax),
sendo o conteúdo do pedido (para pedidos POST) em formato JSON.
Tenha em atenção que os URLs da API acabam sempre com '/'.
$ curl https://www.cloudinvoice.net/v3/info
$ curl https://www.cloudinvoice.net/v3/info/
Pedidos:
Os pedidos são feitos ao endereço https://www.cloudinvoice.net/v3/, acrescentando-lhe o end-point da acção pretendida.
Nesta documentação, usaremos pedidos realizados a partir do software cURL como exemplo.
$ curl https://www.cloudinvoice.net/v3/
-H "Content-Type: application/json"
{
"status": "OK"
}
O header "Content-Type: application/json" deverá ser sempre usado nos pedidos.
De forma a simplificar e a tornar os exemplos menos confusos, este header poderá ser omitido, mas assuma que deve estar sempre presente.
Exemplo de Resposta com Erro:
Em caso de erro, qualquer que seja o tipo de erro, a API CloudInvoice responde, habitualmente, com um código 400 Bad Request.
{
"status_code": 400,
"error_type": "api_error",
"generic_msg": "A server error occurred.",
"detail_msg": "",
"error_code": "validation_error",
"errors": {
"non_field_errors": "Não existe nenhum cliente com este código."
}
}