{b% load base_tags %}

Início

A API CloudInvoice dá-lhe a oportunidade de interagir com a sua conta CloudInvoice a partir de aplicações externas.

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. Visite a secção Suporte para saber como deixar as suas sugestões.

This Api Version /V3 of CloudInvoice will soon be deprecated and will be replaced by a new one more complete and well documented. Some endpoints, outputs and errors formats will change and some new ones will be added.
For more information, please Contact us to know more.

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."
    }
}