Операции v3: основные сведения
Операции отвечают за обмен данными в реальном времени между вашим бизнесом и Mindbox.
Особенности операций v3
- Конструктор вызова.
- Автоматическое создание документации.
- История ошибочных вызовов.
- Контроль статуса интеграции.
- Уведомления об ошибочных вызовах и прекращении вызовов.
Основные функции операций
1. Работа с базой клиентов:
- Добавление в базу (регистрация, импорт, подписка).
- Получение информации — персональные данные, идентификаторы, подписки, бонусный баланс, принадлежность к сегменту и т.п.
- Редактирование.
- Передача информации о действиях — просмотры страниц на сайте, добавление в корзину, оформление заказа и т.д.
2. Создание и обновление заказа.
3. Запрос данных для персонализации сайта.
4. Экспорт и импорт данных для синхронизации между системой клиента Mindbox.
Создание Операции v3
1. Перейдите в раздел Кампании → Список кампаний:
2. Нажмите на «Создать кампанию» → «Операция»:
3. Выберите папку и нажмите «Создать»:
4. Выберите настройки:
-
Точка интеграции — сайт, лендинг, касса, мобильное приложение. Можно выбрать несколько точек, но у них должны быть одинаковые настройки.
-
Флаг «Операция требует передачи deviceUUID» — если установлен флаг, то в вызове обязательна передача идентификатора устройства (deviceUUID).
-
Флаг «Операция требует передачи секретного сервисного ключа» — при вызове операции с секретным ключом нет ограничений на получение и редактирование информации. Операцию нельзя будет вызвать через js-трекер.
-
Флаг «Операция возвращает валидационные ошибки» — подробная информация об ошибках, которые возникли при обработке данных. На своей стороне вы можете обработать ошибку и показать клиенту сообщение. Например, что он пытается зарегистрироваться с некорректным email-адресом.
-
Флаг «Приоритетная операция» — вызовы выполняются раньше других, автоматически фиксируются задержки. Есть лимиты на количество приоритетных вызовов в рамках проекта, поэтому рекомендуем использовать настройку в случаях, где быстрая скорость реакции критична, например, авторизация или регистрация на кассе, начисление баллов.
Приоритетность операции — обязательное условие для работы транзакционных сценариев.
5. Выбираем шаги операции:
В шагах выбирается та работа, которую будет выполнять операция. Например, зарегистрировать клиента, оформить заказ и отправить транзакционное письмо. Подробнее о выборе шагов читайте в отдельной статье.
6. Нажимаем «Добавить»:
7. Нажимаем «Посмотреть описание»:
На странице можно найти описание вызова, форматы для передачи данных, какие данные можно передавать с помощью этой операции — тело запроса, описание полей, пример вызова и ответа.
Спецификация формируется исходя из выбранных шагов и настроек проекта:
Синхронные и асинхронные вызовы операций
В зависимости от настроек операцию можно вызвать синхронно и асинхронно. В описании операции показаны доступные варианты вызова.
- Асинхронный вызов — Mindbox обрабатывает данные в порядке очереди. В ответе сообщение о том, что вызов успешно поставлен в очередь.
Асинхронные вызовы подходят для операций, которые часто вызываются и нет необходимости ждать результата выполнения каждой операции. Например, просмотры страниц товаров/категорий, добавление товара в корзину или wish-list. Для анализа ошибок используйте лог выполнения операций.
- Синхронный вызов — Mindbox выполнит операцию в реальном времени. В ответе вернутся результаты выполнения операции. Используйте, если в ответе нужно получить данные от Mindbox или результат выполнения операции. Ошибки можно посмотреть в теле ответа или логе выполнения операций.
Когда операцию можно вызвать только синхронно?
-
При использовании шага «Клиент — Получить данные по текущему клиенту».
-
Когда включен флаг «Операция возвращает валидационные ошибки».
-
Когда в настройках установлен флаг «Добавить в ответ операции данные»:
Что такое DeviceUUID и зачем его передавать
DeviceUUID — уникальный идентификатор устройства (браузера или мобильного приложения). С помощью него мы запоминаем устройство клиента. В дальнейшем отслеживаем все действия, которые клиент совершал. DeviceUUID генерируется js-трекером Mindbox.
При наличии DeviceUUID можно:
- сохранить историю действий до регистрации (в рамках сессии, данные теряются после 30 минут неактивности);
- отследить окончание сессии и запустить сценарий по этому событию;
- уменьшить количество дублей в базе за счет объединений клиентов на основе данных об устройстве.
Отладка интеграции и анализ ошибок
Где посмотреть ошибки?
- Мониторинг интеграции — список всех операций с количеством ошибочных вызовов.
- Лог вызовов операций — список ошибочных вызовов операций.
- Анализ ответа операции — включите флаги «Добавить в ответ операции данные» и «Операция возвращает валидационные ошибки», чтобы анализировать ошибки в ответе операции.