Управление сессией

Указатель на пользователя link

Для некоторых вызовов API требуется идентифицировать посетителя, для которого этот запрос применим. Для этого необходимо использовать указатель на пользователя - параметр link.

link - это указатель на посетителя - пара, состоящая из произвольных строки-ключа и строки-значения (например, ключ — "сессия пользователя", значение — "идентификатор сессии").

Для API получения товарных рекомендаций он передается в качестве query параметра, а для API трекинга пользовательского поведения - в теле запроса.

📘

Подробнее про link

Использование link позволяет объединять в один профиль данные из различных источников, например:

  • Сайт;
  • Мобильное приложение;
  • Розничные точки продаж;
  • Call-центры;

Идентификатор sessionExternalId

В качестве альтернативы использования сессии можно передавать идентификатор пользовательской сессии в параметре sessionExternalId. Идентификатор должен быть сгенерирован на стороне магазина и обладать следующими свойствами:

  • Состоять только из цифр и букв;
  • Не превышать 50 символов;
  • Быть уникальным для устройства/браузера;
  • Не содержать персональных данных, например, телефона или адреса электронной почты;
  • Не должен изменяться при авторизации или смене аккаунта.

📘

Рекомендация

При первом появлении посетителя на сайте или в мобильном приложении генерировать GUID и использовать его в качестве sessionExternalId для последующих вызовов API.

❗️

Важно

При использовании sessionExternalId в качестве идентификатора сессии, в API трекинга пользовательского поведения для всех событий, кроме заказа товара, необходимо использовать следующий base URL для запросов:

https://apptracking.retailrocket.ru/1.0

Для API метода заказа товара, base URL будет иметь следующее значение:

https://apptracking.retailrocket.ru/1.1

Использование session (cookie)

В платформе Retail Rocket также есть возможность совмещать интеграцию трекинга пользовательского поведения, сделанного через JS SDK, с товарными рекомендациями, которые можно запрашивать через API.

Для этого, в запросах рекомендаций вместо параметра link / sessionExternalId, необходимо использовать параметр session, где session - анонимизированный идентификатор пользователя. Содержится на сайте в cookie rcuid, которая используется при трекинге пользовательского поведения при JS SDK интеграции.

🚧

Важно

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

Вы можете получить значение rcuid с помощью следующего JS метода на сайте:

<script type="text/javascript">
    (window["rrApiOnReady"] = window["rrApiOnReady"] || []).push(function() {
    try{ window.rrVisitorSessionId = retailrocket.api.getSessionId(); } catch(e) {}
  })
</script>