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

Методы:

  • /api/v2/tags/vars/delete/ - удалить связанные с тегом переменные
  • /api/v2/tags/vars/get/ - получить информацию о переменных, привязанных к тегу
  • /api/v2/tags/vars/set/ - записать информацию о переменных, привязанных к тегу
  • /api/v2/tags/use/ - присвоить тег аудитории
  • /api/v2/tags/tree/add/ - добавление тегов или разделов в древо тегов

/api/v2/tags/vars/delete/ - удалить связанные с тегом переменные

Назначение метода

Метод позволяет удалить связанные с тегом переменные.

Параметры запроса

Параметр обязательный? Имя параметра Описание параметра
да token  см. здесь
да store_department_id  см. здесь
да tag  Тег, к которому привязаны переменные. 
да vars  Список переменных, которые следует удалить.

Пример запроса

http://sailplay.ru/api/v2/tags/vars/delete/?tag=global&vars=key1,key2&store_department_id=3132&token=0e96be0867401601dfac6e8691476bfaaa73f3a7

Пример ответа сервера

{"status": "ok", "deleted_count": 2}

/api/v2/tags/vars/get/ - получить информацию о переменных, привязанных к тегу

Назначение метода

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

Параметры запроса

Параметр обязательный? Имя параметра Описание параметра
да token  см. здесь
да store_department_id  см. здесь
да tag  Тег, к которому привязаны переменные. 
да vars  Список переменных, по которым требуется получить информацию. 

Пример запроса

http://sailplay.ru/api/v2/tags/vars/get/?tag=global&vars=key1,key2&store_department_id=3132&token=0e96be0867401601dfac6e8691476bfaaa73f3a7

Пример ответа сервера

{
    "status": "ok",
    "vars":{
            "key1": "value1",
            "key2": "value2"
        }
}

/api/v2/tags/vars/set/ - записать информацию о переменных, привязанных к тегу

Назначение метода

Метод позволяет редактировать привязанные к тегу переменные.

Все переменные обрабатываются сервером как строки.

При передаче в значении переменной длинной строки (например, HTML код) рекомендуется передавать параметр vars в POST части запроса.

Параметры запроса

Параметр обязательный? Имя параметра Описание параметра
да token  см. здесь
да store_department_id  см. здесь
да tag  Тег, к которому привязаны переменные.
да vars  Список переменных в формате JSON объекта.

Пример запроса

http://sailplay.ru/api/v2/tags/vars/set/?tag=global&vars={“key1”:”value1”,“key2”:”value2”}&store_department_id=3132&token=0e96be0867401601dfac6e8691476bfaaa73f3a7

Пример ответа сервера

{"updated_count": 0, "created_count": 1, "status": "ok"}

 

/api/v2/tags/use/ - присвоить тег аудитории

Назначение метода

Метод позволяет проставить тег, указанный в параметре use_tag, (и запустить связанную с ним цепочку) для аудитории тега, указанного в параметре for_tag.

Этот механизм является аналогом триггерных рассылок, аудитория которых определяется тегом.

В качестве примера использования рассмотрим реализацию уведомления о поступлении ожидаемого товара:

При нажатии кнопки "Сообщить мне о появлении iPhone 7" клиенту присваивается  
тег "Ждет появления iPhone 7" и переменная для этого тега item_name = "iPhone 7".
На стороне SailPlay настраивается цепочка тега "Поступил ожидаемый товар".
В тексте письма используется конструкция $[this["item_name"]], которая
будет заменена на значение переменной item_name тега, указанного в параметре for_tag.
В момент поступления товара вызываем метод use с параметрами use_tag =
"Поступил ожидаемый товар" и for_tag = "Ждет появления iPhone 7". При этом всем клиентам,
которым присвоен тег "Ждет появления iPhone 7" будет присвоен тег "Поступил
ожидаемый товар" и будет отправлено письмо, в котором вместо $[this["item_name"]] будет "iPhone 7".

Присвоение тега и выполнение действий цепочки выполняется в порядке очереди и это может занять некоторое время.

Размер аудитории, для которой вызывается метод ограничен 20 000 клиентов.

Параметры запроса

Параметр обязательный? Имя параметра Описание параметра
да token  см. здесь
да store_department_id  см. здесь
да use_tag  Присваиваемый тег, цепочка которого будет запущена.
да for_tag  Тег, аудитории которого будет присвоен тег из параметра use_tag

Пример запроса

http://sailplay.ru/api/v2/tags/use/?use_tag=Поступил ожидаемый товар&for_tag=iPhone 7&store_department_id=435&token=b3c7ac443b9b93bf4daa20f5429a255b5f77bb4b

Пример ответа сервера

{"status": "ok","message": "job in queue"}



/api/v2/tags/tree/add/ - добавление тегов или разделов в древо тегов

Назначение метода

Метод предназначен для создания тегов и разделов/подразделов в древе тегов.

Если is_category = 1, то создаётся раздел в древе тегов
Если is_category  = 1 и parent_id=XXX, то создаётся подраздел, где XXX это id раздела из древа тегов
Если is_category = 0, то создаётся тег

Параметры запроса для создания группы

Параметр обязательный? Имя параметра Описание параметра
да token см. здесь
да store_department_id см. здесь
да is_category Значение = 1 - создать категорию
да parent_id Пустое значение - создать категорию верхнего уровня.
Если указать id категории будет создана подкатегория 
да name Имя категории
да kind Требуется указать значение "flag"
     


Пример запроса

https://sailplay.ru//api/v2/tags/tree/add/?is_category=1&parent_id=&name=testing_1&kind=flag&store_department_id=1&token=b3c7ac443b9b93bf4daa20f5429a655dwet23445

 

Пример ответа сервера

В случае успеха

{  "status": "ok",
  "event": {
    "is_category": true,
    "update_date": "2020-02-11T11:56:30.977",
    "kind": "flag",
    "category_color": "",
    "create_date": "2020-02-11T11:56:30.972",
    "name": "testing_1",
    "is_chains_event": false,
    "sender_name": null,
    "is_system": false,
    "is_campaigns_event": false,
    "parent_id": null,
    "sender_templates_vars_help": null,
    "key": "7bdd41600db18213b6b56feb5fe10ba367592db5",
    "is_deleted": false,
    "is_future": false,
    "id": 10889702,
    "is_deletable": true
  }
}





Параметры запроса для создания тега

Параметр обязательный? Имя параметра Описание параметра
да token см. здесь
да store_department_id см. здесь
да is_category Значение = 0 - создать тег
да parent_id Требуется указать id категории куда будет вложен тег
да name Имя тега
да kind Типы тега могут быть: флаг, счётчик, сумматор(flag, counter, sum)
     


Пример запроса

https://sailplay.ru//api/v2/tags/tree/add/?is_category=0&parent_id=10889702&name=testing_my_1r&kind=sum&store_department_id=1&token=b3c7ac443b9b93bf4daa20f5429a65435342sgs

 

Пример ответа сервера

В случае успеха


{
  "status": "ok",
  "event": {
    "is_category": false,
    "update_date": "2020-02-11T12:05:43.224",
    "kind": "sum",
    "category_color": "",
    "create_date": "2020-02-11T12:05:43.207",
    "name": "testing_my_1",
    "is_chains_event": true,
    "sender_name": null,
    "is_campaigns_event": true,
    "parent_id": 10889702,
    "sender_templates_vars_help": null,
    "key": "64d64890b7c94a9c789af204c6b70ca2647fbca5",
    "is_deleted": false,
    "is_future": false,
    "id": 10889711
  }
}