Integração Webhook

Objetivo

Facilitar que ambientes sistêmicos se comuniquem a partir de notificações de eventos, de forma passiva e continua. Essa tecnologia também conhecida como “retorno de chamada web”, consiste em um método simples para facilitar que APIs forneçam informações em tempo real, sem a necessidade de consultas recorrentes para avaliação de mudança de status.

Demanda

Consiste em realizar o envio de notificações de eventos de transferências bancárias de PIX e TED, pagamento de contas, de forma assíncrona, evitando que sistemas fiquem constantemente buscando por novas informações, do qual qualifica a diminuição de sobrecarga e indisponibilidade das aplicações. O cliente deve utilizar a funcionalidade via integração por API para realizar a inscrição das notificações.

Procedimento Existente

A inscrição do webhook fica a cargo do cliente que está integrando, devido a necessidade de requisitos sistêmicos para recebimentos das notificações.

Requisitos

Como requisito será necessário criar:

Possuir uma chave de autenticação.

Ter familiaridade com o padrão REST usando o protocolo OAuth 2.0.

Ter um serviço de Webhook ativo, para recebimento das notificações de eventos.

Realizar a inscrição dos recebimentos dos eventos.

Instruções

Webhook é uma funcionalidade sistêmica assíncrona, do qual se comunica a partir de notificações de eventos.

Nota:
Para inscrição é necessário a adição do parâmetro de senha para realização do cadastro.

1.Inscrição

1.1 Inscrição do webhook:

Registro do webhook, segue exemplo de resultado sem erros:

Endpoint

POST

- POST /subscribe/event

Campos de entrada:

Python

{
  "url": "string",
  "secret": "string"
}

Exemplo de cURL:

Python

curl --location -g --request POST 'https://{URI}/subscribe/event' \
--header 'Atar-ApiKey: 00be0083-8c8d-4d09-9f8f-***********' \ # Api key de acesso
--header 'Authorization: Bearer eyJhbGciOiJIUzI1**********' \ # token
--header 'Content-Type: application/json' \
--data-raw '{
    "secret":"senhaInformada",
    "url":"https://webhookInformado.free.beeceptor.com"
}'

Exemplo de retorno/callback:

Python

{
  "atarId": "string",
  "eventId": "string",
  "type": "string",
  "category": "string",
  "timestamp": "string",
  "title": "string",
  "subtitle": "string",
  "detail": {},
  "deviceType": "string"
}

2. Fluxograma

Fluxograma das principais caracteristicas do webhook.

3. Suporte

Central de ajuda Atar: Servide desk

Email: [email protected]