Коннектор Iterable

Подключите платформу growth-маркетинга Iterable к Brevo для единого вовлечения клиентов, координации кросс-канальных кампаний и консолидированной аналитики по маркетинговым инструментам.

Обзор

Возможности

• Синхронизация профилей пользователей, двунаправленная синхронизация данных пользователей с контактами Brevo
• Аналитика кампаний, синхронизация метрик отправки, открытий и кликов кампаний для единой отчётности
• Данные экспериментов, отслеживание результатов A/B-тестов и выигрышных вариантов
• Синхронизация каталога, синхронизация каталогов товаров и контента между платформами
• События рабочих процессов, пересылка событий триггеров и завершений рабочих процессов в Brevo
• Синхронизация предпочтений каналов, репликация коммуникационных предпочтений пользователей в Brevo

Предварительные требования

Прежде чем начать, убедитесь, что у вас есть:

1. Аккаунт Iterable с доступом к API
2. API-ключ Iterable с необходимыми разрешениями
3. ID вашего проекта Iterable
4. Аккаунт Brevo с доступом к API
5. Аккаунт Tajo с активной подпиской

Аутентификация

Iterable использует аутентификацию по API-ключу, передаваемому в заголовке запроса.

Создание API Key

1. Войдите в дашборд Iterable
2. Перейдите в Integrations > API Keys
3. Нажмите New API Key
4. Назовите его “Tajo Integration”
5. Выберите тип ключа Server-side
6. Предоставьте следующие разрешения:

Users: Read/Write
Events: Read/Write
Campaigns: Read
Lists: Read/Write
Catalogs: Read
Experiments: Read
Workflows: Read
Templates: Read
Channels: Read
Message Types: Read

Подключение к Tajo

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

Конфигурация

Базовая настройка

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

Сопоставление полей

Сопоставьте поля пользователей Iterable с атрибутами контактов Brevo:

field_mapping:
  # Стандартные поля
  userId: ITERABLE_ID
  email: email
  firstName: FIRSTNAME
  lastName: LASTNAME
  phoneNumber: SMS

  # Данные вовлечённости
  signupDate: SIGNUP_DATE
  totalPurchases: TOTAL_PURCHASES
  lastPurchaseDate: LAST_PURCHASE

  # Пользовательские поля
  plan_name: PLAN_NAME
  company_size: COMPANY_SIZE
  preferred_channel: PREFERRED_CHANNEL
  lifecycle_stage: LIFECYCLE_STAGE

Конфигурация событий

event_mapping:
  # Событие Iterable -> Событие Brevo
  purchase: ORDER_PLACED
  addToCart: CART_UPDATED
  pageView: PAGE_VIEWED
  appOpen: APP_OPENED
  pushOpen: PUSH_ENGAGED

Эндпоинты API

Tajo интегрируется со следующими эндпоинтами Iterable API:

Примеры кода

Инициализация коннектора

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
});

Синхронизация пользователей

// Инкрементальная синхронизация пользователей Iterable в 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
// }

Трекинг событий

// Пересылка событий Iterable в Brevo
await tajo.connectors.handleEvent('iterable', {
  type: 'custom_event',
  payload: {
    email: '[email protected]',
    eventName: 'subscription_upgraded',
    dataFields: {
      previousPlan: 'starter',
      newPlan: 'pro',
      mrr: 99.00
    }
  }
});

Обработчик вебхуков

// Обработка системных вебхуков Iterable
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');
});

Ограничения скорости

Iterable устанавливает ограничения скорости в зависимости от плана:

Ограничения для конкретных эндпоинтов:

Устранение неполадок

Частые проблемы

Режим отладки

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

Проверка подключения

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

Лучшие практики

1. Используйте bulk-эндпоинты, всегда предпочитайте bulkUpdate и trackBulk для больших объёмов данных
2. Дедуплицируйте по email, используйте email как согласованный идентификатор в Iterable и Brevo
3. Синхронизируйте инкрементально, используйте диапазоны дат во избежание повторной обработки исторических данных
4. Маппируйте предпочтения каналов, синхронизируйте статусы подписки для соблюдения требований
5. Мониторьте задания экспорта, крупные экспорты могут занимать время; настройте опрос статуса
6. Тестируйте на не-продакшн проекте, проверяйте маппинги перед синхронизацией продакшн-данных

Безопасность

• Аутентификация по API Key, Server-side ключи с гранулярными разрешениями
• Только HTTPS, все API-коммуникации зашифрованы через TLS 1.2+
• Ротация ключей, поддержка нескольких активных API-ключей во время ротации
• Зашифрованное хранение, API-учётные данные зашифрованы при хранении в Tajo
• JWT-подписи вебхуков, полезные нагрузки вебхуков подписаны JWT для верификации

Связанные ресурсы

• Коннектор Braze
• Коннектор Customer.io
• Скилл синхронизации клиентов
• Brevo Contacts API