Conector Braze

Conecte sua plataforma de engajamento Braze ao Brevo para perfis de cliente unificados, orquestração de campanhas multicanal e analytics de marketing consolidados.

Visão geral

PropriedadeValor
PlataformaBraze
CategoriaMarketing
Complexidade de configuraçãoModerada
Integração oficialNão
Dados sincronizadosClientes, Eventos, Campanhas, Mensagens
Tipo de APIREST API
AutenticaçãoChave API
URL basehttps://rest.iad-XX.braze.com (específica da instância)

Recursos

  • Sincronização de perfis de usuário - Sincronização bidirecional de atributos de cliente entre Braze e Brevo
  • Rastreamento de eventos de campanha - Rastreie aberturas, cliques, conversões e descadastros de e-mails
  • Dados de fluxo Canvas - Sincronize dados de jornada de campanha em múltiplas etapas para relatórios unificados
  • Espelhamento de segmentos - Replique segmentos do Braze como listas do Brevo para targeting multiplataforma
  • Eventos de push notification - Encaminhe dados de engajamento de push para as timelines de contato do Brevo
  • Sincronização de catálogo - Sincronize catálogos de produtos para recomendações personalizadas

Pré-requisitos

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

  1. Uma conta Braze com acesso à API habilitado
  2. Uma chave REST API do Braze com as permissões apropriadas
  3. A URL da sua instância Braze (por exemplo, rest.iad-01.braze.com)
  4. Uma conta Brevo com acesso à API
  5. Uma conta Tajo com assinatura ativa

Autenticação

O Braze usa autenticação por chave API. Cada chave API pode ter escopo para endpoints específicos.

Criar uma chave API

  1. Faça login no seu dashboard Braze
  2. Navegue até Settings > API Keys
  3. Clique em Create New API Key
  4. Nomeie-a como “Tajo Integration”
  5. Habilite as seguintes permissões:
users.track
users.export.ids
users.export.segment
campaigns.list
campaigns.data_series
canvas.list
canvas.data_series
segments.list
segments.data_series
email.status
subscription.status.set
catalogs.list_items

Segurança da chave API

Armazene sua chave API do Braze com segurança. Nunca exponha em código client-side ou repositórios públicos. O Tajo criptografa todas as credenciais API em repouso usando AES-256.

Conectando ao Tajo

Terminal window
tajo connectors install braze \
--api-key $BRAZE_API_KEY \
--instance-url rest.iad-01.braze.com

Configuração

Configuração básica

connectors:
braze:
enabled: true
instance_url: "rest.iad-01.braze.com"
api_version: "v1"
sync:
users: true
campaigns: true
canvases: true
segments: true
events: true
lists:
engaged_users: 10
dormant_users: 11

Mapeamento de campos

Mapeie atributos de usuário do Braze para atributos de contato do Brevo:

field_mapping:
# Standard fields
external_id: BRAZE_ID
email: email
first_name: FIRSTNAME
last_name: LASTNAME
phone: SMS
# Engagement metrics
total_revenue: TOTAL_REVENUE
push_opted_in: PUSH_OPTIN
email_subscribe: EMAIL_STATUS
# Custom attributes
loyalty_points: LOYALTY_POINTS
last_app_version: APP_VERSION
preferred_language: LANGUAGE

Endpoints da API

O Tajo integra-se com os seguintes endpoints da REST API do Braze:

EndpointMétodoFinalidade
/users/trackPOSTEnviar atributos, eventos e compras de usuário
/users/export/idsPOSTExportar perfis de usuário por IDs externos
/users/export/segmentPOSTExportar usuários de um segmento
/campaigns/listGETRecuperar lista de campanhas
/campaigns/data_seriesGETAnalytics de campanha ao longo do tempo
/canvas/listGETRecuperar lista de fluxos Canvas
/canvas/data_seriesGETAnalytics de Canvas ao longo do tempo
/segments/listGETRecuperar lista de segmentos
/email/statusPOSTAlterar status de inscrição de e-mail
/subscription/status/setPOSTDefinir status de grupo de inscrição
/catalogs/{catalog_name}/itemsGETRecuperar itens do catálogo

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
});
await tajo.connectors.connect('braze', {
apiKey: process.env.BRAZE_API_KEY,
instanceUrl: 'rest.iad-01.braze.com'
});

Sincronizar perfis de usuário

// Sync Braze users to Brevo contacts
await tajo.connectors.sync('braze', {
type: 'incremental',
resources: ['users'],
since: '2024-01-01',
batchSize: 50
});
// Check sync status
const status = await tajo.connectors.status('braze');
console.log(status);
// {
// connected: true,
// lastSync: '2024-03-15T10:30:00Z',
// usersCount: 45200,
// campaignsTracked: 28,
// eventsProcessed: 125000
// }

Rastrear eventos personalizados

// Forward Braze events to Brevo
await tajo.connectors.handleEvent('braze', {
type: 'user.event',
payload: {
external_id: 'user_12345',
name: 'product_viewed',
properties: {
product_id: 'SKU-789',
category: 'electronics',
price: 299.99
}
}
});

Exportar dados de segmento

// Export a Braze segment and create a Brevo list
const result = await tajo.connectors.exportSegment('braze', {
segmentId: 'segment_abc123',
targetList: 15,
includeAttributes: ['email', 'first_name', 'last_name', 'total_revenue']
});
console.log(`Exported ${result.count} users to Brevo list 15`);

Limites de taxa

O Braze aplica limites de taxa baseados no seu plano e instância:

PlanoLimite de taxaLimite de burst
Starter250.000 requisições/horaN/A
Pro250.000 requisições/horaN/A
EnterprisePersonalizadoPersonalizado

O endpoint /users/track tem um limite padrão de 50.000 requisições por minuto. O Tajo trata automaticamente o rate limiting com backoff exponencial.

Requisições em lote

O Tajo agrupa em lote até 75 atributos de usuário, 75 eventos e 75 compras por requisição /users/track para maximizar a taxa de transferência dentro dos limites.

Solução de problemas

Problemas comuns

ProblemaCausaSolução
401 UnauthorizedChave API inválida ou expiradaRegere a chave API no dashboard do Braze
Usuários não sincronizandoURL de instância incorretaVerifique a URL da sua instância Braze (por exemplo, iad-01, iad-02)
Atributos ausentesEscopo da chave API muito restritoAdicione as permissões necessárias à chave API
Limite de taxa excedidoMuitas requisições concorrentesReduza o tamanho do lote ou a frequência de sincronização
Eventos atrasadosFila de exportação grandeUse sincronização incremental em vez de exportação completa

Modo de depuração

connectors:
braze:
debug: true
log_level: verbose
log_api_calls: true

Testar conexão

Terminal window
tajo connectors test braze
# ✓ API connection successful
# ✓ User export accessible
# ✓ Campaign data readable
# ✓ Segment list accessible
# ✓ Event tracking operational

Melhores práticas

  1. Use sincronizações incrementais - Evite exportações completas; sincronize apenas registros alterados desde a última sincronização
  2. Agrupe atualizações de usuário em lote - Agrupe alterações de atributo para minimizar chamadas de API
  3. Restrinja o escopo das chaves API - Habilite apenas as permissões que sua integração precisa
  4. Monitore limites de taxa - Configure alertas antes de atingir os limites de taxa do Braze
  5. Mapeie IDs externos de forma consistente - Use o mesmo identificador entre Braze e Brevo
  6. Teste primeiro em sandbox - Use um workspace de teste do Braze antes do deploy em produção

Segurança

  • Autenticação por chave API - Chaves API com escopo e permissões granulares
  • Somente HTTPS - Toda comunicação com a API é criptografada via TLS 1.2+
  • Allowlisting de IP - Restrição opcional de IP para acesso à API no Braze
  • Armazenamento criptografado - Credenciais API criptografadas em repouso no Tajo
  • Log de auditoria - Todas as chamadas de API registradas para revisão de conformidade

Recursos relacionados

Subscribe to updates

developer-docs

Drop your email or phone number — we'll send you what matters next.

auto-detect
Assistente AI

Olá! Pergunte-me qualquer coisa sobre a documentação.