Padrões de Resposta

Visão Geral

Esta documentação descreve os possíveis códigos de erro que podem ser retornados pela API ao lidar com requisições

Códigos de Sucesso

200 - OK

Descrição: Indica que a requisição foi bem-sucedida e o servidor retornou os dados solicitados.

204 - No Content

Descrição: Indica que a solicitação foi bem sucedida e o cliente não precisa sair da página atual.

Códigos de Erro

400 - Bad Request

Descrição: Este código de erro indica que o servidor não pode ou não irá processar a requisição devido a algo que é percebido como um erro do cliente (por exemplo, sintaxe de requisição malformada, formatação inválida da mensagem de requisição ou roteamento de requisição enganoso).

Exemplo de Resposta:

{
  "error": "Bad Request",
  "message": "Os parâmetros obrigatórios 'param1' e 'param2' estão ausentes.",
  "code": 400
}

401 - Unauthorized

Descrição: Este código de erro indica que a requisição não foi aplicada porque falta credenciais de autenticação válidas para o recurso de destino.

Exemplo de Resposta:

{
  "error": "Unauthorized",
  "message": "Credenciais inválidas. Autenticação necessária para acessar os recursos.",
  "code": 401
}

404 - Not Found

Descrição: Este código de erro indica que o servidor de origem não encontrou uma representação atual para o recurso de destino ou não está disposto a divulgar que uma existe. Um código de status 404 não indica se essa falta de representação é temporária ou permanente.

Exemplo de Resposta:

{
  "error": "Not Found",
  "message": "O recurso solicitado não pôde ser encontrado.",
  "code": 404
}

500 - Internal Server Error

Descrição: Indica que ocorreu um erro inesperado no servidor ao processar a requisição.

Exemplo de Resposta:

{
  "error": "Internal Server Error",
  "message": "O servidor encontrou um erro inesperado ao processar a requisição.",
  "code": 500
}