Páginas filhas
  • Guia de implementacao das APIs TOTVS

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  • O campo message deve descrever o erro de forma não técnica e pode ser usado pelos clientes para exibição ao usuário. O texto deste campo deve respeitar o idioma usado na requisição (definido pelo cabeçalho Accept-Language ou o padrão caso este não seja especificado). Além disso leve em consideração:
    • Não assuma que o usuário é um especialista no uso da sua API. Usuário Usuários podem incluir desenvolvedores, profissionais de TI, administradores e usuários finais;
    • Não assuma que o usuário saiba qualquer coisa sobre a implementação da função sendo exposta pelo endpoint;
    • Quando possível a mensagem deve ser construida de forma que um usuário técnico possa responder ao erro e corrigi-lo;
    • Mantenha a mensagem sucinta e, se necessário, inclua um link para a documentação de como corrigi-la.

...