Nossa API conta com um recurso que faz o envio de Webhooks, ou seja, envia Jsons com notificações de alteração dos boletos diretamente para a sua aplicação.
Os chamados WebHooks são notificações que nós te enviaremos sempre que um boleto retornar do banco.
Então, como o tempo de processamento das remessas varia muito de banco para banco, nós implementamos este recurso para que os sistemas de nossos clientes consigam obter as informações atualizadas dos boletos assim que elas forem disponibilizadas para nós.
É um recurso muito interessante para ser utilizado juntamente com a nossa Transmissão Automática de Remessas e Retornos. Porque, tudo estando automatizado, seu sistema não precisará "desperdiçar" consultas, enviando para nossa API pedidos de consultas para boletos que ainda não estiverem sido processados pelo banco.
Com os WebHooks da Tecnospeed, nós iremos te avisar assim que o boleto for atualizado em nossa base de dados!
O envio ocorre assim que um evento cadastrado é acionado, e em caso de falha na entrega da notificação, é feito mais 3 tentativas de entrega, geralmente espaçadas em um intervalo de 15 segundos.
Esta documentação mostrará como fazer a atualização do cadastro dos Webhooks via integração HTTP (via API).
Obs.: Atualmente as notificações por WebHooks funcionam apenas em ambiente de produção no PlugBoleto.
PUT
Homologação:
https://homologacao.plugboleto.com.br/api/v1/webhooks
Produção:
https://plugboleto.com.br/api/v1/webhooks
Headers
Nome | Descrição | Exemplo |
Content-Type | Indica o tipo de arquivo | application/json |
cnpj-sh | CNPJ ou CPF da Software House | 01001001000113 |
token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
cnpj-cedente | CNPJ ou CPF do cedente | 01001001000113 |
Headers (Opcional)
Utilizar esses headers em caso de autenticação direto com as credenciais do cedente:
Nome | Descrição | Exemplo |
Content-Type | Indica o tipo de arquivo | application/json |
cnpj-cedente | CNPJ do Cedente | 01001001000113 |
token-cedente | Token do Cedente | f22b97c0c9a3d41ac0a3875aba69e5aa1 |
Body
Campo | Tipo | Descrição |
ativo | boolean | Booleano onde você atualiza o WebHook como ativo (true) ou destivado (false) |
url | string | URL de sua API (endereço para onde enviaremos as notificações POST) |
eventos* | Objeto | Array contendo quais os tipos de notificação que você deseja receber |
headers** | Objeto | Campo opcional, onde você pode passar a autenticação de sua API. |
*No campo eventos deve ser passado um objeto contendo os eventos que deseja cadastrar, os seguintes eventos são aceitados pela aplicação, "registrou", "liquidou", "baixou", "alterou", "protestou" e "rejeitou" (mais detalhes abaixo).
**No campo headers atualmente é aceito apenas uma propriedade.
Os Eventos, que são momentos em que a requisição são enviadas, podem ser:
- Registrou: Ao recebermos do banco o arquivo de retorno, e este altere a situação do boleto para "Registrado", esta notificação será ativada;
- Liquidou: Disparado ao recebermos o retorno e os boletos tiverem a situação atualizada para "Liquidado";
- Baixou: Disparado ao recebermos a confirmação da Baixa do Boleto;
- Alterou: Disparado quando o arquivo de retorno possuir informações que atualizem a data de vencimento e/ou valor dos boletos e demais alterações enviadas pelo banco, porém, com o boleto permanecendo com a mesma situação;
- Rejeitou: Disparado quando o boleto voltar do banco como "Rejeitado".
- Protestou: Disparado quando o boleto voltar do banco como situação de protesto, "Incluído cartório".
Exemplo:
{
"ativo":true,
"url": "https://minha-api.com.br/callback",
"eventos": {
"registrou": true,
"liquidou": false,
"baixou": false,
"protestou": false;
"alterou": false,
"rejeitou": false
},
"headers": {
"auth": "meu-token"
}
}
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_mensagem": "Configurações de webhook cadastrados com sucesso",
"_dados": []
}
Comentários
0 comentário
Por favor, entre para comentar.