Visão geral

Webhooks Bankly

Webhooks são recursos que permitem que dois sistemas (ou aplicações) se comuniquem entre si em tempo real quando um evento acontece, sem que nenhuma ação externa precise ser realizada no momento da comunicação.

Em nosso contexto, os Webhooks Bankly disparam dados atualizados aos parceiros, com informações referentes às suas operações.

Desse modo, o parceiro não necessita fazer múltiplas requisições nem desenvolver uma rotina de pesquisa nas APIs, poupando tempo e consumindo menos recursos.

🚧

Importante

O tempo máximo de resposta de nossas APIs é de 30 segundos.

Implementação

Para utilizar os Webhooks Bankly, o parceiro deverá construir uma API e disponibilizar seu endpoint para receber os eventos.

Além disso, será preciso realizar a configuração dos webhooks por meio das nossas APIs.

Mensagens protegidas por assinatura HMAC

Para assegurar a procedência das informações recebidas via webhook, todos os eventos enviados pelo Bankly possuem uma assinatura HMAC.

Ao desenvolver a API para o recebimento de eventos, é necessário que o parceiro adote essa assinatura como meio de autenticação.

❗️

Atenção

Somente por meio da assinatura HMAC é possível assegurar que os eventos recebidos são provenientes do Bankly e garantir a proteção do endpoint do parceiro contra aplicações maliciosas.

Envio de eventos

Os Webhooks Bankly disparam os eventos para as APIs do parceiro. Se a requisição não for respondida com um código de status de sucesso, o sistema fará três novas tentativas de envio, num intervalo de dois, quatro e seis segundos entre cada tentativa.

Após isso, cessaremos o envio de requisições, e o parceiro poderá utilizar nosso endpoint para nova tentativa.

Circuit Breaker

O Circuit Breaker é um recurso desenvolvido para que o endpoint do parceiro não seja impactado quando ele se encontra indisponível ou quando apresenta lentidão na resposta.

Em qualquer um dos casos, as mensagens enviadas via Webhooks Bankly entrarão no fluxo do Circuit Breaker e serão entregues quando o sistema do parceiro retornar à normalidade.