Conector Brevo

Conector Brevo

Conecte sua conta Brevo ao Tajo para gestão unificada de contatos, mensageria transacional em e-mail, SMS e WhatsApp, e automação de marketing abrangente.

Visão geral

Recursos

• Mensageria multicanal - Envie e-mail transacional, SMS e WhatsApp a partir de uma API unificada
• Gestão de contatos - Crie, atualize e segmente contatos com atributos personalizados
• Campanhas de marketing - Crie e envie campanhas de e-mail programaticamente
• Rastreamento de eventos - Rastreie eventos personalizados e atividade no site via o Brevo Tracker
• Sincronização de e-commerce - Sincronize produtos, pedidos e dados de carrinho para campanhas personalizadas
• Programas de fidelidade - Gerencie assinaturas de fidelidade, pontos e dados de membros
• Suporte a webhooks - Notificações de evento em tempo real para eventos transacionais, de marketing e de CRM
• Conversations - Integração de widget de chat ao vivo e gestão programática de mensagens

Pré-requisitos

Antes de começar, certifique-se de ter:

1. Uma conta Brevo (plano Free, Starter, Business ou Enterprise)
2. Uma chave API gerada em Brevo Settings > API Keys
3. Uma conta Tajo com acesso à API
4. Domínio de remetente verificado para envio de e-mails

Autenticação

O Brevo suporta dois métodos de autenticação:

Autenticação por chave API (Recomendado)

Inclua sua chave API no cabeçalho api-key em cada requisição. Melhor para integrações diretas e comunicação servidor-a-servidor.

curl -X GET "https://api.brevo.com/v3/account" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Autenticação OAuth 2.0

Use OAuth 2.0 para integrações privadas dentro de uma organização que exigem acesso delegado e permissões específicas por usuário. O OAuth fornece um sistema baseado em token com períodos de validade definidos.

Configuração

Configuração básica

connectors:
  brevo:
    enabled: true
    api_key: "${BREVO_API_KEY}"
    api_version: "v3"

    # Data sync options
    sync:
      contacts: true
      campaigns: true
      transactional: true
      events: true
      ecommerce: true

    # List assignment
    lists:
      all_customers: 5
      newsletter: 6
      buyers: 7

Mapeamento de campos

Mapeie seus campos de dados para atributos de contato do Brevo:

Mapeamento de atributos personalizados

field_mapping:
  # Standard fields
  email: email
  first_name: FIRSTNAME
  last_name: LASTNAME
  phone: SMS

  # Marketing fields
  opt_in: OPT_IN
  signup_source: SIGNUP_SOURCE
  preferred_language: LANGUAGE

  # eCommerce metrics
  orders_count: ORDER_COUNT
  total_spent: TOTAL_REVENUE
  last_order_date: LAST_ORDER_DATE

  # Loyalty fields
  loyalty_tier: VIP_TIER
  loyalty_points: LOYALTY_POINTS

Endpoints da API

Endpoints principais

Endpoints de e-commerce

Endpoints de campanha

Eventos

Eventos transacionais

Eventos de e-commerce

Exemplos de código

Inicializar o conector

import { TajoClient } from '@tajo/sdk';

const tajo = new TajoClient({
  apiKey: process.env.TAJO_API_KEY,
  brevoApiKey: process.env.BREVO_API_KEY
});

// Connect Brevo account
await tajo.connectors.connect('brevo', {
  apiKey: process.env.BREVO_API_KEY
});

Enviar e-mail transacional

// Send a transactional email via Brevo
await tajo.brevo.sendTransactionalEmail({
  to: [{ email: '[email protected]', name: 'John Doe' }],
  templateId: 12,
  params: {
    ORDER_ID: '12345',
    ORDER_TOTAL: '$59.99',
    DELIVERY_DATE: '2024-02-15'
  }
});

Sincronizar contatos

// Bulk import contacts to Brevo
await tajo.connectors.sync('brevo', {
  type: 'full',
  resources: ['contacts'],
  options: {
    listIds: [5, 6],
    updateExisting: true,
    emptyContactsAttributes: false
  }
});

// Check sync status
const status = await tajo.connectors.status('brevo');
console.log(status);
// {
//   connected: true,
//   lastSync: '2024-01-15T10:30:00Z',
//   contactsSynced: 25400,
//   campaignsSent: 142,
//   eventsTracked: 89320
// }

Rastrear eventos personalizados

// Track a custom event for a contact
await tajo.brevo.trackEvent({
  email: '[email protected]',
  event: 'product_purchased',
  eventdata: {
    id: 'txn_98765',
    data: {
      product_name: 'Premium Widget',
      price: 49.99,
      currency: 'USD'
    }
  }
});

Limites de taxa

O Brevo aplica limites de taxa em três tiers baseados no seu plano:

Solução de problemas

Problemas comuns

Modo de depuração

Ative o log detalhado:

connectors:
  brevo:
    debug: true
    log_level: verbose
    log_webhooks: true

Testar conexão

tajo connectors test brevo
# ✓ API connection successful
# ✓ Contacts API accessible
# ✓ Transactional email ready
# ✓ SMS sending configured
# ✓ Webhooks registered

Melhores práticas

1. Use rotação de chaves API - Rotacione as chaves API periodicamente por segurança
2. Implemente verificação de webhook - Valide assinaturas de webhook com autenticação usuário/senha
3. Importações de contatos em lote - Use importação em massa para grandes volumes de dados em vez de chamadas individuais
4. Monitore limites de taxa - Verifique os cabeçalhos de limite de taxa para evitar erros 429
5. Use rastreamento de eventos - Implemente o Brevo Tracker para dados abrangentes de comportamento do cliente
6. Configure autenticação adequada de remetente - Configure SPF, DKIM e DMARC para entregabilidade ideal

Segurança

• Autenticação por chave API - Acesso baseado em token secreto via cabeçalho api-key
• OAuth 2.0 - Acesso delegado baseado em token para integrações privadas
• Verificação de webhook - Autenticação usuário/senha para chamadas de webhook seguras
• Criptografia TLS - Toda comunicação com a API é criptografada em trânsito
• IP whitelisting - Restrições opcionais de IP disponíveis em planos Enterprise

Recursos relacionados

• Documentação da API do Brevo
• Guia de autenticação do Brevo
• Limites de taxa do Brevo
• Conector Shopify
• Skill de sincronização de clientes
• API de contatos do Brevo