Padrões de Retorno (response)

Esta página pretende descrever todos os padrões de retorno (response) das de APIs utilizado pela Sompo.

Códigos de Retorno (response)

A API precisa retornar os códigos HTTP corretos para cada request. O cabeçalho (header) de resposta HTTP devem ser utilizados conforme tabela abaixo.

Tipos de cabeçalho (header)
Nome do cabeçalho Descrição Obrigatório
Content-Encoding Cabeçalho que indica o tipo de encoding (geralmente algoritmo de compressão) que foi utilizado para envio da resposta. Não
Content-Type Representa o formato do payload de resposta. Deverá ser application/json a menos que o endpoint requisitado suporte outro formato e este formato tenha sido solicitado através do cabeçalho Accept no momento da requisição. Sim
Accept-Encoding Especifica os tipos de encoding(geralmente algoritmo de compressão) que são suportados pelo cliente, sendo que o padrão é a transmissão dos dados não compactados e esta orientação aplica-se a todos dados. Não
If-Modified-Since Condiciona o resultado da requisição para que o recurso só seja enviado caso tenha sido atualizado após a data fornecida. Utiliza o padrão da RFC 7232, sessão 3.3: If-Modified-Since do protocolo HTTP. Não
Authorization Cabeçalho HTTP padrão. Permite que as credenciais sejam fornecidas dependendo do tipo de recurso solicitado Sim

A API precisa retornar os códigos HTTP corretos para cada request.Os códigos de resposta HTTP devem ser utilizados conforme tabela abaixo.

Códigos de Retorno (response)
Código HTTP Mensagem POST GET DELETE
200 OK. Consulta realizada com sucesso. Sim Sim Não
201 Created. Execução normal. A solicitação foi bem sucedida. Sim Não Não
204 No Content. Operação de exclusão concluída com sucesso. Não Não Sim
304 Not Modified. A resposta não foi modificada desde a última chamada Não Sim Não
400 Bad Request. A requisição foi malformada. Sim Sim Sim
401 Unauthorized. Cabeçalho de autenticação ausente/inválido ou token inválido. Sim Sim Sim
403 Forbidden. O token tem escopo incorreto ou uma política de segurança foi violada. Sim Sim Sim
404 - Not Found O recurso informado no request não foi encontrado. Sim Sim Sim
413 - Request is to Large A requisição está ultrapassando o limite permitido para o perfil do seu token de acesso. Sim Sim Sim
422 - Unprocessable Entity A requisição possui erros de negócio. Sim Sim Sim
429 - Too Many Requests O consumidor estourou o limite de requisições por tempo. Sim Sim Sim
500 - Internal Server Error Erro não esperado, algo está quebrado na API. Sim Sim Sim

NOTA: Nos casos das APIs que retornarem qualquer código de retorno, favor enviar e-mail para arquiteturadeti@sompo.com.br com um print do erro para que possamos avaliar e informar as devidas orientações ou, se for o caso, aplicar as correções necessárias.

Undefined