Erros

Os erros da API seguem o padrão da RFC 9457 e retornam os status HTTP adequados em cada caso:

  • 2xx: sucesso
  • 4xx: erros do cliente (400) ou violação de regras de negócio (422)

Os principais campos no corpo das respostas de erros são:

  • type: o tipo do erro como uma URI completa da forma: https://180seg.github.io/sagas-docs/v1/problems/{PROBLEM_ID}
  • status: mesmo status retornado na resposta HTTP em si, para conveniência em tratamentos que recebem apenas o payload
  • title: título do erro
  • detail: explicação mais detalhada do erro -- pode ser igual ao título em alguns casos
  • instance: valor que identifica unicamente a ocorrência específica do erro. Ao entrar em contato com a 180 com dúvidas sobre erros, informar o valor de instance que foi retornado para agilizar a resolução do problema
  • problem-id: semelhante ao type, mas apenas uma chave e não uma URI completa. Não faz parte do padrão proposta pela RFC, mas é um campo que retornamos para possibilitar tratamento baseado em chaves mais concisas. Recomendamos sua utilização

Além dos campos padrão acima, presentes em todos os erros, campos adicionais podem estar presentes dependendo do tipo do erro.

A lista completa de erros possíveis de serem retornados pela API está disponível em https://180seg.github.io/sagas-docs/v1/problems, e pode ser filtrada por fluxos específicos ou tipos de seguro/operação.

📘

A grande maioria dos erros da API já segue o padrão descrito acima, e alguns outros erros mais raros ainda estão sendo migrados. Se encontrar algum erro relevante para ser tratado na sua integração que ainda não esteja no padrão, por favor entre em contato com a 180 para que possamos adequá-lo rapidamente