Boas práticas de integração

Use estas recomendações para reduzir falhas, evitar exposição de credenciais e deixar a integração pronta para produção.

Credenciais e token

Ambientes

  • Use HML para desenvolvimento e homologação.
  • Use produção somente depois de validar o fluxo.
  • Não misture token de HML com URL de produção.
  • Não misture token de produção com URL de HML.

Requests

  • Sempre envie Content-Type: application/json em requests com body JSON.
  • Sempre envie Authorization: Bearer {jwt_token} em chamadas protegidas.
  • Valide campos obrigatórios antes de chamar a API.
  • Envie CPF/CNPJ no formato esperado pelo seu fluxo.
  • Use timeout nas chamadas HTTP.

Retry

Use retry apenas quando fizer sentido.

Respostas

  • Não use apenas o status HTTP para decidir sucesso de negócio.
  • Leia também status.code e status.message.
  • Trate status.code diferente de 200.
  • Salve externalId quando ele for retornado.
  • Lembre que resultado negativo não é necessariamente erro técnico.
Exemplo:

Logs

Registre informações úteis para investigação, mas sem expor dados sensíveis. Quando for necessário registrar CPF, CNPJ, telefone ou e-mail para investigação, prefira mascarar parte do valor. Tokens, imagens, selfies e documentos em base64 não devem ser gravados em logs abertos.

Produção

Antes de ir para produção, valide o fluxo em homologação, gere um token com as credenciais do ambiente correto e confirme se a sua aplicação trata respostas de sucesso, erro e timeout.