Implementar o webhook da nossa solução PlugBoleto pode deixar os processos do seu software mais otimizados, sabia? Vem ver detalhes!
Se você nos acompanha, sabe que somos fãs de soluções que facilitam a vida das software houses e de seus clientes finais. Automatizar processos não é apenas um luxo, é uma necessidade cada dia mais emergente.
No caso de empresas que trabalham com boletos, centralizar tudo em um só lugar é um grande passo em termos de produtividade e controle. Quando as atualizações desses documentos também passa a ser automática, tudo fica ainda mais fluido e fácil.
Nesse post, vamos falar sobre o Webhook do PlugBoleto, uma solução que vai mudar completamente o dia a dia de trabalho dos seus clientes – para melhor, é claro! Confira:
O que é a notificação Webhook?
É a informação transmitida quando acontece algum evento entre dois sistemas. Ele também é conhecido como retorno de chamada web ou HTTP e é um recurso utilizado para trabalhar com informações em tempo real, indispensável para quem trabalha com sistemas de pagamento, por exemplo.
Resumindo, o webhook é uma solução automática, que não necessita de nenhuma ação externa para acontecer. Tudo o que ele precisa informar é definido previamente e, a partir daí, ele entrega os dados sempre que forem necessários.
Quais são as vantagens?
Entre as vantagens do webhooks temos: informação em tempo real, mais controle e executa várias ações. | Imagem: Ron Lach.
Para os desenvolvedores e clientes, o webhook traz muitas vantagens. Vamos conhecer algumas delas?
Informação em tempo real
Com os dados sendo atualizados a todo momento, cria agilidade nos processos, economia de recursos e poupa mão-de-obra, já que tudo acontece de forma automática.
Mais controle
Com a atualização dos dados em tempo real, é possível prever possíveis erros e encontrar as soluções certas.
Executa outras ações
O webhook pode fazer muito mais do que apenas comunicar um evento. Ele pode executar outras ações a partir desse comunicado, o que permite a automatização de alguns processos.
Como isso funciona na API de boleto?
Como o tempo de processamento das remessas variam muito de banco para banco, nós da TecnoSpeed implementamos este recurso para que consigam obter as informações atualizadas dos boletos, assim que elas forem disponibilizadas para nossos sistemas.
O Webhook do PlugBoleto abre um caminho de comunicação direta entre sua aplicação e nossa API. Nós cortamos o caminho para aumentar a produtividade da sua equipe e para trazer mais comodidade, praticidade e segurança.
Após configurá-lo, seu software será alertado sempre que um boleto seu sofrer alguma mudança. Assim, você só consulta o boleto depois de receber nossas notificações de alerta, sem precisar configurar rotinas para ficar enviando requisições periodicamente, sem saber se há alguma alteração nos boletos.
Ao evitar estas consultas incertas, você economiza processamento e consumo de internet, tempo e energia. Com o Webhook, nossa solução oferece ainda mais precisão, automação e economia.
Como configurar?
Primeiramente, você precisa abrir uma rota em sua API que aceite uma requisição POST. O recomendado é que sua API, ao receber o Json que nosso servidor irá te enviar, responda à requisição POST com um statusCode 200.
O processo é super fácil e inteiramente feito a partir do painel da sua software house.
Ao logar, identifique o CNPJ do cedente que deseja ativar o recurso. No menu “Ações” clique em “Personalizar Webhook”, conforme exemplo abaixo:
Na próxima tela, você irá preencher as configurações da rota aberta em sua API, as informações de autenticação e os tipos das notificações que você deseja receber:
Marque a opção “Ativar” para habilitar o recurso. Depois disso, no campo URL, informe a URL da sua API que deve estar apta para receber requisições POST.
Enviaremos uma requisição contendo em seu body um json, que contém as informações dos boletos.
Você poderá preencher o campo “Header”, mas ele é opcional. Ao marcá-lo, aparecerão 2 novos campos onde você pode preencher o nome do campo de autenticação e a chave de autenticação.
Por fim, existem os campos que controlam quais tipos de alterações nós iremos te encaminhar. Possuímos 5 tipos de WebHooks que podemos disparar:
- Notificar ao Registrar: ao recebermos do banco o arquivo de retorno, e este altere a situação do boleto para “Registrado”, esta notificação será ativada;
- Notificar ao Liquidar: disparado ao recebermos o retorno e os boletos tiverem a situação atualizada para “Liquidado”;
- Notificar ao Baixar: disparado ao recebermos a confirmação da Baixa do Boleto;
- Notificar ao Rejeitar: disparado quando o boleto voltar do banco como “Rejeitado”;
- Notificar ao Alterar informação: 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.
O processo parece demorado, mas é melhor explicarmos de forma detalhada para você não ter nenhuma dúvida. Na verdade, você consegue fazer tudo em pouco tempo. É rápido e fácil!
Campos do json
- “tipoWH”: onde estará identificado o tipo da notificação que foi enviada;
- “dataHoraEnvio”: que identificará a data e hora em que a notificação foi gerada;
- “titulo”: o conteúdo deste campo irá variar de acordo com o tipo do json, ele trará informações para identificação do boleto de acordo com cada tipo de notificação.
Ajudar o seu cliente em todos os processos que podem tornar mais fácil a tarefa de lidar com boletos vai te colocar à frente da concorrência. Quando você torna o seu software essencial para a gestão de cobrança do seu cliente, ele fica muito mais satisfeito e vira um promotor do seu negócio.
Conheça a nossa solução de boletos que vai elevar a sua software house a outro nível! E se você preferir, também pode conferir o vídeo sobre esse conteúdo no nosso canal. É só clicar no play!
Conclusão
E aí, já entendeu como o Webhook do PlugBoleto pode fazer com que a sua Software House consiga economizar tempo e dinheiro, além de ajudar os seus clientes?
Agora que você entendeu como é fácil e ágil implementar essa API. Comenta aqui nos comentários como foi a sua experiência e se ficou alguma dúvida.
Para ficar por dentro de todas as novidades sobre o PlugBoleto e as APIs para documentos fiscais eletrônicos, acompanhe nosso blog e conheça outras soluções como o PlugMobile.
