Webhooks

Funcionamento

Webhooks são chamadas que nossa API faz para sua integração após a ocorrência de um evento, como por exemplo o pagamento do desembolso de uma CCB.

É necessário que seu sistema disponibilize um endereço público para chamada de uma requisição HTTPS, via método POST, enviando como autorização um HEADER informado pelo cliente.

Cadastro

Para cadastrar o recebimento dos webhooks, veja as informações no guia de cadastro.

Boas práticas

Antes de implementar os webhooks, é crucial avaliar nossas recomendações e boas práticas para garantir o correto funcionamento e segurança dos eventos. Seguir essas orientações ajuda a evitar problemas comuns, melhora a eficiência do processamento e assegura a integridade dos dados recebidos.

Headers

O cabeçalho de autorização é um componente crítico na comunicação segura entre o cliente e o servidor. Ele é usado para autenticar a requisição do cliente, garantindo que a mesma seja feita por uma fonte autorizada. Esse cabeçalho será incluído em cada requisição de webhook enviada da API Giro.Tech para o seu servidor.

O cabeçalho de autorização geralmente segue o formato padrão:

Authorization: <Tipo> <Credenciais>

Tipo: Indica o método de autenticação utilizado. Para webhooks, comumente é utilizado o "Bearer", que se refere ao uso de um token de acesso.
Credenciais: São as informações de autenticação propriamente ditas, como um token JWT ou um token de acesso.

Um exemplo de cabeçalho de autorização com um token de acesso seria:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkNsaWVudGVOYW1lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Outro exemplo, utilizando um header personalizado X-Api-Key

X-Api-Key: dG9rZW4KdG9rZW4KdG9rZW4K

O nome e valor do header que será enviado conforme a sua escolha, então a definição se será um Authorization, Bearer, Basic, ou ApiKey por exemplo, fica a critério da sua implementação de segurança.

Renovação do Tokens

A Giro.Tech não realiza a renovação automática das credenciais cadastradas para o Authorization. Sempre que necessário atualizar alguma informação, novas informações deverão ser enviadas através do cadastro.