Mensagens de sucesso

Código Descrição Condições para Utilização
200 OK Sucesso do método GET e dos métodos PATCH, PUT e DELETE síncronos
201 Created Sucesso do método POST síncrono
202 Accepted Sucesso dos métodos POST, PATCH, PUT e DELETE assíncronos
204 No Content Sucesso do método DELETE síncrono. Caso a modelagem exige que DELETE retorne um conteúdo como uma mensagem de sucesso ou id de transação, HTTP 200 deve ser utilizado.
304 Not Modified Utilizado junto com HTTP Cache, indica que o registro não foi alterado desde a última requisição.

Mensagens de erro

Código Descrição Condições para Utilização
400 Bad Request Problemas na validação do formato e sintaxe das mensagens de requisição:
- Formato da URI, HTTP Headers ou Query String.
- Validação de sintaxe do payload JSON contra JSON Schema quanto ao nome, tipo e obrigatoriedade dos campos.
- Aplicação das políticas de XML firewall.
401 Unauthorized Erro de autenticação: ocorre caso o cliente não enviar um token de autenticação (quando é obrigatório) ou enviar um token inválido.
403 Forbidden Problema de autorização: mesmo autenticado com sucesso, o solicitante não possui permissão de acesso ao recurso. Utilizado também quando o IP de origem não possui permissão de acesso ao recurso (IP filtering). No caso de API contratável, pode ocorrer quando uma versão não contratada é solicitada.
404 Not Found Um recurso não existente foi solicitado (URL inválida). É considerado falha de negócio, no cenário em que um recurso é solicitado pelo Identificador único mas inexiste.
405 Method Not Allowed Método HTTP solicitado indisponível, ou sem permissão de acesso (autorização) para o solicitante. No caso dos processos de negócio, também será retornado quando o DELETE for invocado sobre um processo ETOM que passou do PONR (point of no return).
406 Not Acceptable Indica que o formato solicitado pelo cliente não faz parte dos formatos implementados, ou seja, a API não consegue retornar o formato solicitado pelo cliente no header Accept . Ex.: GET com solicitação de XML, quando somente JSON é implementado; ou solicitação de envelopamento JSONP quando a API não suporta este padrão.
410 Gone Identifica que o recurso não está mais disponível. Deve ser utilizado para API e versões aposentadas, identificando que uma nova versão ou outra API deverá ser utilizada.
415 Unsupported Media Type Indica que o formato enviado pelo cliente não faz parte dos formatos aceitos, ou seja, a API não consegue processar o formato solicitado pelo cliente no header Content-Type. Ex.: POST enviando XML quando somente JSON é aceito.
422 Unprocessable Entity Indica que os dados enviados pelo cliente são semanticamente incorretos. Este código é utilizado para informar os seguintes problemas causados pelo cliente:
- Erros de validação lógica no API Gateway.
- Erros de negócio retornados a partir do backend.
- Dentro dos processos ETOM, erros que indicam que o processo foi suspenso (pode ser recuperado) ou interrompido definidamente por problemas de validação dos dados durante a execução da parte assíncrona do processo.
429 Too Many Requests Identifica que o cliente excedeu a política de requisições adquirida, ou uma política de segurança de DDOS foi acionada.
451 Unavailable For Legal Reasons Identifica que o cliente não pode acessar o recurso por restrições geográficas (geolocalização), legais ou regulatórios
500 Internal Server Error Erro imprevisto ocorreu no API Gateway ou no backend. A ocorrência deste erro implica em necessidade de abertura de um chamado ou incidente para a equipe de produção.
503 Service Unavailable Erro retornado quando o backend está indisponível (fora do ar, downtime de manutenção ou throttling).