Documentação de Webhooks

Receba notificações em tempo real para conversões, pagamentos e eventos de campanhas. Integre webhooks BankRolls para construir aplicações de afiliados responsivas e automatizar seu fluxo de trabalho.

Coming Soon

Documentação de Webhooks em Desenvolvimento

Nosso sistema de webhooks está sendo aprimorado com recursos avançados e documentação abrangente. Estamos construindo a infraestrutura de webhooks mais confiável e segura para notificações de afiliados.

Lançamento Esperado: Q2 2024 | Recursos: Eventos em tempo real, lógica de tentativas, verificação de assinatura | Status: Testes Beta

O que são Webhooks?

Webhooks são callbacks HTTP que BankRolls envia para sua aplicação quando eventos específicos ocorrem. Em vez de fazer polling na nossa API por mudanças, webhooks enviam notificações em tempo real diretamente para seu servidor, permitindo que você:

Obtenha notificações instantâneas de conversão

Receba confirmações de pagamento

Rastreie mudanças de status de campanha

Automatize fluxos de trabalho de afiliados

Construa painéis em tempo real

Sincronize dados com sistemas externos

Recursos Principais

Entrega em Tempo Real

Eventos entregues em milissegundos após ocorrerem

Verificação Segura

Verificação de assinatura HMAC para solicitações autênticas

Tentativas Automáticas

Lógica inteligente de tentativas com backoff exponencial

Eventos Configuráveis

Escolha quais eventos receber para seu caso de uso

Eventos de Webhook Disponíveis

Aqui estão os eventos de webhook que estarão disponíveis em nosso sistema abrangente:

conversion.createdAlto Volume

Tempo real

Acionado quando uma nova conversão de jogador é rastreada

payment.processedCrítico

Mensal

Enviado quando o pagamento de afiliado foi processado com sucesso

campaign.activatedCampanha

Conforme necessário

Notificação quando nova campanha entra no ar

deal.updatedAcordos

Conforme necessário

Enviado quando os termos do acordo do cassino são modificados

account.suspendedConta

Conforme necessário

Notificação importante quando o status da conta muda

bonus.expiredBônus

Diário

Notificação quando os termos de bônus do jogador expiram

Exemplo de Payload de Webhook

Evento conversion.created

{
  "event": "conversion.created",
  "timestamp": "2024-03-15T10:30:00Z",
  "data": {
    "conversion_id": "conv_abc123",
    "affiliate_id": "aff_xyz789",
    "campaign_id": "camp_def456",
    "casino": {
      "id": "casino_123",
      "name": "Premium Casino",
      "brand": "premium-casino"
    },
    "player": {
      "id": "player_789",
      "registration_date": "2024-03-15T10:29:45Z",
      "country": "BR",
      "currency": "BRL"
    },
    "commission": {
      "amount": 125.50,
      "currency": "BRL",
      "rate": 0.35,
      "type": "revenue_share"
    },
    "tracking": {
      "click_id": "click_ghi012",
      "source": "google",
      "medium": "cpc",
      "campaign": "promo_verao"
    }
  }
}

Segurança e Melhores Práticas

Verificação de Assinatura

Cada solicitação de webhook inclui uma assinatura HMAC SHA-256 no cabeçalho X-BankRolls-Signature. Sempre verifique esta assinatura para garantir que a solicitação é autêntica.

Verificar assinatura HMAC
Usar segredos de webhook seguros
Validar frescor do timestamp

Tratamento de Falhas

Projete seus endpoints de webhook para tratar falhas graciosamente. Tentaremos automaticamente novamente entregas falhadas com backoff exponencial.

Retornar HTTP 200 para sucesso
Implementar idempotência
Tratar eventos duplicados

Pronto para Integrar Webhooks?

Junte-se ao nosso programa beta para obter acesso antecipado ao nosso sistema de webhooks. Ajude-nos a construir o sistema de notificações de afiliados mais confiável da indústria.

Perguntas Frequentes

O que acontece se meu endpoint de webhook estiver fora do ar?

Tentaremos automaticamente novamente as entregas de webhook usando backoff exponencial por até 72 horas. Você também pode reproduzir manualmente eventos perdidos através do seu painel.

Posso testar webhooks antes de colocar no ar?

Sim! Nosso ambiente sandbox permite testar todos os eventos de webhook com dados de exemplo antes de processar tráfego de afiliados ao vivo.

Como lidar com tráfego de webhook de alto volume?

Recomendamos usar um sistema de fila de mensagens para processar webhooks de forma assíncrona. Nossa documentação incluirá padrões de arquitetura para cenários de alto volume.

Seja notificado quando a documentação de webhooks estiver pronta

Seja um dos primeiros a acessar nosso sistema abrangente de webhooks e documentação.