Webhook: o que é, importância, como criar e implementar

6,9K

Webhook é um assunto que toda equipe de tecnologia deveria dominar, pois tem tudo a ver com transações virtuais (o que interessa a diversos segmentos de negócio).

Portanto, se você ainda não sabe muito a respeito, a leitura deste texto é mais do que recomendada.

Inspirado em um documento da Sendgrid (em inglês), este artigo ilustra de forma simples as razões para a sua equipe conhecer o conceito.

Se você quer facilitar o envio e recebimento de informações, com segurança e agilidade, continue lendo e descubra as vantagens dos webhooks!

O que é webhook?

Webhook é uma tecnologia que permite a comunicação programada entre duas aplicações, gerando uma resposta e enviando notificações em tempo real. 

Na prática, quando acontece um determinado evento em um sistema, ele envia uma notificação para outro sistema, que atua como um receptor desse evento.

Dessa forma, as duas aplicações trocam dados de forma prática e eficiente.

O termo webhook foi criado em 2007 pelo desenvolvedor Jeff Lindsay para definir o que chamamos de retorno de chamada web (callback) ou HTTP ou, ainda, impulso API. 

Para conectar dois sistemas, o webhook precisa de um endpoint: uma URL que atua como um receptora para atender aos eventos que chegam.

Para você entender melhor, um exemplo de evento seria a mudança de um status de pagamento de pendente para aprovado em um e-commerce.

Quando isso acontece, é o webhook que identifica a mudança no status e promove a comunicação entre as instituições financeiras e a loja virtual.

Nesse caso, é o sistema do e-commerce que atua como receptor e disponibiliza o endpoint (URL) para receber os eventos ocorridos na instituição financeira, que atua como o provedor da informação.

Da mesma forma, o webhook pode fornecer dados para outros aplicativos, e é muito eficiente tanto para o prestador de serviço quanto para o consumidor.

Qual a diferença entre webhook e API?

A principal diferença é que um webhook funciona automaticamente, enquanto a API precisa de uma solicitação para que a integração seja executada.

No caso de uma API, a conexão para enviar ou receber dados é aberta depois dessa solicitação.

Então, a ação é concluída e a conexão é fechada.

Para usar uma API, é preciso ter conhecimento em programação – ou contar com pelo menos um programador na equipe.

Já o webhook notifica o usuário sobre processos que ele deseja saber e seu uso não depende de um procedimento: basta configurar os parâmetros em uma URL, como vamos mostrar no próximo tópico, e as notificações serão enviadas quando determinada ação for tomada.

Exemplos de aplicações do webhook

Um exemplo que ajuda a entender a aplicação do webhook é a compra online com cartão de crédito, que funciona da seguinte forma:

• Um cliente faz uma compra em um e-commerce e escolhe pagar com cartão de crédito
• Assim que o pagamento é realizado, o site utiliza uma API (Application Programming Interface, ou Interface de Programação de Aplicação) para fazer a conexão com a instituição de pagamento e a bandeira responsável pela autorização da transação
• Se houver limite de crédito suficiente e os dados estiverem corretos, a transação é autorizada e o cliente vê a tela de finalização do pedido
• Mesmo com a finalização da transação no site, ainda é preciso que a confirmação da instituição financeira chegue até o sistema e confirme o pagamento para o cliente
• É aí que um webhook entra em ação. Assim que o pagamento é aprovado, ele devolve essa informação para o sistema da loja virtual, que por sua vez envia a notificação de pagamento recebido para o cliente.

Da mesma maneira, os webhooks são usados em outros processos, tais como:

• Notificações push: envio de notificações em tempo real na web
• Pipes (comunicações entre processo): integração entre aplicações por meio do processamento dos dados enviados pelo webhook
• Plugins: desenvolvimento de plugins (recursos adicionais em softwares) para adicionar funcionalidades em aplicações web.

Como funciona o webhook?

A maioria dos webhooks posta dados para você a partir de arquivos como JSON (tipicamente), XML ou pelos dados de formulário (application / x-www-form-urlencoded ou multipart/form-data, por exemplo).

Dessa forma, o seu provedor lhe dirá como isso será entregue ou dará uma escolha de seleção.

Ambos são fáceis de interpretar, e a maioria dos frameworks web vai fazer o trabalho para você.

No entanto, se não o fizerem, você pode precisar recorrer a outros tipos de funções e ajuda.

Já explicamos aqui no blog como funciona a nossa aplicação. 

Para entender o que os webhooks fornecem, podemos usar uma ferramenta, como RequestBin, para recolher os pedidos da webhook.

Para isso, é necessário:

• Testar o código em sua máquina usando uma ferramenta como o Ngrok
• Assistir todo o fluxo do webhooks, usando uma ferramenta como o Runscope.

Qual é a importância dos webhooks?

Imagine que você tem uma loja virtual e quer crescer dentro do segmento e-commerce.

Para que isso aconteça, você sabe que precisa otimizar o máximo de tarefas possível, preferencialmente e com um orçamento enxuto.

Um webhook funciona, por exemplo, para te dar informações do extrato das suas vendas em tempo real, sem que você precise ficar pesquisando por períodos.

Basta acessar e pronto! 

As atualizações são feitas a todo momento, e você ganha muito mais agilidade para fazer qualquer tipo de consulta.

Quando usar um webhook?

Agora que você já conhece o funcionamento do webhook, veja alguns exemplos de situações em que é possível usar esse sistema.

Se não há padrão de mudança nos dados

Há situações em que você precisa de uma informação encaminhada de um ambiente externo, mas não é possível estimar quando esse dado estará disponível.

Nesses casos, uma API demandaria uma série de requisições, enquanto para usar o webhook, seria preciso apenas uma conexão – o que torna essa uma alternativa mais eficiente.

Em atualizações rápidas

Pequenas notificações recebidas na hora são ideais para se usar um webhook – principalmente para empresas que aceitam pagamento por cartão de crédito, que podem notificar o cliente sobre a transação.

Se API não for uma opção

O desenvolvimento de um webhook pode permitir a troca de dados em sistemas que não oferecem uma API, ou que ela não atenda às necessidades da aplicação.

Como criar e implementar um webhook?

Para criar e implementar um webhook, você deve ter os seguintes pontos em mente:

• A prioridade do webhook deve ser a segurança na troca de informações e a transferência eficiente dos dados, de modo que o sistema fique protegido de ataques cibernéticos e possíveis invasores
• Os dados devem ser confiáveis e precisos, pois, se houver erros nas informações, elas podem se perder ou mesmo chegarem duplicadas ao aplicativo
• É importante entender como o seu webhook provedor lida com as respostas de cada ação, para que você possa se preparar para a possibilidade de erros de aplicação
• Lembre-se de que  os webhooks podem fazer vários pedidos ao mesmo tempo — uma de suas principais vantagens
• Verifique sempre se o seu aplicativo pode manipular a escala esperada de seu webhook.

De modo geral, ao desenvolver um webhook, você deve buscar um serviço adequado à sua necessidade.

Felizmente, muitos serviços usam webhooks – assim, você pode facilmente aprender com eles e conhecer sobre todo o conteúdo referente ao sistema.

Como proteger um webhook?

A maneira mais fácil de fazer (e o que deve ser executado) é forçar conexões TLS (HTTPS).

Depois de implementar isso, você pode seguir com outras ações e garantir ainda mais uma conexão segura.

A primeira, e mais apoiada, maneira de garantir um webhook seguro, é adicionar alguns componentes à URL, de modo que a identificação da mesma se torne mais complexa, ex: ? auth = TK.

A próxima opção é implementar o Auth Basic – este também é amplamente suportado e muito fácil de fazer.

As duas primeiras soluções servem para evitar a maioria dos ataques, no entanto, existe a necessidade de confirmação do token de autenticação com o pedido.

Webhook em negócios recorrentes

Os webhooks são tecnologias essenciais para otimizar processos e comunicar aplicações nos negócios recorrentes.

Veja alguns exemplos de uso desse recurso:

• Gerenciamento de planos e assinaturas
• Notificações de pagamentos recorrentes
• Atualização de status de pagamentos de planos, assinaturas e mensalidades
• Integração com sistemas de contabilidade em tempo real
• Ativação e desativação de recursos de softwares
• Notificações de eventos de usuário (alertar sobre atualização do software, por exemplo)
• Integração com serviços de marketing, gestão e atendimento ao cliente
• Monitoramento de atividades do usuário
• Análise de dados para otimização de processos.

Como configurar os webhooks da Vindi

Para fazer a configuração de webhooks na Vindi, basta seguir os passos abaixo:

• Acesse a plataforma Vindi, vá até “Configurações” no menu à esquerda e clique em “Webhooks”
• Então, clique em “Novo Webhook”
• Com a URL em mãos, acesse webhooks na aba integrações em suas configurações e teste a URL que irá receber as notificações
• Ao testar a URL com sucesso, selecione todos os eventos para os quais você deseja receber notificações.

Todos os eventos que podem ser habilitados na Vindi e mais detalhes estão no nosso tutorial.

Esperamos que este artigo tenha ajudado você a compreender melhor os webhooks e utilizar essa tecnologia no seu negócio recorrente.

Quer saber mais sobre APIs, webhooks e tudo sobre tecnologia e tendências de pagamentos e e-commerce?

Assine a newsletter grátis.