Tratamento de erros

• Utilizar nosso modelo padronizado de resposta de erros.
• Manter sua lógica de tratamento de erros atualizada para se adaptar a quaisquer mudanças na API.

​

Modelo de resposta de erros

{
   "code":"<error_code>",
   "title":"<error_title>",
   "message":"<error_message>"
}

• code: Um identificador único e estável para o erro.
• title: Um breve resumo do problema.
• message: Orientação detalhada para resolver o erro.

​

Detalhes de erros em nível de campo

{
   "code":"0009",
   "title":"Missing Fields in Request",
   "message":"Your request is missing one or more required fields. Please refer to the documentation to ensure all necessary fields are included in your request.",
   "fields": {
      "{{field}}": "{{field}} is a required field"
   }
}

​

Boas práticas para tratamento de erros da API

​

1. Foque nos códigos de erro

• Os códigos de erro são estáveis e ideais para uma lógica de tratamento confiável.
• Mapeie os códigos de erro para resoluções específicas para garantir compatibilidade com atualizações da API.

​

2. Registre e informe

• Registre os erros para monitoramento e resolução de problemas.
• Forneça feedback claro e acionável aos usuários com sugestões de resolução.

​

3. Mantenha-se atualizado

• Revise regularmente a documentação de códigos de erro para se alinhar com condições novas ou atualizadas.
• Mantenha a lógica de tratamento de erros adaptável a mudanças futuras.