Подключение системы через API
Коннектор «API» подключает к проекту Октопус CDP систему, для которой нет готового модуля: CRM, ERP, учётную систему, второй сайт на собственной разработке, мобильное приложение. Ваша система передаёт в Октопус клиентов, заказы, товары и события, а забирает из него клиентов, сегменты, достижения целей и аналитику.
Это дополнительный коннектор. Основной - 1С-Битрикс или InSales - подключается при создании проекта, а «API» добавляется к нему как ещё один источник данных. Основным он быть не может.
Данные в Октопус передаёт ваша система, поэтому настройка на её стороне - работа разработчика. Техническое описание для него - в разделе «Передача данных через API».
1. Создайте коннектор
Откройте «Настройки» → «Коннекторы» и создайте коннектор типа «API». В карточке нового коннектора появится API-ключ.
В проекте без сайта (режим «Только рассылки») коннектор «API» не работает. Сначала подключите в том же разделе сайт на 1С-Битрикс или InSales - проект перейдёт в полноценный режим, тариф сменится автоматически. Затем добавьте коннектор «API».
API-ключ выглядит так:
oct-1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
Скопируйте ключ и передайте разработчику.
По ключу можно не только записывать данные, но и читать их, включая контакты клиентов. Передавайте ключ по защищённому каналу и не публикуйте его в открытом виде - в коде страниц сайта, в мобильном приложении, в публичных репозиториях. Ключ должен использоваться только на вашем сервере.
У каждого коннектора проекта свой ключ - разработчику нужен ключ именно того коннектора, который вы для него создали.
2. Какими данными обмениваются системы
Что ваша система передаёт в Октопус
| Что передаётся | Зачем |
|---|---|
| Клиенты | Основа всего: сегменты, рассылки, сценарии |
| Заказы | Выручка, история покупок, сегменты по сумме и давности заказов |
| Разделы каталога и товары | Товарные сегменты, подстановка товаров в письма |
| Визиты страниц | Сегменты по просмотрам, статистика источников |
| Корзина | Сценарии брошенной корзины |
| Цели | Учёт конверсий и ключевых действий |
Передавать всё сразу не обязательно - начните с того, чего не хватает в данных от основного коннектора, остальное можно подключить позже.
Визиты и цели с сайта разработчик может передавать через готовый JS-трекер Октопус - писать отправку с нуля не придётся.
Что ваша система получает от Октопус
| Что можно получить | Зачем |
|---|---|
| Клиенты и сегменты | Сегменты, собранные в Октопус, можно забрать обратно в CRM или учётную систему - например, чтобы менеджеры работали с той же аудиторией, что и рассылки. Сегмент можно выгрузить и файлом xlsx или csv |
| Достижения целей | Заявки, подписки и другие конверсии попадают в вашу систему вместе с данными клиента |
| Аналитика | Выручка, новые и повторные покупатели, эффективность рассылок - для ваших отчётов и BI |
| Результат по каждой записи | Разработчик видит, какие клиенты, заказы и товары приняты, а какие нет и почему |
| Задания на досинхронизацию | Октопус сам просит прислать то, чего ему не хватает: например, товар, на который сослалось торговое предложение |
| Метка клиента в ссылках из рассылок | Когда клиент переходит на сайт из письма, сайт узнаёт его ещё до входа в аккаунт, и визиты попадают в его карточку |
3. Дождитесь первой выгрузки
После того как разработчик настроит передачу, данные начнут поступать в проект. На этом этапе клиенты из нового коннектора ещё не появятся в списках - платформа их приняла, но пока не знает, какое ваше поле что означает.
Это нормально. Переходите к сопоставлению полей.
4. Сопоставьте поля клиентов
Сопоставление - это указание, какое поле из вашей системы соответствует какому полю карточки клиента в Октопус. Например, ваше поле client_email соответствует полю «E-mail».
Откройте коннектор в разделе «Настройки» → «Коннекторы» и перейдите к сопоставлению полей. В левой колонке - поля Октопус, в правой - выпадающий список полей, которые прислала ваша система.
-
Сопоставьте ключевое поле. Это поле, по которому платформа находит повторные карточки одного человека - по умолчанию «E-mail». Без него новые клиенты не создаются.
-
Сопоставьте остальные поля, которые нужны для работы: имя, фамилия, телефон, город, дата рождения.
-
Сохраните. Платформа пересоберёт все ранее принятые данные, и клиенты появятся в разделе «Клиенты».
Требования и особенности:
- сопоставление настраивается отдельно для каждого коннектора;
- список доступных полей строится по последней принятой записи клиента - если нужного поля в списке нет, попросите разработчика передавать полный набор полей в каждой записи, а пустые значения - пустой строкой;
- сопоставление можно менять и позже: после сохранения карточки пересобираются заново;
- правки, сделанные в карточке клиента руками, при пересборке не затираются.
Ключевое поле проекта можно сменить - например, на телефон. Это делается в разделе «Настройки» → «Общие», настройка «Поле уникальности клиента». Решите это до массовой выгрузки базы: смена ключевого поля потом перестраивает объединение дубликатов.
5. Сопоставьте поля товаров
Если передаются товары, для них настраивается отдельное сопоставление - в разделе «Товары». Оно одно на проект: если товары приходят из нескольких коннекторов, настраивать его повторно не нужно.
Обязательное поле здесь одно - название товара. Без него товары не появятся в каталоге. Остальное по необходимости: цена, старая цена, ссылка на страницу товара, картинки, остаток, единица измерения.
Кроме готовых полей можно создать свои характеристики - цвет, размер, бренд - и сопоставить с ними поля из вашей системы. Такие характеристики затем используются в товарных сегментах.
6. Проверьте подключение
В карточке коннектора нажмите «Проверить». Проверка успешна, если через этот коннектор уже поступали данные.
Если проверка не проходит:
- убедитесь, что разработчик использует ключ именно этого коннектора;
- уточните, отправлялись ли данные вообще и какой ответ на них приходил.
После успешной проверки откройте раздел «Клиенты» - там должны быть карточки с заполненными полями. Это значит, что подключение работает.
Чем коннектор «API» отличается от основного
| Возможность | Основной коннектор: 1С-Битрикс или InSales | Коннектор «API» |
|---|---|---|
| Передача клиентов, заказов, товаров | Автоматически после установки модуля | Настраивает разработчик |
| Визиты и цели с сайта | Собирает модуль | Готовый JS-трекер и приёмник на вашем сервере, который ставит разработчик |
| Корзина | Автоматически | Настраивает разработчик |
| Узнавание клиента по ссылке из письма | Автоматически | Настраивает разработчик |
Остались вопросы?
Техническое описание для разработчика - в разделе «Передача данных через API». Если что-то не получается, напишите в поддержку и приложите название проекта и коннектора.