Passar para o conteúdo principal

Códigos de retorno REST da API do Produttivo

Entenda os códigos de retorno da API REST do Produttivo e saiba como identificar erros e sucessos nas requisições.

Escrito por Yuri Takaes
Atualizado essa semana

Neste artigo, você encontra os principais códigos de status HTTP que podem ser retornados ao realizar requisições em nossa API .


O que são códigos de status HTTP?

Os códigos de status HTTP são respostas enviadas pelo servidor após uma requisição.

Eles indicam se a solicitação foi processada com sucesso ou se houve algum problema durante a execução.


Códigos de sucesso (2xx)

Os códigos da categoria 2xx indicam que a requisição foi recebida e processada com sucesso.

Os principais pontos são:

  • A requisição foi entendida corretamente

  • O servidor conseguiu processar a ação

  • O retorno foi concluído sem erros

Pronto! Isso significa que sua integração está funcionando corretamente ✅


Códigos de erro (4xx e 5xx)

Os códigos das categorias 4xx e 5xx indicam que ocorreu algum erro na requisição.

Esses erros podem estar relacionados a dados enviados incorretamente, falta de autenticação ou falhas no servidor.


Principais códigos de erro da API

400 - Bad Request

A requisição está inválida ou mal formatada.

Possíveis causas:

  • Dados enviados incorretamente

  • Parâmetros obrigatórios ausentes

  • Erro na estrutura da requisição


401 - Unauthorized

A requisição não foi autorizada.

Possíveis causas:

  • Token de acesso inválido

  • Token expirado

  • Falha na autenticação


403 - Forbidden

O acesso foi negado, mesmo com autenticação.

Possíveis causas:

  • Permissões insuficientes

  • Recurso restrito


404 - Not Found

O recurso solicitado não foi encontrado.

Possíveis causas:

  • Endpoint incorreto

  • Recurso inexistente


422 - Unprocessable Entity

A requisição foi compreendida, mas não pôde ser processada.

Possíveis causas:

  • Dados inconsistentes

  • Validações de negócio não atendidas


500 - Internal Server Error

Ocorreu um erro interno no servidor.

Possíveis causas:

  • Falha inesperada na API

  • Instabilidade no sistema


Como interpretar os códigos de retorno

Para identificar rapidamente o que aconteceu:

  1. Verifique o código de status retornado

  2. Analise a mensagem de erro da API

  3. Revise os dados enviados na requisição

  4. Confirme se a autenticação está correta

A tabela abaixo apresenta os detalhes de cada código:

Código HTTP

Status HTTP

Métodos comumente encontrados

Descrição

400

Bad Request

POST, PUT

Provavelmente existe algo errado com o corpo da sua requisição Verifique se todas as chaves, vírgulas e aspas estão nos lugares corretos. Dica: utilize os request bodies do swagger como base;

401

Unauthorized

GET, POST, PUT, DEL

Você não está logado., Verifique suas informações de autenticação nos Headers (X-Auth-Login, X-Auth-Register, X-Auth-Token);

403

Forbidden

GET, POST, PUT, DEL

Normalmente retornado ao tentar consultar ou realizar uma ação que você não tem permissão;

404

Not Found

GET, DEL

Normalmente retornado ao tentar consultar ou excluir algo com ID incorreto ou que foi excluído;

422

Unprocessable Entity

POST, PUT

Algum item obrigatório está vazio ou com valor inválido no request body. Por exemplo, o nome ou algum ID da entidade que você está tentando criar/alterar;

500

Internal Server Error

GET, POST, PUT, DEL

Erro interno do servidor;

Respondeu à sua pergunta?