Skip to content

Regras Gerais

Cada API DEVE usar os Códigos de status HTTP apropriados para comunicar o resultado de uma operação de solicitação.

CódigoNomeDescrição
200OKResposta a uma ação bem-sucedida da API REST.
201CreatedIndica que a ação foi bem-sucedida e um ou mais recursos foram criados.
204No ContentIndica que a ação foi bem-sucedida e não há conteuído a ser encaminhado na resposta.
400Bad RequestA solicitação está malformada, como um erro no formato do corpo da mensagem.
401UnauthorizedID/senha de autenticação incorretos ou inexistentes.
403ForbiddenUsado quando a autenticação foi bem-sucedida, mas o usuário autenticado não tem permissão para acessar o recurso solicitado.
404Not FoundQuando um recurso inexistente é solicitado.
405Method Not AllowedA verificação de erro para um método HTTP inesperado. Por exemplo, a API REST está esperando HTTP GET, mas HTTP PUT está sendo usado.
409ConflictA solicitação não pode ser concluída por um conflito com com o estado atual do recurso sendo processado.
429Too Many RequestsO erro é usado quando pode haver um ataque DOS detectado ou a solicitação é rejeitada devido ao Rate Limit.
500Internal Server ErrorO servidor encotrou um erro inesperado que impede o processamento da solicitação.

A API NÃO DEVE usar apenas 200 para sucesso ou 404 para erro. Cada mensagem de erro precisa ser personalizada e aplicar o código de retorno de acordo com a sua semântica.