Перейти к основному содержимому

Атрибут-идентификатор

В Sailplay есть возможность указывать дополнительные идентификаторы клиентов и использовать их при интеграции при отправке API‑запросов.

В качестве таких идентификаторов могут использоваться, например:

  • cookie-файлы с сайта;
  • второй номер телефона;
  • второй email;
  • идентификатор сессии;
  • внешний ID из CRM и т. д.

Использование атрибутов как идентификаторов​

Все существующие методы Sailplay API, которые принимают стандартные идентификаторы клиента
(user_phone, email, origin_user_id), также могут принимать атрибуты-идентификаторы.

Для этого вместо стандартных параметров необходимо передавать специальные поля, зависящие от типа метода.

Создание клиента​

Для метода создания клиента используются параметры:

  • id_field — техническое название атрибута;
  • id_value — значение атрибута.
users/add
curl --request POST   --url https://api.sailplay.ru/api/v2/users/add/   --header 'Content-Type: application/x-www-form-urlencoded'   --data token=***   --data store_department_id=***   --data id_field=visitor_id   --data id_value=1181142583

Остальные методы работы с клиентами​

Для всех остальных методов, связанных с клиентами, используются параметры:

  • identification — техническое название атрибута;
  • lookup — значение атрибута.
users/tags/add
curl --request POST   --url https://api.sailplay.ru/api/v2/users/tags/add/   --header 'Accept: application/json'   --header 'Content-Type: application/x-www-form-urlencoded'   --data token=***   --data store_department_id=***   --data identification=visitor_id   --data lookup=1181142583   --data 'tags=NewVisit'

Типы данных​

Все параметры идентификации (id_field, id_value, identification, lookup) имеют тип string.