Метод getProducts
Описание
Получение списка продуктов, доступных для заказа на текущий момент. Стоит учесть, что происходит регулярное обновление каталога, могут изменятся любые поля кроме "id".
Обратите внимание!
Мы рекомендуем обновлять список продуктов раз в час в том случае, если вы не будете выполнять проверку доступности номиналов перед каждым выполнением makeOrder. Это позволит свести к минимуму случаи, когда у нас нет в наличии кодов нужного номинала некоторых брендов (в таком случае номиналы удаляются из параметра faces), а вы со своей стороны продолжаете делать запросы на эти номиналы по имеющимся у вас устаревшим данным. Каталог Giftery не является статичным. Ситуация по доступности номиналов может меняться несколько раз в день. Доступность конкретных продуктов для заказа может быть выключена вцелом в отдельных особых случаях.
Параметры запроса (data)
Нет
Параметры ответа (data)
Возвращается список доступных клиенту продуктов, каждый элемент списка имеет следующую структуру:
| Параметр | Описание |
|---|---|
| id | ID продукта в системе |
| title | Название продукта |
| url | Ссылка на страницу продукта |
| brief | Краткое описание товара и/или бренда (может содержать html-теги) |
| categories | Список идентификаторов категорий, к которым принадлежит продукт. См. метод getCategories |
| faces | Массив доступных номиналов типа number. Номинал 0 значит "гибкий номинал", т.е. возможен заказ любого номинала в диапазоне между face_min и face_max включительно (например 559) |
| face_min | Минимальное значение для случая гибкого номинала |
| face_max | Максимальное значение для случая гибкого номинала |
| face_step | Для продуктов с "гибким номиналом" в faces. Номинал сертификата должен быть кратным face_step. |
| faces_description | Массив, где ключи это номинал (число в формате строки), а значение - краткое описание номинала |
| main_image | Структура со ссылками на несколько форматов картинок для отображения в каталогах. На текущий момент содержит три элемента: small, medium, large. |
| image_url | Deprecated. Ссылка на изображение продукта. Не рекомендуется использовать. В будущем будет удалено. |
| disclaimer | html-текст с условиями использования (дисклеймер) |
| digital_acceptance | Может ли продукт быть принят в торговой точке в виде пары код/пин (или по штрихкоду) без распечатанного сертификата. Может принимать значения: no (партнёр принимает только распечатанный сертификат), any (партнёр может принять пару код/пин (или штрихкод) в торговой точке и в интернет-магазине), eshop (партнёр может принять пару код/пин только в интернет-магазине), offline (партнёр может принять пару код/пин только в торговой точке), exchange (специальный признак Giftery Card - универсальной подарочной карты Giftery). |
| supplier_id | Идентификатор поставщика продукта |
| is_predefined_cert | Продукт работает на загружаемых (сгенерированных заранее) кодах |
| is_merchant_cert | Продукт работает на кодах поставщика (получаемых от поставщика) |
| face_multiplier | Значение установленной клиентской скидки/наценки на номинал сертификата, где значения меньше 1 будут скидками (0.95), а значения больше 1 будут наценками (1.05). С баланса клиента будет списано номинал * face_multiplier. Возможно округление в бОльшую/меньшую сторону. |
| www | Сайт продукта |
| certificates_in_one_purchase | Количество сертификатов в одной покупке (число или null) |
| catalog_comment | Комментарий для каталога |
| activation_delay | Задержка в рабочих днях между покупкой сертификата и возможностью его использования в магазине |
| number_of_uses | Количество использований сертификата в торговой точке (магазине, сайте или приложении) в числовом формате |
Пример
bash
# Получаем значение для подстановки SIG
# SECRET в данном случае - это хранящийся у клиента ключ для подписи запросов к API
$ echo -n 'getProducts[]SECRET' | sha256sum - | awk '{print $1}'
# Используем известный клиенту ID и сгенерированный SIG для выполнения запроса
$ curl 'https://ssl-api.giftery.ru/?cmd=getProducts&id=ID&in=json&out=json&data=%5B%5D&sig=SIG'Результат запроса:
JSON
{
"status": "ok",
"data": [
{
"id": "2111",
"title": "Giftery Card",
"url": "https://www.giftery.ru/giftcards/gifterycard",
"brief": "Мультибрендовый подарочный сертификат \"Giftery Card\" дает максимальную свободу выбора...",
"categories": [
29
],
"faces": [
0,
2000,
3000,
5000,
10000
],
"face_step": 1,
"face_min": "1",
"face_max": "30000",
"faces_description": {
"1000": "500 миль",
"2000": "1000 миль"
},
"digital_acceptance": "any",
"disclaimer": "<ol><li>Мультибрендовый подарочный сертификат «Giftery Card» необходимо обменять...",
"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"
}
}
]
}