Перейти к содержанию
Документация для разработчиковПоддержка Запросить демо Войти
Pushwoosh.com

Вход на основе API

Как это работает

Anchor link to

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

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

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

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

Элемент входа на основе API на холсте Journey

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

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

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

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

Настройка Journey с входом на основе API

Anchor link to
  1. Создайте Journey с входом на основе API:

  1. Дважды щелкните на шаге входа на основе API. Откроется окно конфигурации входа.

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

Например, вы создаете Journey для уведомления подписчиков о выходе нового эпизода подкаста. Используя плейсхолдер, вы можете изменять название подкаста каждый раз при запуске Journey.

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

Добавление имен плейсхолдеров контента в окне настройки входа на основе API

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

  • {placeholder_name|format_modifier|} – если значение плейсхолдера не указано при запуске кампании, пользователи увидят на его месте пустое пространство.
  • {placeholder_name|format_modifier} – если значение плейсхолдера не указано и еще не было присвоено пользователю (в случае, если вы использовали Tag в качестве плейсхолдера), сообщение не будет отправлено.
Модификаторы формата
  • CapitalizeFirst – делает заглавной первую букву в значении плейсхолдера
  • CapitalizeAllFirst – делает заглавными первые буквы во всех словах в значении плейсхолдера
  • UPPERCASE – переключает все буквы в верхний регистр
  • lowercase – переключает все буквы в нижний регистр
  • regular – вставляет значение плейсхолдера в точности так, как указано в запросе
Вставка плейсхолдера в пресет пуша для динамического контента

При настройке элемента Push или Email в вашем Journey выберите созданный пресет и включите опцию Персонализировать сообщение с помощью атрибутов события.

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

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

  1. В окне конфигурации входа скопируйте шаблон запроса для его изменения:
Копирование шаблона запроса из окна конфигурации входа на основе API
  1. Добавьте фильтры аудитории в параметр "filter", используя язык сегментации или скопируйте логику сегментации из ваших сегментов. Заранее настройте необходимые теги (Tags).

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

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

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

  1. Если вы настроили плейсхолдеры, укажите желаемый контент в качестве их значений:
Указание значений плейсхолдеров в API-запросе для запуска Journey
  1. Если вы планируете часто перезапускать кампанию и не хотите, чтобы одни и те же пользователи входили в Journey несколько раз, установите ограничения на вход в кампанию.

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

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

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