Запросы API
Для управления промоакциями
Документация перемещена
Информация на этой странице не обновляется и может быть устаревшей. Наиболее полная и актуальная версия документации для разработчиков доступна по новому адресу:
Получение списка существующих акций
GET
https://api.cardsmobile.ru/promo/v1/all
Получение информации о созданных промоакциях партнера.
Request Body
Name | Type | Description |
---|---|---|
limit | number | Количество выводимых элементов. Максимальное значение: |
offset | number | Количество пропускаемых элементов списка. По умолчанию: |
activeOnly | boolean |
|
Параметры ответа:
Параметр | Тип | Обязательно | Значение |
---|---|---|---|
| Object | Да | Объект метаданных, содержащий указанные в запросе значения фильтров и ограничений, а также значение общего количества записей. |
| Number | Да | Количество выводимых элементов списка. |
| Number | Да | Количество пропускаемых элементов списка. |
| Number | Да | Общее количество записей. |
| Boolean | Да |
|
| Array | Да | Массив объектов Item, содержащих сведения об акциях. Описание объекта Item см. в разделе Объекты API. |
Получение информации об акции по идентификатору
GET
https://api.cardsmobile.ru/promo/v1/details?promoId={id}
Получение полной информации по выбранной акции.
Query Parameters
Name | Type | Description |
---|---|---|
promoId* | number | Уникальный идентификатор акции, присвоенный узлом Cardsmobile при создании акции. |
Тело запроса пустое.
Параметры ответа:
Параметр | Тип | Обязательно | Значение |
---|---|---|---|
| Number | Да | Уникальный идентификатор акции. |
| String | Да | Наименование акции. |
| String | Да | Дата начала акции в формате |
| String | Нет | Дата окончания акции в формате
|
| String | Да | Статус акции, рассчитанный исходя из срока ее действия:
|
| Object | Да | Графические изображения акции для отображения на экране предъявления карты в Кошельке. |
| String | Да | Гиперссылка на файл с большим изображением предложения акции (1080×420 пикселей). |
| String | Да | Гиперссылка на файл с малым изображением предложения акции (600×600 пикселей). |
| String | Да | Текстовое описание предложения в разметке HTML для отображения в каталоге Кошелька. |
| Number | Да | Размер скидки по акции. Отображается в качестве ярлыка на изображении предложения.
|
| String | Да | Источник загрузки данных акции в Кошелёк:
|
Создание новой акции
POST
https://api.cardsmobile.ru/promo/v1/create
Создание новой промоакции.
Request Body
Name | Type | Description |
---|---|---|
name* | string | Наименование акции (до 255 символов). |
startDate* | string | Дата начала акции в формате
|
endDate | string | Дата окончания акции в формате
|
images* | object | Графические изображения акции для отображения на экране предъявления карты в Кошельке. |
images.imageWide* | string | Гиперссылка (до 1024 символов) на файл с большим изображением предложения (1080×420 пикселей). |
images.imageSquare* | string | Гиперссылка (до 1024 символов) на файл с малым изображением предложения (600×600 пикселей). |
description* | string | Текстовое описание предложения для отображения в каталоге Кошелька (до 10 000 символов в разметке HTML). Поддерживаемые HTML-теги:
|
discount | number | Размер скидки по акции (целое число от |
Параметры ответа:
Параметр | Тип | Обязательно | Значение |
---|---|---|---|
| Number | Да | Уникальный идентификатор акции. |
| String | Да | Текущий статус акции, рассчитанный исходя из срока ее действия:
|
Обновление данных существующей акции
POST
https://api.cardsmobile.ru/promo/v1/update
Обновление данных созданной промоакции.
Request Body
Name | Type | Description |
---|---|---|
promoId* | number | Уникальный идентификатор акции (выдается узлом Cardsmobile при создании акции и не может быть обновлен). |
name* | string | Наименование акции (до 255 символов). |
startDate* | string | Дата начала акции в формате
|
endDate | string | Дата окончания акции в формате
|
images* | object | Графические изображения акции для отображения на экране предъявления карты в Кошельке. |
images.imageWide* | string | Гиперссылка (до 1024 символов) на файл с большим прямоугольным изображением предложения (1080×420 пикселей). |
images.imageSquare* | string | Гиперссылка (до 1024 символов) на файл с малым квадратным изображением предложения (600×600 пикселей). |
description* | string | Текстовое описание предложения для отображения в каталоге Кошелька (до 10 000 символов в разметке HTML). Поддерживаемые HTML-теги:
|
discount | number | Размер скидки по акции (целое число от |
Параметры ответа:
Параметр | Тип | Обязательно | Значение |
---|---|---|---|
| Number | Да | Уникальный идентификатор акции. |
| String | Да | Статус акции, рассчитанный исходя из срока ее действия:
|
Last updated