Conector Iterable

Conecte sua plataforma de growth marketing Iterable ao Brevo para engajamento de cliente unificado, coordenação de campanhas multicanal e analytics consolidados entre ferramentas de marketing.

Visão geral

PropriedadeValor
PlataformaIterable
CategoriaMarketing
Complexidade de configuraçãoModerada
Integração oficialNão
Dados sincronizadosUsuários, Eventos, Campanhas, Catálogos
Tipo de APIREST API
AutenticaçãoChave API
URL basehttps://api.iterable.com/api/

Recursos

  • Sincronização de perfis de usuário - Sincronização bidirecional de dados de usuário com contatos do Brevo
  • Analytics de campanha - Sincronize métricas de envio, abertura e clique de campanhas para relatórios unificados
  • Dados de experimentos - Rastreie resultados de testes A/B e variantes vencedoras
  • Sincronização de catálogo - Sincronize catálogos de produtos e conteúdo entre plataformas
  • Eventos de workflow - Encaminhe eventos de gatilho e conclusão de workflow para o Brevo
  • Sincronização de preferências de canal - Replique preferências de comunicação do usuário no Brevo

Pré-requisitos

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

  1. Uma conta Iterable com acesso à API
  2. Uma chave API do Iterable com as permissões apropriadas
  3. Seu ID de projeto do Iterable
  4. Uma conta Brevo com acesso à API
  5. Uma conta Tajo com assinatura ativa

Autenticação

O Iterable usa autenticação por chave API passada no cabeçalho da requisição.

Criar uma chave API

  1. Faça login no seu dashboard Iterable
  2. Navegue até Integrations > API Keys
  3. Clique em New API Key
  4. Nomeie-a como “Tajo Integration”
  5. Selecione o tipo de chave Server-side
  6. Conceda as seguintes permissões:
Users: Read/Write
Events: Read/Write
Campaigns: Read
Lists: Read/Write
Catalogs: Read
Experiments: Read
Workflows: Read
Templates: Read
Channels: Read
Message Types: Read

O tipo da chave importa

Sempre use uma chave API Server-side para a integração Tajo. Chaves Mobile e JavaScript têm permissões restritas e não podem acessar todos os endpoints necessários.

Conectando ao Tajo

Terminal window
tajo connectors install iterable \
--api-key $ITERABLE_API_KEY

Configuração

Configuração básica

connectors:
iterable:
enabled: true
sync:
users: true
events: true
campaigns: true
catalogs: true
experiments: true
lists:
all_users: 16
engaged_users: 17
inactive_users: 18

Mapeamento de campos

Mapeie campos de usuário do Iterable para atributos de contato do Brevo:

field_mapping:
# Standard fields
userId: ITERABLE_ID
email: email
firstName: FIRSTNAME
lastName: LASTNAME
phoneNumber: SMS
# Engagement data
signupDate: SIGNUP_DATE
totalPurchases: TOTAL_PURCHASES
lastPurchaseDate: LAST_PURCHASE
# Custom fields
plan_name: PLAN_NAME
company_size: COMPANY_SIZE
preferred_channel: PREFERRED_CHANNEL
lifecycle_stage: LIFECYCLE_STAGE

Configuração de eventos

event_mapping:
# Iterable event -> Brevo event
purchase: ORDER_PLACED
addToCart: CART_UPDATED
pageView: PAGE_VIEWED
appOpen: APP_OPENED
pushOpen: PUSH_ENGAGED

Endpoints da API

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

EndpointMétodoFinalidade
/users/updatePOSTAtualizar perfis de usuário
/users/{email}GETRecuperar usuário por e-mail
/users/bulkUpdatePOSTAtualização em lote de usuários
/events/trackPOSTRastrear eventos personalizados
/events/trackBulkPOSTRastrear eventos em lote
/campaignsGETListar todas as campanhas
/campaigns/metricsGETDados de desempenho de campanha
/experiments/metricsGETResultados de experimentos
/listsGETListar todas as listas de usuários
/lists/subscribePOSTAdicionar usuários a uma lista
/lists/unsubscribePOSTRemover usuários de uma lista
/catalogs/{catalogName}/itemsGETRecuperar itens de catálogo
/channelsGETListar canais de mensageria
/export/data.jsonGETExportar dados brutos de eventos

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('iterable', {
apiKey: process.env.ITERABLE_API_KEY
});

Sincronizar usuários

// Incremental user sync from Iterable to Brevo
await tajo.connectors.sync('iterable', {
type: 'incremental',
resources: ['users'],
since: '2024-01-01',
batchSize: 50
});
const status = await tajo.connectors.status('iterable');
console.log(status);
// {
// connected: true,
// lastSync: '2024-03-15T09:45:00Z',
// usersCount: 58700,
// campaignsTracked: 42,
// eventsProcessed: 210000
// }

Rastrear eventos

// Forward Iterable events to Brevo
await tajo.connectors.handleEvent('iterable', {
type: 'custom_event',
payload: {
eventName: 'subscription_upgraded',
dataFields: {
previousPlan: 'starter',
newPlan: 'pro',
mrr: 99.00
}
}
});

Handler de webhook

// Handle Iterable system webhooks
app.post('/webhooks/iterable', async (req, res) => {
const event = req.body;
await tajo.connectors.handleWebhook('iterable', {
type: event.eventName,
payload: event
});
res.status(200).send('OK');
});

Limites de taxa

O Iterable aplica limites de taxa baseados no seu plano:

PlanoLimite de taxaLimite de endpoint em lote
Growth500 requisições/segundo500 requisições/segundo
EnterprisePersonalizadoPersonalizado

Limites específicos de endpoint:

EndpointLimite
/users/update500 req/s
/users/bulkUpdate500 req/s (1.000 usuários por requisição)
/events/track500 req/s
/events/trackBulk500 req/s (8.000 eventos por requisição)
/export/data.json4 requisições concorrentes

Endpoints em lote

O Tajo agrupa automaticamente atualizações de usuário em lote (até 1.000 por chamada) e rastreamentos de evento (até 8.000 por chamada) para maximizar a taxa de transferência dentro dos limites.

Solução de problemas

Problemas comuns

ProblemaCausaSolução
401 UnauthorizedChave API inválidaVerifique a chave em Iterable > Integrations > API Keys
Usuários não sincronizandoTipo de chave incorretoCertifique-se de usar uma chave API Server-side
Dados de campanha ausentesPermissões insuficientesAdicione a permissão Campaigns Read à chave API
Timeout de exportaçãoGrande volume de dadosUse filtros de intervalo de data para reduzir o tamanho da exportação
Usuários duplicadosIdentificadores inconsistentesUse e-mail como identificador primário de forma consistente

Modo de depuração

connectors:
iterable:
debug: true
log_level: verbose
log_api_calls: true

Testar conexão

Terminal window
tajo connectors test iterable
# ✓ API connection successful
# ✓ User data accessible
# ✓ Campaign list readable
# ✓ Event tracking operational
# ✓ List management available

Melhores práticas

  1. Use endpoints em lote - Prefira sempre bulkUpdate e trackBulk para grandes volumes de dados
  2. Deduplique por e-mail - Use o e-mail como identificador consistente entre Iterable e Brevo
  3. Sincronize incrementalmente - Use intervalos de data para evitar reprocessar dados históricos
  4. Mapeie preferências de canal - Sincronize status de opt-in/opt-out para manter a conformidade
  5. Monitore jobs de exportação - Grandes exportações podem levar tempo; configure polling de status
  6. Teste com projeto não produtivo - Valide mapeamentos antes de sincronizar dados de produção

Segurança

  • Autenticação por chave API - Chaves server-side com permissões granulares
  • Somente HTTPS - Toda comunicação com a API é criptografada via TLS 1.2+
  • Rotação de chaves - Suporte a múltiplas chaves API ativas durante rotação
  • Armazenamento criptografado - Credenciais API criptografadas em repouso no Tajo
  • Webhooks JWT - Payloads de webhook assinados com JWT para verificação

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.