Contexto


Neste artigo, explicamos o uso do campo externalIdentifier nas requisições da nossa API. Ele é fundamental para garantir a idempotência das operações e evitar duplicações de registros em caso de reenvio de chamadas.


Pré-requisitos


Antes de utilizar esse campo, certifique-se de que:

  • Está autenticado com um token válido da nossa API;
  • Possui client_id e client_secret ativos;


1. Finalidade do externalIdentifier 


O campo externalIdentifier atua como uma chave de idempotência, ou seja, evita que uma mesma operação seja executada mais de uma vez em situações de reenvio.


Quando um externalIdentifier já foi utilizado anteriormente, a API:

  • Retorna exatamente o mesmo resultado da requisição original;
  • Não processa uma nova ação nem cria um novo recurso.


⚠️ Observações Importantes


  • Utilize sempre um valor único por operação para garantir rastreabilidade;
  • Em caso de reenvio acidental da requisição com o mesmo externalIdentifier, a API preserva a consistência dos dados, retornando a resposta original;
  • A idempotência ocorre quando utilizado para o mesmo endpoint, exemplo: usado o mesmo externalIdentifier para criação de uma conta.



Suporte


Para dúvidas ou acompanhamento de chamados, acesse: Portal de Suporte