ПАРТНЕРСЬКИЙ ПОСІБНИК
Slovenština Čeština Němčina Angličtina Chorvatština Maďarština Italština Polština Ruština Slovinština Ukrajinština Vietnamština
Вступ Корисні посібники ІТ підтримка Партнерський API Slevomat.cz

Партнерський API Slevomat.cz

Ця стаття була перекладена електронним перекладачем.

API використовується для передачі інформації про ваучери між Zlavomat та системою бізнес-партнера. Це дозволяє партнеру перевіряти дійсність ваучерів у своїй системі та активувати їх. Партнеру не потрібно використовувати партнерський інтерфейс для цієї мети.

Можливі приклади використання:

  • Клієнт купує ваучер, умовою надання послуги якого є введення коду на веб-сайті партнера під час створення замовлення. Завдяки API, після цього введення, термін дії ваучера одразу перевіряється. Його вартість потім списується з кошика партнера, і ваучер автоматично активується в Zlavomot.
  • Так само, дійсність ваучерів також можна перевірити в системі бронювання партнера, або клієнт може завантажити придбаний кредит певної вартості безпосередньо на веб-сайті партнера.

Для використання Partner API потрібен унікальний для кожного партнера токен , який надсилається з кожним запитом. Якщо ви хочете використовувати Partner API, зверніться до свого/нашого продавця.

Формат запиту

Точка доступу до API розташована за адресою /api.

Формат запиту такий

<URL přístupového bodu>/<akce>[<pa­rametry>]

Усі запити є стандартними HTTP GET-запитами, тобто запит на перевірку дійсності ваучера може виглядати, наприклад, так:

https://www.zlavomat.sk/api/vouchercheck?code=1234-5677-77-111&token=123456789012345.

Формат відповіді

Відповідь сервера завжди надсилається у форматі JSON з відповідним заголовком Content-type. Основна структура відповіді така:

{
 "result": true,
 "data": {
 ...
 },
 "error": {
 "code": 0,
 "message": null
 }
}

Значенням результуючого елемента є true (у разі успіху) або false (у разі помилки). У разі помилки елемент помилки містить код помилки ( code ) та її опис ( message ). Окрім індикації в полі помилки, система повертає відповідний код стану HTTP (400, 401, 403, 404) у разі помилки.

Елемент даних містить дані, повернуті викликаною дією, і його вміст є індивідуальним.

Усі дані мають формат РРРР-ММ-ДДТГГ:ХХ:ССЗ (ISO8601; наприклад, 2011–01–01T10:10:10+02:00).

Перевірка дійсності ваучера

  • дія: перевірка ваучера
  • параметри: токен (обов'язковий; унікальний токен партнера), код (обов'язковий; код ваучера)

Існує три коди ваучерів на тестування:

  • 1234–5677–77–111 (оплачено, невикористано),
  • 2234–5688–88–222 (платний, використаний),
  • 3234–5699–99–333 (неоплачений, невикористаний).

Якщо застосунок використовує один із цих кодів, сервер поверне відповідну відповідь (у випадку оплаченого та невикористаного ваучера, він також поверне зразок ваучера та дані про дію).

Формат даних відповіді

{
 "token": <autentizační token>,
 "code": <kód voucheru>,
 "voucherData": <data voucheru>
}

Параметр voucherData містить визначення ваучера у такому форматі.

{
 "id": <ID voucheru>,
 "orderId": <ID objednávky>,
 "title": <název voucheru>,
 "ordered": <datum a čas objednávky; datum a čas>,
 "paidDate": <datum zaplacení objednávky; datum>
 "validFrom": <začátek platnosti voucheru; datum>,
 "validTo": <konec platnosti voucheru; datum>,
 "key": <kód voucheru>,
 "code": <kód voucheru>,
 "product": <ID akce>,
 "productName": <název akce>,
 "variant": <ID varianty akce>,
 "variantName": <název varianty akce>,
 "imageUrl": <URL obrázku>,
 "smallImageUrl": <URL náhledu>,
 "productUrl": <URL akce>
}

Елементи варіантів або varianName містять ID або назву впорядкованого варіанта дії, якщо задана дія містить варіанти. Якщо ні, обидва атрибути мають значення NULL .

Стан помилок

  • код 1101 (код статусу HTTP 400): токен автентифікації або код ваучера не введено,
  • код 1102 (код статусу HTTP 403): даний токен відсутній у базі даних,
  • код 1103 (код статусу HTTP 404): ваучер із зазначеним кодом не існує,
  • код 1104 (код статусу HTTP 401): замовлення, на підставі якого було видано ваучер, не було оплачено,
  • код 1105 (код статусу HTTP 401): ваучер вже використано,
  • код 1106 (код статусу HTTP 401): ваучер повернено,
  • код 1107 (код статусу HTTP 401): замовлення або ваучер скасовано,
  • код 1108 (код статусу HTTP 401): рахунок за дію вже виставлено партнеру; застосувати інші ваучери неможливо,
  • код 1109 (код статусу HTTP 401): термін дії ваучерів на цю подію ще не розпочався.
  • код 1111 (код стану HTTP 500): внутрішня помилка сервера

Приклад запиту

https://www.zlavomat.sk/api/vouchercheck?code=1234-5677-77-111&token=123456789012345

Приклад відповіді

{
 "result": true,
 "data": {
 "token": "123456789012345",
 "code": "1234567890-123",
 "voucherData": {
 "title": <název voucheru>,
 ...
 }
 },
 "error": {
 "code": 0,
 "message": null
 }
}

Використання ваучера

  • дія: ваучерПодати заявку
  • параметри: токен (обов'язковий; унікальний токен партнера), код (обов'язковий; код ваучера)

Буде зроблено спробу активувати ваучер із наданим кодом.

Номер тестового ваучера можна використовувати для цілей тестування. У такому випадку ваучер не буде використано, але система поверне відповідь, ніби це сталося.

Формат даних відповіді

Формат відповіді точно такий самий, як і у випадку перевірки дійсності ваучера.

Стан помилок

  • код 1201 (код статусу HTTP 400): токен автентифікації або код ваучера не введено,
  • код 1202 (код статусу HTTP 403): даний токен відсутній у базі даних,
  • код 1203 (код статусу HTTP 404): ваучер із зазначеним кодом не існує,
  • код 1204 (код статусу HTTP 401): замовлення, на підставі якого було видано ваучер, не було оплачено,
  • код 1205 (код статусу HTTP 401): ваучер вже використано,
  • код 1206 (код статусу HTTP 401): ваучер повернено,
  • код 1207 (код статусу HTTP 401): замовлення або ваучер скасовано,
  • код 1208 (код статусу HTTP 401): рахунок за дію вже виставлено партнеру; застосувати інші ваучери неможливо,
  • код 1209 (код статусу HTTP 401): термін дії ваучерів на цю подію ще не розпочався.
  • код 1211 (код стану HTTP 500): внутрішня помилка сервера

Приклад запиту

https://www.zlavomat.sk/api/voucherapply?code=1234-5677-77-111&token=123456789012345

Приклад відповіді

{
 "result": true,
 "data": {
 "token": "123456789012345",
 "code": "1234567890-123",
 "voucherData": {
 "title": <název voucheru>,
 ...
 }
 },
 "error": {
 "code": 0,
 "message": null
 }
}

Примітка: Щоб використовувати Partner API для зчитування вартості товарів у кошику, подумайте про те, щоб додати більше атрибутів параметра voucherData. Це особливо важливо, коли у вас запущено кілька кампаній з різною вартістю пропонованих товарів. Ми рекомендуємо використовувати переважно атрибути product або variant.

Повернутися до списку статей

Схожі статті

Вгору