Códigos de erro da API

Códigos de resposta HTTP

Códigos de resposta 2XX indicam uma solicitação processada com sucesso (por exemplo, código 200 para recuperar dados, código 201 para adicionar uma nova entidade, código 204 para exclusão etc.).
Códigos de resposta 4XX indicam que uma solicitação não pôde ser processada corretamente devido a alguns problemas de dados do lado do cliente (por exemplo, 404 ao acessar um recurso inexistente).
Códigos de resposta 5XX indicam que ocorreu um erro interno do lado do servidor durante o processamento da solicitação (por exemplo, quando o banco de dados está temporariamente indisponível).

Cada erro de resposta inclui o código HTTP e dados JSON com a descrição do erro. A estrutura é a seguinte:

error_code – código de erro inteiro;
error_message– descrição textual do erro;
details – detalhes adicionais do erro (o formato é especificado para cada caso). Pode estar vazio.

Exemplo de resposta de erro:

{
    "error_code": 0,
    "error_message": "Ocorreu um erro desconhecido do lado do servidor",
    "details": null
}

Códigos de erro:

0 – UNKNOWN Erro desconhecido do servidor.
1 - NOT ALLOWED Um método não permitido é chamado. Normalmente é seguido pelo status HTTP 405 na resposta. Por exemplo, ao tentar solicitar o método PATCH, enquanto apenas os de GET/POST são suportados.
2 - NOT REALIZED O método é documentado, mas não é realizado por algum motivo temporário ou permanente.
3 - INVALID STRUCTURE Estrutura incorreta da solicitação. Alguns campos obrigatórios estão ausentes ou ocorreu um erro de validação de formato.
4 - INVALID VALUE Valor incorreto do parâmetro dentro do corpo da solicitação ou da query.
5 - INVALID TYPE Tipo de dado inválido do parâmetro da solicitação.
6 - AUTH NOT PROVIDED Token de acesso não especificado.
7 - AUTH INVALID O token de acesso não existe no banco de dados.
8 - AUTH EXPIRED O token de autenticação expirou.
9 - AUTH FORBIDDEN Acesso negado ao usuário atual.
10 - NOT EXIST o recurso solicitado não é encontrado (alternativa ao HTTP status_code = 404).
11 - EXTERNAL SERVICE Erro no sistema de informação externo.
12 – DATABASE Erro crítico de banco de dados no host do servidor.