Методы

  • /api/v2/events/fire/ - добавление события
  • /api/v2/events/list/ - список событий
  • /api/v2/events/status/ - статус события

/api/v2/events/fire/ - добавление события

Описание метода

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

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

Параметр обязательный? Имя параметра Описание параметра
да user_phone или email или origin_user_id  Идентификатор клиента. Более подробно см. здесь.
да token  См. здесь
да store_department_id  См. здесь
да event_key  Уникальный идентификатор данного события
нет value  Передаваемое значение. Обязательно в случае если тип события - “сумматор”.
нет purchase_order_num  Номер заказа, при подтвержении которого, должны быть подтвержены бонусные баллы за данное событие.

Ответ сервера

status

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

http://sailplay.ru/api/v2/events/fire/?event_key=85783d035a716769502775afa287fce17040afe1&value=300&store_department_id=11&token=d352f4d1d241658e56142f2430bea4f72a80a6ae&origin_user_id=dsf212k2hg1j311fff

Зависимость начисления баллов за событие от покупки 

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

В этом случае необходимо работать следующим образом:

  1. отправляется запрос к методу начисления бонусных баллов за покупку, в запросе передается order_num

  2. отправляется запрос к методу отправки события, в которой передается дополнительный параметр - purchase_order_num 

В этом случае, бонусные баллы за данное событие будут неактивными, но сразу после подтверждения покупки с указанным номером заказа, бонусные баллы станут активными.

Стоит учитывать, что если в ответе вернется ошибка:

{"status": "error", "status_code": -1000, "message": "Provide required parameters"}

то событие не будет создано. 

/api/v2/events/list/ - список событий

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

Метод возвращает список всех событий.

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

Параметр обязательный? Имя параметра Описание параметра
да token  См. здесь
да store_department_id  См. здесь

Ответ сервера

Название параметра Описание параметра
status  
events Массив объектов-событий со следующими аттрибутами:
create_date  
update_date  
kind Тип события (flag, counter, sum). Подробнее см. здесь
name Название события
key Идентификатор (ключ) события

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

http://sailplay.ru/api/v2/events/list/?store_department_id=111&token=da32f321d2516c8e56142f2430bea4f72a80a6ae

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

{
status: "ok",
events:
[
{
update_date: "2013-07-09T10:56:26",
kind: "flag",
create_date: "2013-07-09T10:56:26",
name: "Регистрация на сайте",
key: "8bd3ede30c49139a9410daf3c42329d40722b0c5"
},
{
update_date: "2013-07-09T10:56:32",
kind: "flag",
create_date: "2013-07-09T10:56:32",
name: "Активация Джунглей",
key: "3d6146b18024fe9681c16e05b6f525acda0c9511"
}
}

/api/v2/events/status/ - статус события

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

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

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

Параметр обязательный? Имя параметра Описание параметра
да user_phone или email или origin_user_id  Идентификатор клиента. Более подробно см. здесь.
да token  См. здесь
да store_department_id  См. здесь
да event_key  Уникальный идентификатор данного события

Ответ сервера

Название параметра Описание параметра
status  
event Объект-событие со следующими аттрибутами:
fire_count Количество вызовов данного события для данного пользователя
create_date  
calculated_value Значение (только для события типа сумматор)
update_date  

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

{
status: "ok",
event:
{
update_date: "2013-07-09T11:26:53",
fire_count: 1,
create_date: "2013-07-09T11:26:53",
calculated_value: 0
}
}



{
status: "error",
status_code: -4007,
message: "Event for user not found"
}