Notificações e eventos

Visão Geral

Webhooks também conhecidos como HTTP Callbacks são uma forma de se registrar para receber informações úteis em uma URL específica de sua escolha.

Quando ocorre uma alteração no estado de um recurso dentro das plataformas da AQPagoAPI, por exemplo, uma transação é aprovada com sucesso ou um estabelecimento comercial é aprovado pelo fluxo manual de credenciamento, um evento é gerado por essa ocorrência e enviado para os webhooks cadastrados.

Para utilizar a notificação de eventos por webhooks você precisa:

  • Implementar o seu sistema de recebimento de notificações.
  • Cadastrar as URLs do seu sistema na AQPagoAPI .

📘

Sugerimos que o seu sistema de recebimento de eventos construído para receber as notificações provenientes da AQPagoAPI, siga o paradigma de integração assíncrona, recebendo as mensagens e armazenando-as em filas para posterior consumo interno de seu sistema. Isso aumenta a disponibilidade e facilidade de manutenção e recuperação dessas integrações.

Vantagens na utilização
  • Escalabilidade
    Com o uso de notificações via webhooks é possível montar uma integração assíncrona com a AQPagoAPI, aumentando a escalabilidade de sua plataforma.
  • Transparência
    Algumas mudanças de estado dos seus recursos cadastrados na AQPagoAPI, acontecem mesmo que nenhuma chamada tenha sido realizada, como por exemplo, habilitação de vendedores ou cobrança de uma assinatura recorrente. Com os webhooks devidamente cadastrados.
  • Disponibilidade
    Nossa plataforma garante que os disparos de notificações acontecem com um prazo máximo de 1 minuto, contados a partir do horário da ocorrência que originou o evento.
Fluxo de retentativas de disparos

Uma vez que a primeira tentativa de entrega não obtém sucesso, a AQPagoAPI efetuará novos disparos dentro de poucos instantes. Após um número máximo de 3 tentativas sem sucesso, o evento entra em estado de falha na entrega.

Timeouts
Durante o disparo de um evento para um de seus webhook, a AQPagoAPI espera receber uma resposta em até 1 segundo. Caso esse tempo expire, fechamos a conexão e a AQPagoAPI irá tentar novamente o envio após 10 minutos.

📘

Aconselhamos que você realize um tratamento no seu sistema, garantindo que os eventos disparados em duplicidade sejam considerados apenas uma vez.