Introdução aos Webhooks
Âmbito
Neste modelo de comunicação, o ilink toma a iniciativa de comunicar ao ERP no momento que um determinado evento ocorre, dispensando de consultas frequentes ao nosso API.
O ilink disponibiliza 2 webhooks:
- Webhook de novo documento - enviado ao receptor cada vez que um novo documento lhe é encaminhado
- Webhook de mudança de estado de documento - enviado ao emissor cada vez que um documento previamente emitido altera o seu estado
Para qualquer dos webhooks acima funcionar é necessário:
- Implementar um endpoint Web, disponível publicamente aos servidores do ilink, ao qual o ilink irá comunicar via HTTP. Os dados enviados do ilink para este URL público estão de acordo com o tipo de webhook que pretendem implementar.
- Comunicar à equipa do ilink que pretendem implementar o Webhook específico para o vosso cliente, e indicar-nos uma chave de acesso e o URL público do vosso endpoint.
Este método, apesar de implementação mais extensa, tem a vantagem de evitar polling constante aos nossos servidores, consumir menos recursos em ambos os sistemas, e permite aceder a toda a informação em tempo real. Só recomendamos optar pela consulta manual caso existam implicações de segurança na abordagem dos Webhooks.
Política de reenvio (Retry Policy)
Um webhook é considerado entregue com sucesso ao ERP quando a sua resposta retorna um HTTP status code 200 (independentemente do conteúdo da resposta). Recomendamos evitar processamentos longos no endpoint de resposta sob pena da ligação ser cancelada antes do processamento estar concluído.
Caso falhe o processo de comunicação, o ilink irá tentar comunicar novamente até 10 vezes nos próximos 7 dias, com intervalos incrementalmente maiores por cada tentativa. Após 10 tentativas comunicação falhadas, o ilink irá desistir de comunicar essa informação ao ERP.
| Número de tentativa | Tempo até a próxima tentativa |
|---|---|
| 1 a 2 | 4 horas |
| 3 a 5 | 5 horas |
| 6 a 9 | 12 horas |