Erros

Temos formatos padronizados de erros retornados pela API seguindo código de status HTTP convencionais pra indiciar sucesso ou falha. As resposta com um código de status começando com 4xx ou 5xx podem ser consideradas como falhas.


Código de status HTTP

Código

Status

Descrição

401

Invalid Token

Token de acesso utilizado está inválido ou expirado.

403

Forbidden

Você autenticou, mas não tem permissão para acessar o recurso.

404

Not found

Rota não foi encontrada ou existe alguma informação incorreta.

500

Internal Server Error

Ocorreu um erro interno


Campo

Descrição

code

O código de status HTTP de erro retornado. Pode ser: 2xx, 4xx ou 5xx

key

Para erros de objeto de API, uma string curta da lista do lado direito, descrevendo o tipo de erro que ocorreu.

message

Uma mensagem legível que fornece uma breve descrição do erro.

details

Uma mensagem legível que fornece mais detalhes sobre o erro.


A API retorna erros no formato JSON na seguinte estrututa:
{
    "code": "REQUEST_VALIDATION_ERROR",
    "message": "Some fields are not valid",
    "details": [
        {
            "target": "field",
            "message": "error description"
        }
    ]
}