Webhooks são uma poderosa ferramenta para a automação de tarefas e integração entre sistemas. Este guia mostra como configurar e usar webhooks com Basic Auth e autenticação OAuth 2.0.

O que são Webhooks?

Webhooks são notificações enviadas automaticamente por uma aplicação para uma URL definida, sempre que um evento específico ocorre. Por exemplo, em uma loja virtual, um webhook pode ser usado para notificar um sistema externo sempre que um pedido for concluído.

Tipos de Autenticação

Para garantir a segurança das comunicações, é importante configurar a autenticação. Dois tipos principais estão disponíveis:

1. Basic Auth

• O que é? Basic Auth utiliza um par de credenciais (usuário e senha) para autenticar solicitações. É uma solução simples e eficaz para ambientes controlados.

• Configuração na Plataforma

  1. Acesse o painel administrativo da sua loja.

  2. Vá para Configurações > API > Webhooks > Configurações Avançadas.

  3. Ative a opção Basic Auth.

  4. Insira o nome de usuário e a senha fornecidos pelo sistema receptor do webhook.

  5. Salve as configurações.

• Como Funciona? Quando o webhook for disparado, o nome de usuário e a senha serão incluídos no cabeçalho da solicitação.

2. Autenticação com OAuth 2.0

• O que é? OAuth 2.0 é um padrão de autorização que utiliza tokens para acessar recursos protegidos, garantindo maior segurança.

• Configuração na Plataforma

  1. Acesse o painel administrativo.

  2. Navegue até Configurações > API > Webhooks > Configurações Avançadas.

  3. Ative a opção OAuth 2.0.

  4. Preencha os seguintes campos:

     • Client ID: Identificador único da aplicação cliente.

     • Client Secret: Senha associada ao Client ID.

     • Authorization URL: URL do servidor de autorização.

  5. Salve as configurações.

• Fluxo de Autenticação

  1. A plataforma solicita um token ao servidor de autorização usando as credenciais fornecidas.

  2. O token obtido é incluído no cabeçalho das solicitações do webhook.

  3. O sistema receptor valida o token antes de processar a solicitação.

• Exemplo de Solicitação com Token

  curl --request POST \
  --url 'https://seuservidor.com/oauth/token' \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data grant_type=client_credentials \
  --data client_id=<SEU_CLIENT_ID> \
  --data client_secret=<SEU_CLIENT_SECRET>

  Após obter o token:

  curl --request GET \
  --url 'https://seuservidor.com/api' \
  --header 'Authorization: Bearer <SEU_TOKEN>'

Caso sua equipe técnica tenha dúvidas de como utilizá-la, entrem em contato via Central de Ajuda Flexy.