Utilizar a API de Ocorrências e webhooks assinados

Ligue sistemas fidedignos utilizando credenciais de API com âmbito limitado e entregas de webhooks assinadas.

Antes de começar

Identifique a integração fidedigna e o recetor HTTPS.
Prepare um armazenamento seguro para os segredos e o tratamento de novas tentativas.

Definições de conectividade do Issue com controlos do token de API e campos do endpoint e do webhook assinado. — A conectividade mantém as credenciais limitadas a uma instância e apresenta o estado de entrega dos webhooks para diagnóstico.

Proteja as credenciais da API

Ative a API e gere um token apenas para uma integração fidedigna. O token é apresentado uma única vez; a sua rotação invalida a credencial anterior.

Utilize a concorrência e o âmbito

A API lista, cria, lê, atualiza e altera o estado apenas dentro da instância identificada pelo slug público. Ao atualizar, envie a versão de bloqueio atual para detetar escritas obsoletas.

Verifique a entrega dos webhooks

Configure um recetor HTTPS e um segredo. As entregas são assinadas e as tentativas permanecem visíveis para diagnóstico. Um webhook é uma notificação, não uma prova de que o sistema remoto processou o evento.

Passo a passo

Abra Conectividade em Definições.
Ative a API apenas para um consumidor fidedigno.
Gere e armazene o token de utilização única de forma segura.
Configure o URL do webhook HTTPS e o segredo.
Verifique as assinaturas, as novas tentativas e o histórico de entregas.

Verificação final

O token está armazenado fora dos registos e das capturas de ecrã.
As atualizações enviam a versão de bloqueio atual.
O recetor verifica todas as assinaturas.

Sugestão: Um webhook entregue comprova o transporte, mas não que o sistema remoto concluiu o seu próprio processamento.