These docs are for v1.0. Click to read the latest docs for v4.1.

Erros

Entenda os principais códigos de retorno das nossas API's

HTTP 401 – Unauthorized###

Ocorre quando sua aplicação encaminhou uma credencial invalida ou inexistente.

HTTP 403 – Forbidden###

Ocorre quando sua conta ou aplicação não tem permissão para utilizar o serviço.

HTTP 405 – Method Not Allowed###

Ocorre quando sua aplicação efetuou a chamada utilizando um método não esperado. Neste caso verifique se o método da chamada é GET , POST ou PUT.

HTTP 415 – Cannot consume content type###

Ocorre quando não é encaminhado o Content-Type na chamada.

HTTP 400 – Bad Request###

Ocorre quando um ou mais dados foram encaminhados de forma incorreta ou fora do padrão. Este retorno possui um JSON ou XML no corpo da mensagem que identifica quais os erros presentes na chamada, no retorno sempre terá um código e uma mensagem descrevendo o erro.
Veja abaixo exemplos de retorno em XML e JSON.

📘

Algumas API's tem somente a opção de retorno em XML.

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<errors>
    <error>
        <code>Error Code</code>
        <message>Error Description</message>
    </error>
</errors>
{
  "error": true,
  "errors": {
    "error-number": "error description."
  }
}