Метод check
GET
Служит для проверки кода сертификата и получения информации о доступных для обмена продуктах.
Параметры запроса
| Параметр | Описание |
|---|---|
| code | Обязательное. Код/номер сертификата. |
| pin | Обязательное. Пин-код сертификата. |
| lang | Язык для некоторых полей с описанием продуктов, категорий. Доступны ru или en. |
Пример запроса
bash
curl 'https://activate.giftery.ru/api/v1/check?code=99999-999-999-999&pin=9999'Параметры ответа
| Параметр | Тип | Описание |
|---|---|---|
| certificate | Certificate | Содержит переданный code и pin. |
| error | boolean | Будет равно false в случае, если сертификат найден, не просрочен и ещё не был обменян, т.е. им можно воспользоваться. В остальных случаях будет равно true. |
| message | string | Текст сообщения об ошибке. |
| order_info | OrderInfo | Свойство присутствует только в случае, если сертификат уже был обменян. |
| product_id | integer | ID продукта в системе. |
| product_title | string | Название продукта. |
| balance | integer | Баланс сертификата |
| remaining_number_of_uses | integer | Количество оставшихся использований сертификата |
| total_number_of_ues | integer | Всего возможных использований |
| order_id | integer | Уникальный ID заказа. Данное свойство присутствует только в случае возожности обмена. |
| shop_id | integer | Дополнительный номер заказа. Данное свойство присутствует только в случае возожности обмена. |
| main_image | array | Массив путей к обложке сертификата. |
| face | integer | Доступный номинал мультибрендового сертификата. Данное свойство присутствует только в случае возожности обмена. |
| expire_date | string | Дата истечения срока действия сертификата. Данное свойство присутствует только в случае возожности обмена. |
| recipient_email | string | Email получателя мультибрендового сертификата. |
| multibrand | Multibrand | Объект содержащий информацию о продукте, сертификат которого обменивается. Данное свойство присутствует только в случае возожности обмена. |
| products | Product{} | Объект с доступными для обмена брендами. Ключом служит строка с ID продукта. Данное свойство присутствует только в случае возожности обмена. |
| categories | Category[] | Массив с категориями брендов. Данное свойство присутствует только в случае возожности обмена. |
| status | string | Присутствует, если сертификат найден. Единственное значение - ok. |
Пример корректного ответа
В случае отсутствия ошибок в ответе вернётся информация об обмениваемом сертификате, доступных продуктах, категориях и другая дополнительная информация.
Примечание. Ответ приведён в урезанном виде для демонстрации.
json
{
"certificate": {
"code": "99999999999999",
"pin": "9999"
},
"error": false,
"face": 5000,
"expire_date": "2020-07-29 23:59:59",
"product_id": 2111,
"product_title": "Giftery Card",
"order_id": 1234567,
"shop_id": 8901234,
"main_image": {
"small": "https://cdn.giftery.ru/340x155/upload/iblock/4af/4af4b0a61c95083f35e807500b18b60f.jpg",
"medium": "https://cdn.giftery.ru/680x310/upload/iblock/4af/4af4b0a61c95083f35e807500b18b60f.jpg",
"large": "https://cdn.giftery.ru/1360x620/upload/iblock/4af/4af4b0a61c95083f35e807500b18b60f.jpg"
},
"balance": 1000,
"remaining_number_of_uses": 5,
"total_number_of_uses": 7,
"status": "ok",
"recipient_email": "demo@test.ru",
"order_info": {
"order_id": 767276,
"shop_id": 653162,
"date": "2019-01-24 12:48:05",
"redeem_info": [
{
"id": 501,
"title": "ТайРай",
"face": 2000,
"date": "2021-01-01 11:00:10",
"main_image": {
"small": "https://cdn.giftery.ru/340x155/upload/iblock/527/5275bb7a191fc80d93a8f6c71208c6cc.png",
"medium": "https://cdn.giftery.ru/680x310/upload/iblock/527/5275bb7a191fc80d93a8f6c71208c6cc.png",
"large": "https://cdn.giftery.ru/1360x620/upload/iblock/527/5275bb7a191fc80d93a8f6c71208c6cc.png"
}
},
{
"id": 2087,
"title": "Green Mama",
"face": 2000,
"date": "2021-01-10 11:10:01",
"main_image": {
"small": "https://cdn.giftery.ru/340x155/upload/iblock/64c/64c61fd95b2cc129a8c65d0cbfb8c07c.png",
"medium": "https://cdn.giftery.ru/680x310/upload/iblock/64c/64c61fd95b2cc129a8c65d0cbfb8c07c.png",
"large": "https://cdn.giftery.ru/1360x620/upload/iblock/64c/64c61fd95b2cc129a8c65d0cbfb8c07c.png"
}
}
]
},
"multibrand": {
"id": 2111,
"region": "ru",
"title": "Giftery Card",
"description": "Giftery Card – это универсальная электронная подарочная карта...",
"disclaimer": "<ol>\r\n<li>Универсальный подарочный сертификат «Giftery Card» необходимо обменять через Сайт...</ol>",
"image": "https://st.giftery.ru/products/upload/iblock/870/870be12e4e50d167006024225115e51d.jpg",
"main_image": {
"small": "https://cdn.giftery.ru/340x155/upload/iblock/4af/4af4b0a61c95083f35e807500b18b60f.jpg",
"medium": "https://cdn.giftery.ru/680x310/upload/iblock/4af/4af4b0a61c95083f35e807500b18b60f.jpg",
"large": "https://cdn.giftery.ru/1360x620/upload/iblock/4af/4af4b0a61c95083f35e807500b18b60f.jpg"
},
"exchange_1to1": false
},
"products": {
"501": {
"id": 501,
"title": "ТайРай",
"image": "https://st.giftery.ru/products/upload/iblock/4b3/4b39680bc8d7972f26e619019009a6d2.jpg",
"main_image": {
"small": "https://cdn.giftery.ru/340x155/upload/iblock/527/5275bb7a191fc80d93a8f6c71208c6cc.png",
"medium": "https://cdn.giftery.ru/680x310/upload/iblock/527/5275bb7a191fc80d93a8f6c71208c6cc.png",
"large": "https://cdn.giftery.ru/1360x620/upload/iblock/527/5275bb7a191fc80d93a8f6c71208c6cc.png"
},
"description": "<p>В cалонах тайского массажа...",
"disclaimer": "<ol>\r\n<li>Электронный подарочный сертификат...",
"faces": [
{
"value": 0,
"label": "0"
},
{
"value": 1000,
"label": "1000"
},
{
"value": 1500,
"label": "1500"
},
{
"value": 2000,
"label": "2000"
},
{
"value": 3000,
"label": "3000"
},
{
"value": 4000,
"label": "4000"
},
{
"value": 5000,
"label": "5000"
}
],
"face_min": 1000,
"face_max": 75000,
"face_step": 100,
"is_predefined_cert": false,
"remaining": [],
"categories": [
32,
78
],
"sort": 2703
},
"705": {
"id": 705,
"title": "Детский мир",
"image": "https://st.giftery.ru/products/upload/iblock/502/5025f5438292c73d7152b3bb408b069f.jpg",
"main_image": {
"small": "https://cdn.giftery.ru/340x155/upload/iblock/3bd/3bd1b5392271ae230462095959ebbcc7.jpg",
"medium": "https://cdn.giftery.ru/680x310/upload/iblock/3bd/3bd1b5392271ae230462095959ebbcc7.jpg",
"large": "https://cdn.giftery.ru/1360x620/upload/iblock/3bd/3bd1b5392271ae230462095959ebbcc7.jpg"
},
"description": "Сеть магазинов «Детский мир»...",
"disclaimer": "<p>Вы стали обладателем Подарочного...",
"faces": [
{
"value": 300,
"label": "300"
},
{
"value": 500,
"label": "500"
},
{
"value": 750,
"label": "750"
},
{
"value": 1000,
"label": "1000"
},
{
"value": 1500,
"label": "1500"
},
{
"value": 2000,
"label": "2000"
},
{
"value": 3000,
"label": "3000"
},
{
"value": 5000,
"label": "5000"
}
],
"face_min": 300,
"face_max": 5000,
"face_step": 1,
"is_predefined_cert": true,
"remaining": {
"300": 10,
"500": 10,
"750": 10,
"1000": 10,
"1500": 10,
"2000": 10,
"3000": 10,
"5000": 10
},
"categories": [
49,
71
],
"sort": 301
},
"11697": {
"id": 11697,
"title": "Мегого \"Оптимальная\"",
"image": "https://st.giftery.ru/products/upload/iblock/584/584c6e7cc0b65180ae0e2f30c252b102.jpg",
"main_image": {
"small": "https://cdn.giftery.ru/340x155/upload/iblock/db6/db6eaf0235d8a7a5f6d55f2c7bebc9a6.png",
"medium": "https://cdn.giftery.ru/680x310/upload/iblock/db6/db6eaf0235d8a7a5f6d55f2c7bebc9a6.png",
"large": "https://cdn.giftery.ru/1360x620/upload/iblock/db6/db6eaf0235d8a7a5f6d55f2c7bebc9a6.png"
},
"description": "MEGOGO - первый легальный видеосервис...",
"disclaimer": "<ol>\r\n<li>Сертификат Мегого действует...",
"faces": [
{
"value": 337,
"label": "Кино и ТВ: Оптимальная 1 мес"
},
{
"value": 1011,
"label": "Кино и ТВ: Оптимальная 3 мес"
}
],
"face_min": 337,
"face_max": 1011,
"face_step": 1,
"is_predefined_cert": true,
"remaining": {
"337": 10,
"1011": 10
},
"categories": [
44,
77
],
"sort": 500
},
"12952": {
"id": 12952,
"title": "Blizzard Battle.net",
"image": "https://st.giftery.ru/products/upload/iblock/5d4/5d4310a734f8c9eef5567346d562dc34.jpg",
"main_image": {
"small": "https://cdn.giftery.ru/340x155/upload/iblock/d45/d4583810c31cad480a56992b58177816.jpg",
"medium": "https://cdn.giftery.ru/680x310/upload/iblock/d45/d4583810c31cad480a56992b58177816.jpg",
"large": "https://cdn.giftery.ru/1360x620/upload/iblock/d45/d4583810c31cad480a56992b58177816.jpg"
},
"description": "Пополните кошелек Battle.net®...",
"disclaimer": "<p><b>КАК ЭТО РАБОТАЕТ?</b></p>\r\n<p>1. Зайдите на сайт...",
"faces": [
{
"value": 500,
"label": "Blizzard Battle.net Digital Code 500 RUB RU"
},
{
"value": 1000,
"label": "Blizzard Battle.net Digital Code 1000 RUB RU"
},
{
"value": 1500,
"label": "Blizzard Battle.net Digital Code 1500 RUB RU"
},
{
"value": 2000,
"label": "Blizzard Battle.net Digital Code 2000 RUB RU"
}
],
"face_min": 500,
"face_max": 2000,
"face_step": 500,
"is_predefined_cert": false,
"remaining": [],
"categories": [
79
],
"sort": 300
}
},
"categories": [
{
"id": 80,
"title": "Новинки",
"code": "new",
"sort": 50
},
{
"id": 71,
"title": "Популярные",
"code": "popular",
"sort": 100
},
{
"id": 49,
"title": "Детские товары",
"code": "kids",
"sort": 500
},
{
"id": 32,
"title": "Красота и здоровье",
"code": "spa",
"sort": 600
},
{
"id": 42,
"title": "Книги",
"code": "books",
"sort": 900
},
{
"id": 44,
"title": "Развлечения",
"code": "hobby",
"sort": 1200
},
{
"id": 48,
"title": "Рестораны",
"code": "cafe",
"sort": 1400
}
]
}Примеры ошибочных ответов
Ниже перечислены ошибочные варианты ответов при вызове метода check.
В случае, если на Giftery API произошла ошибка при проверке сертификата
JSON
{
"certificate": {
"code": "99999999999999",
"pin": "9999"
},
"error": true,
"message": "Получен неверный ответ сервера. Попробуйте позже."
}Сертификат не найден
JSON
{
"certificate": {
"code": "99999999999999",
"pin": "9999"
},
"error": true,
"message": "Сертификат не найден"
}Неверный номер или ПИН
JSON
{
"certificate": {
"code": "99999999999999",
"pin": "9999"
},
"error": true,
"message": "Неверный номер или ПИН",
"status": "ok"
}Сертификат не является мультибрендовым
Такая ошибка происходит, если, например, попытаться обменять сертификат какого-то ритейлера.
JSON
{
"certificate": {
"code": "99999999999999",
"pin": "9999"
},
"error": true,
"message": "Сертификат не является мультибрендовым",
"status": "ok"
}Срок действия сертификата истек
JSON
{
"certificate": {
"code": "99999999999999",
"pin": "9999"
},
"error": true,
"message": "Срок действия сертификата истек",
"product_id": 2111,
"product_title": "Giftery Card",
"status": "ok"
}Сертификат уже был использован
В данном случае дополнительно возвращается информация о заказе, дате обмена и то, на какие бренды был обменян сертификат (см. OrderInfo).
JSON
{
"certificate": {
"code": "99999999999999",
"pin": "9999"
},
"error": true,
"order_info": {
"order_id": 767276,
"shop_id": 653162,
"date": "2019-01-24 12:48:05",
"redeem_info": [
{
"id": 2101,
"title": "М.Видео",
"face": 3000
},
{
"id": 705,
"title": "Детский Мир",
"face": 2000
}
]
},
"message": "Сертификат уже был использован",
"product_id": 2111,
"product_title": "Giftery Card",
"status": "ok"
}