Integração e API
Como recebo atualizações de verificação?
Configure as assinaturas de webhook corretas, verifique as assinaturas e processe com segurança novas tentativas e alterações de estado posteriores.
Equipa Toden · 2 min de leitura · Português
Nesta página
Resposta curta
Crie um endpoint webhook no ambiente correto e inscreva-se nos eventos que a sua integração necessita. Verifique a assinatura, armazene o ID lógico do evento e administre a atualização no seu back-end. O ecrã de preenchimento do candidato não substitui um resultado verificado.
Subscreva para receber as mudanças certas
A conclusão da verificação inicial e as alterações de estado posteriores têm finalidades diferentes. Subscreva os eventos de resultados de verificação documentados e adicione eventos de estado atualizado quando o seu sistema necessitar de alterações no revisor, no fluxo de trabalho ou no reenvio. Um endpoint mais antigo não pode ser inscrito em eventos adicionados após a sua criação.
Utilize o catálogo de eventos e a documentação atual da família de eventos para obter a carga exata. Não crie um manipulador em torno de um campo inventado a partir de um exemplo para outro produto.
Processe a entrega em segurança
Verifique o esquema de assinatura atual em relação aos bytes brutos do pedido antes de confiar na carga útil. Mantenha o segredo de assinatura de cada endpoint no armazenamento secreto do seu servidor e utilize o ambiente correspondente. Analisar e serializar novamente o corpo antes da verificação pode quebrar as assinaturas.
Persista o ID do evento do envelope para desduplicar as ações de negócio. Um reenvio manual pode criar outro registo de entrega para o mesmo evento lógico. A ordem de entrega entre eventos não é garantida; compare a versão do recurso ou leia o estado atual onde a decisão é importante.
Reconheça as entregas aceites prontamente e execute um trabalho mais lento de forma assíncrona com o seu próprio processamento durável. Não reconheça um evento que não possa reter em segurança para processamento.
Teste antes de ir para o ar
Utilize a ação de teste de webhook da consola no Sandbox, inspecione o histórico de entregas e reenvie um evento. Confirme se o efeito comercial ocorre uma vez. Exercite respostas com falha, novas tentativas, assinatura inválida e alterações fora de ordem. Em seguida, configure e teste o endpoint e o segredo de produção separados.
Guias relacionados
Este artigo foi útil?