Códigos de resposta
Status HTTP
| Status | Significado | O que fazer |
|---|---|---|
200 | Operação concluída. | — |
400 | Parâmetros incorretos, corpo vazio ou inválido, Content-Type diferente de application/json nas rotas de gestão, ou header Authorization ausente ou malformado. | Revise os campos, os headers e os valores enviados. |
401 | Token inválido ou expirado, ou credenciais não aceitas. | Obtenha um novo token em POST /oauth/token. |
403 | O operador não tem a permissão exigida ou acesso à entidade; nos relatórios, também start/end ausentes ou não inteiros; no login, operador bloqueado. | Confira as permissões dos grupos do operador e os parâmetros. |
404 | Entidade não encontrada. | Confira o identificador informado. |
415 | Content-Type diferente de application/x-www-form-urlencoded na emissão do token. | Envie as credenciais como formulário. |
500 | Erro interno do servidor. | Tente novamente; se persistir, acione o suporte. |
Formato dos erros
Os erros das rotas da API seguem o formato:
{
"field": "instance",
"error": "instance error",
"error_description": "NAME is required"
}Os erros de validação do header Authorization (400 e 401) são respondidos em texto simples, como Unauthorized.
Respostas sem registros
Os relatórios respondem 200 com {"data": null, "next": ""} quando não há registros para os filtros informados.
Códigos de mensagem
Os relatórios trazem o código da mensagem em CODIGOMENSAGEM (por exemplo, MSG0065 ou MSG3100). Ele identifica o evento registrado pela plataforma.