token=qx6s4gsdvsdhsdsd

store_department_id=345 

PROMO15

user_phone=79001234567

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

https://sailplay.ru/api/v2/promocodes/info/?store_department_id=3620&token=12b3278xcb23b2498vxvb230nrfv24erf9&number=yfubf_mm400

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

"status":"ok"

"promocodes": [
    {
      "issued_to": {
        "id": 40560461,
        "name": "Grigory Sidorov"
      },
      "purchase_id": 187647692,
      "receipt_date": "2018-03-28T11:01:54.503",
      "group": {
        "status": 2,
        "type": 2,
        "name": "PromoGroup1"
      },
      "issued_by": null,
      "date_of_use": "2018-03-28T11:24:55.565",
      "order_num": "2734672364723",
      "marketing_action": [
        {
          "id": 7081,
          "name": "Test action"
        }
      ],       
      "possible_marketing_action": [
        {
            "status": 2,
            "service_msg": null,
            "name": "test2",
            "alias": "2",
            "client_msg": null,
            "id": 109
        },
        {
            "status": 2,
            "service_msg": null,
            "name": "test3",
            "alias": "3",
            "client_msg": null,
            "id": 110
        }
     ]    
   }
]

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

{
  "status": "ok",
  "promocodes": [
    {
      "issued_to": {
        "id": 40560461,
        "name": "Grigory Sidorov"
      },
      "purchase_id": 187647692,
      "receipt_date": "2018-03-28T11:01:54.503",
      "group": {
        "status": 2,
        "type": 2,
        "name": "PromoGroup1"
      },
      "issued_by": null,
      "date_of_use": "2018-03-28T11:24:55.565",
      "order_num": "2734672364723",
      "marketing_action": [
        {
          "id": 7081,
          "name": "Test action"
        }
      ],      
      "possible_marketing_action": [
        {
            "status": 2,
            "service_msg": null,
            "name": "test2",
            "alias": "2",
            "client_msg": null,
            "id": 109
        },
        {
            "status": 2,
            "service_msg": null,
            "name": "test3",
            "alias": "3",
            "client_msg": null,
            "id": 110
        }
     ]    
} ] }

placeholderplaceholderplacehold

/api/v2/promocodes/coupons/numbers/add - Создание сертификатов

Метод используется для создаения новых групп сертификатов. HTTP-метод: POST

Подготовка

Перед созданием сертификатов необходимо подготовить файл, в котором будут содержаться номера сертификатов. Допустимые форматы файлов:

• .txt
• .csv
• .xls
• .xlsx

При использовании .txt и .csv формата каждый номер сертификата должен будет указан с новой строки. В случае использования .xls или .xlsx формата номера должны быть указаны в одной колонке, где в каждой ячейке присутствует один номер сертификата.

Формат сертификата

• Тип: строка
• Ограничение по длине: от 2 до 255 символов
• Кодировка: UTF-8
• Допустимые символы: буквы из включенных в юникод алфавитов, цифры, знаки пунктуации, спецсимволы. Рекомендуется использование сочетаний цифр и/или букв.
• Уникальность: номер сертификата должен быть строго уникальным

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

token=qx6s4gsdvsdhsdsd

store_department_id=345

type=2

value=5000

name=Новогодние сертификат на 5000 рублей

target_dep_id=3487

pin_code=4455

Тело запроса

—

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

"status":"ok"

"status_code": -4201

"message": "Invalid file"

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

{
"status":"ok"
}

Возможные ошибки

Пара store_deprtment_id и token указаны неверно или отсутствуют

{
    "status": "error",
    "message": "Permission denied. Provide auth token and store_department_id"
}

Неподдерживаемый формат файла или файл отствует

{
    "status": "error",
    "status_code": -4201,
    "message": "Invalid file"
}

Не передан обязательный параметр запроса

{
    "status": "error",
    "status_code": -1000,
    "message": "Provide required {'field': 'name'}"
}

/api/v2/promocodes/coupons/groups/list/ - Список сертификатов

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

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

token=qx6s4gsdvsdhsdsd

store_department_id=345

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

"status":"ok"

"groups":[
   {
      "create_date":"2017-11-30T14:37:42.853",
      "name":"TTTTTTTTT",
      "total_count":6,
      "used_count":0,
      "activated_count":0,
      "id":1649
   }

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

https://sailplay.ru/api/v2/promocodes/coupons/groups/list/?store_department_id=3620&token=12b3278xcb23b2498vxvb230nrfv24erf9

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

{
	  "status": "ok",
	  "groups": [
	  {
	  "create_date": "2016-12-15T20:36:23",
	  "name": "Test Certificate",
	  "total_count": 1,
	  "used_count": 0,
	  "activated_count": 0,
	  "id": 924
	  }
	  ]
}

Возможные ошибки

Пара store_deprtment_id и token указаны неверно или отсутствуют

{
    "status": "error",
    "message": "Permission denied. Provide auth token and store_department_id"
}

/api/v2/promocodes/coupons/numbers/status/ - Проверка статусов сертификатов

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

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

token=qx6s4gsdvsdhsdsd

store_department_id=345

number=testcert1

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

"status":"ok"

"used": false

"value_type": 2

"deleted": false

"group":{
   "id":1649,
   "name":"TTTTTTTTT"
}

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

https://sailplay.ru/api/v2/promocodes/coupons/numbers/status/?store_department_id=3620&token=12b3278xcb23b2498vxvb230nrfv24erf9&number=8m8iv

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

{
	  "status": "ok",
	  "used": false,
	  "value_type": 2,
	  "deleted": false,
	  "group": {
	  "id": 1132,
	  "name": "Test Certificate 2"
	  },
	  "dep_id": 3516,
	  "activated": false,
	  "number": "8m8iv",
	  "value": "50"
}

Возможные ошибки

Пара store_deprtment_id и token указаны неверно или отсутствуют

{
    "status": "error",
    "message": "Permission denied. Provide auth token and store_department_id"
}

Не передан обязательный параметр

{
    "status": "error",
    "status_code": -1000,
    "message": "Provide required {'field': 'number'}"
}

/api/v2/promocodes/coupons/numbers/activate/ - Активация сертификата

Этот метод используется для активации сертификата. Вызывается в момент передачи сертификата покупателю, который его приобрел, и является механизмом защиты от мошеннических действий. Таким образом, если, например, список номеров сертификатов стал доступен третьим лицам, утекшие сертификаты не смогут быть использованы, так как они еще не были активированы.

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

token=qx6s4gsdvsdhsdsd

store_department_id=345

number=testcert1

target_dep_id=3487

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

"status":"ok"

"activated": true

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

https://sailplay.ru/api/v2/promocodes/coupons/numbers/activate/?store_department_id=3620&token=12b3278xcb23b2498vxvb230nrfv24erf9&number=8m8iv

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

{
  "status": "ok",
  "activated": true
}

Возможные ошибки

Пара store_deprtment_id и token указаны неверно или отсутствуют.

{
    "status": "error",
    "message": "Permission denied. Provide auth token and store_department_id"
}

Не передан обязательный параметр

{
    "status": "error",
    "status_code": -1000,
    "message": "Provide required {'field': 'number'}"
}

/api/v2/promocodes/coupons/numbers/use/ - Использовать сертификат

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

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

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

token=qx6s4gsdvsdhsdsd

store_department_id=345 

jn321jns

target_dep_id=3487

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

"status":"ok"

"used": true

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

https://sailplay.ru/api/v2/promocodes/coupons/numbers/use/?store_department_id=3620&token=12b3278xcb23b2498vxvb230nrfv24erf9&number=8m8iv

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

{
  "status": "ok",
  "used": true
}

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

{
  "status": "ok",
  "used": true
}

Возможные ошибки

Пара store_deprtment_id и token указаны неверно или отсутствуют

{
    "status": "error",
    "message": "Permission denied. Provide auth token and store_department_id"
}

Не передан обязательный параметр

{
    "status": "error",
    "status_code": -1000,
    "message": "Provide required {'field': 'number'}"
}

/api/v2/promocodes/coupons/numbers/delete - Удаление сертификатов

Метод используется для удаления отдельных номеров сертификтов. Возможно удаление сертификатов с любым статусом: активирован, использован и пр.

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

token=qx6s4gsdvsdhsdsd

store_department_id=345

number=testcert1

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

"status":"ok"

"deleted": true

"deleted_date": "2017-11-30T17:17:18.071"

"number": "testcert1"

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

{
    "deleted": true,
    "status": "ok",
    "deleted_date": "2017-11-30T17:17:18.071",
    "number": "йцв765йц7в65"
}

Возможные ошибки

Пара store_deprtment_id и token указаны неверно или отсутствуют

{
    "status": "error",
    "message": "Permission denied. Provide auth token and store_department_id"
}

Не передан обязательный парметр запроса

{
    "status": "error",
    "status_code": -1000,
    "message": "Provide required {'field': 'name'}"
}