Callbacks

As callbacks permitem o envio de dados de forma assíncrona para uma aplicação sempre que um determinado evento ocorrer.

Esse mecanismo é utilizado quando sua aplicação precisa ser notificada sobre alterações ou eventos sem precisar consultar nossa API continuamente.

Como funciona?

Quando um evento configurado ocorre, nossa API envia uma requisição para a URL de callback previamente configurada.

Evento → Nossa API → Callback → Sua aplicação

A requisição contém os dados relacionados ao evento no body da requisição.

Configuração

A URL de cada callback poderá ser definida por você de acordo com as necessidades da sua integração. Para solicitar o cadastro de uma callback, entre em contato conosco informando a URL que deseja utilizar.

Após o cadastro da URL em nosso sistema, você receberá um e-mail confirmando a URL configurada e um token único de autenticação, exclusivo da callback, que deverá ser utilizado para validar as requisições recebidas.

Segurança e Autenticação

Para garantir uma integração segura e reduzir o risco de vulnerabilidades, recomendamos:

• Uso de HTTPS: para proteger os dados durante a transmissão.
• Validação do Token: sua aplicação deve validar o token de autenticação enviado em todas as requisições recebidas para garantir que os dados provêm da nossa plataforma. O mesmo token é enviado tanto no body quanto nos headers da requisição, para que você possa validá-lo da forma mais conveniente à sua implementação.

Estrutura

Headers

Esses são os headers padrões que enviaremos:

Content-Type: application/json
Origin: {URL}
Authorization: Bearer {token}
clientID: {token}

Payload

O payload vai variar de acordo com o tipo de callback.

Resposta esperada

Ao receber a callback, sua aplicação deve retornar o status 200 OK para confirmar o recebimento com sucesso.

Tipos de callback

Atualmente estão disponíveis 3 tipos de callback:

• Provedor
• Assinante
• Ativação

Consulte a página de cada uma para detalhes sobre o payload específico.