Códigos de Resposta

Consistem API

Toda requisição feita à API retorna um código de status HTTP (HTTP Status Code) que informa o resultado do processamento. Utilizamos os padrões convencionais da web para indicar o sucesso ou falha das requisições.

Respostas de Sucesso (2xx)

Indicam que a requisição foi recebida, compreendida e processada com êxito.

Código
Descrição

200 OK

A solicitação foi bem-sucedida. O significado do resultado de "sucesso" depende do método HTTP:

GET: O recurso foi obtido e transmitido no corpo da mensagem. HEAD: Os cabeçalhos de representação são incluídos na resposta sem nenhum corpo de mensagem. PUT ou POST: O recurso que descreve o resultado da ação é transmitido no corpo da mensagem.

201 Created

A requisição foi bem sucedida e um novo recurso foi criado como resultado. Esta é normalmente a resposta enviada após as solicitações POST ou algumas solicitações PUT.

Erros do Cliente (4xx)

Indicam que houve um problema com os dados enviados (ex: parâmetros inválidos, autenticação falha ou recurso não encontrado).

Código
Descrição

400 Bad Request

O servidor não pode ou não irá processar a solicitação devido a algo que é percebido como um erro do cliente (por exemplo, sintaxe de solicitação malformada, enquadramento de mensagem de solicitação inválida ou roteamento de solicitação enganosa)

401 Unauthorized

Embora o padrão HTTP especifique "unauthorized", semanticamente, essa resposta significa "unauthenticated". Ou seja, o cliente deve se autenticar para obter a resposta solicitada.

403 Forbidden

O cliente não tem direitos de acesso ao conteúdo; ou seja, não é autorizado, portanto o servidor está se recusando a fornecer o recurso solicitado. Ao contrário do 401 Unauthorized, a identidade do cliente é conhecida pelo servidor.

404 Not Found

O servidor não pode encontrar o recurso solicitado. No navegador, isso significa que o URL não é reconhecido. Em uma API, isso também pode significar que o endpoint é válido, mas o próprio recurso não existe. Os servidores também podem enviar esta resposta em vez de 403 Forbidden para ocultar a existência de um recurso de um cliente não autorizado. Este código de resposta é provavelmente o mais conhecido devido à sua ocorrência frequente na web.

429 Too Many Requests

O usuário enviou muitas requisições num dado tempo ("limitação de frequência").

Erros do Servidor (5xx)

Indicam que a API encontrou um erro inesperado ao tentar processar a solicitação.

Código
Descrição

500 Internal Server Error

O servidor encontrou uma situação com a qual não sabe lidar.

502 Bad Gateway

Essa resposta de erro significa que o servidor, enquanto trabalhava como um gateway para obter uma resposta necessária para lidar com a solicitação, obteve uma resposta inválida. deve se autenticar para obter a resposta solicitada.

503 Service Unavailable

O servidor não está pronto para manipular a requisição Causas comuns são um servidor em manutenção ou sobrecarregado. Note que junto a esta resposta, uma página amigável explicando o problema deveria ser enviada. Esta resposta deve ser usada para condições temporárias e o cabeçalho HTTP Retry-After deverá, se possível, conter o tempo estimado para recuperação do serviço. O webmaster deve também tomar cuidado com os cabeçalhos relacionados com o cache que são enviados com esta resposta, já que estas respostas de condições temporárias normalmente não deveriam ser postas em cache.

504 Gateway Timeout

Essa resposta de erro é fornecida quando o servidor está atuando como um gateway e não consegue obter uma resposta a tempo.

Referência https://developer.mozilla.org

Atualizado