SSAPI Implementation

Дата создания: 18.11.22 Дата последнего обновления: 26.07.24 Автор: Анастасия Ноговицына

Основные отличия серверной интеграции от фронтовой

В рамках API интеграции необходимо самостоятельно назначать ID для пользователей и сессий.

Создание новых кампаний требует подключения команды разработки — а именно,

необходимо реализовать запрос кампании с помощью choose
обработать полученный ответ (JSON) и отобразить результат
передать информацию о взаимодействиях пользователя с кампанией с помощью engagement

Для осуществления запросов необходимо использовать API-ключи, сгенерированные в вашем аккаунте: Управление API-ключами .

Гибридная интеграция (JS скрипт + серверные запросы)

Гибридный вариант интеграции совмещает в себе элементы фронтовой и серверной интеграции. Для обеспечения сквозной идентификации пользователя необходимо в рамках серверных API-вызовов передавать в Gravity Field значения

cookie с ID пользователя
сессии

Значения данных кук выставляются по-разному в зависимости от того, является ли пользователь новым или вернувшимся.

Если пользователь новый (взаимодействует со страницами сайта, где отсутствует скрипт Gravity Field, в первый раз), кампании для него запрашиваются с user.slid и session.sl равными null. В ответе на запрос choose вернутся значения кук _slid, _slid_server, _slsession, которые будет необходимо указывать в дальнейших запросах для данного пользователя, а также установить в браузере пользователя.

Если пользователь вернувшийся, то в гибридных запросах для него необходимо передавать

в атрибуте user.slid: значения куки _slid и/или куки _slid_server (если есть оба значения кук, передаём оба; в некоторых случаях у пользователя может быть только одна из кук). Передаваемые в запросах значения кук _slid и _slid_server должны совпадать с их значениями в браузере пользователя
в атрибуте session.sl: значение куки _slsession (если она существует). Передаваемое в запросах значение куки _slsession должно совпадать с её значением в браузере пользователя