Вход в сценарий по API

Вход по API позволяет запускать сценарий для клиента в тот момент, когда происходит определенное бизнес-событие. Чтобы запустить кампанию, необходимо отправить специальный API-запрос.

Вот несколько сценариев использования входа по API:

• Информировать клиентов о том, что некоторые из ваших товаров снова в наличии;
• Сообщать пользователям о снижении цены на популярный товар;
• Уведомлять подписчиков о выходе нового выпуска подкаста.

В отличие от обычных Событий (Events), все эти бизнес-события могут происходить вне приложения. Например, наличие товара можно проверить только во внешней базе данных. Именно здесь и пригодится вход по API: вы можете настроить отправку запроса на запуск сценария всякий раз, когда происходят определенные изменения вне приложения (например, в вашей внешней базе данных).

Это работает следующим образом:

1. Создайте сценарий с входом по API. В настройках входа вы найдете шаблон запроса, который запускает сценарий.
2. Добавьте в запрос условия сегментации, используя язык сегментации. Вы также можете добавить в запрос плейсхолдеры для контента, чтобы изменять содержимое сообщения в зависимости от контекста.
3. При необходимости автоматизируйте запрос. Например, информация об изменении цены может быть немедленно отправлена из базы данных на веб-хук. Как только это произойдет, веб-хук должен автоматически отправить запрос на запуск сценария. Вы также можете отправить запрос вручную, если автоматизация не требуется.

Вы можете отправлять запрос неограниченное количество раз, чтобы изменить условия сегментации или содержимое сообщения.

Для получения более подробной информации следуйте приведенным ниже инструкциям.

1. Создайте сценарий с элементом «Вход по API»:

2. Дважды щелкните на шаге «Вход по API». Откроется окно настройки элемента.

3. Вы можете изменять содержимое push-уведомления и email при каждом запуске сценария с помощью плейсхолдеров контента. Значение каждого плейсхолдера можно изменить в запросе. Если эта опция вам не нужна, вы можете пропустить этот шаг.

Например, вы создаете сценарий для уведомления подписчиков о выходе нового выпуска подкаста. С помощью плейсхолдера вы можете изменять название подкаста при каждом запуске сценария.

Сначала добавьте имена плейсхолдеров в окне настройки входа по API. Вы можете использовать любые удобные для вас имена.

Теперь создайте пресет для push-уведомления или email и вставьте плейсхолдер вместо текста, который вы хотите изменять. Плейсхолдер должен иметь один из следующих форматов в зависимости от ваших потребностей:

• {placeholder_name|format_modifier|} – если значение плейсхолдера не указано при запуске кампании, пользователи увидят на его месте пустое пространство.
• {placeholder_name|format_modifier} – если значение плейсхолдера не указано и еще не было присвоено пользователю (в случае, если вы использовали Тег в качестве плейсхолдера), сообщение не будет отправлено.

При настройке шага Push или Email в вашем сценарии выберите созданный пресет и включите опцию Персонализировать сообщение с атрибутами события. Выберите плейсхолдеры, которые вы хотите изменять в запросе при запуске сценария. В качестве источника выберите Вход по API, а в качестве динамического атрибута — имя плейсхолдера:

Нажмите Применить, чтобы сохранить изменения.

4. В окне настройки входа скопируйте шаблон запроса, чтобы изменить его:

5. Добавьте фильтры аудитории в параметр filter, используя язык сегментации, или скопируйте язык сегментации из ранее созданных вами Сегментов. Обратите внимание, что вам необходимо заранее настроить нужные Теги.

Например, если вы хотите нацелить сценарий на пользователей, которые добавили товар Socks в свой Wishlist, значение filter должно выглядеть следующим образом:

"filter": "A(\"12345-12345\") * "T(\"Wishlist\", EQ, \"Socks\")"

В этом примере в вашем приложении должен быть настроен Тег Wishlist.

6. Если вы настроили плейсхолдеры, укажите желаемый контент в качестве их значений:

7. Если опция Лимиты скорости отправки сообщений включена, количество пользователей, одновременно входящих в сценарий каждую секунду, будет ограничено. Вы можете использовать значение по умолчанию 5000 пользователей в секунду или установить другое число.

8. Если вы планируете часто перезапускать кампанию и не хотите, чтобы одни и те же пользователи входили в сценарий несколько раз, установите Ограничение частоты.

Например, вы создали кампанию для уведомления пользователей о снижении цены на определенный товар. Вы хотите перезапустить сценарий несколько раз, отправив несколько запросов с разными фильтрами аудитории. В этом случае вы можете добавить Ограничение частоты, чтобы уведомление не отправлялось повторно пользователям, которые соответствуют нескольким фильтрам.

9. Если вы хотите, чтобы сценарий запускался всякий раз, когда происходит определенное бизнес-событие, автоматизируйте отправку запроса с помощью веб-хука. Как только событие произойдет, веб-хук должен автоматически отправить запрос на запуск сценария.

Вы также можете отправить запрос вручную, если автоматизация не требуется.