Запросы API

Для управления промо-акциями

get
Получение списка существующих акций

https://api.cardsmobile.ru/promo/v1/all
Получение информации о созданных промо-акциях партнёра.
Request
Response
Request
Body Parameters
limit
optional
number
Количество выводимых элементов. Максимальное значение: 100. По умолчанию возвращается 15 последних промо-акций.
offset
optional
number
Количество пропускаемых элементов списка. По умолчанию: 0.
activeOnly
optional
boolean
true: получить список только активных акций. false: получить полный список акций, включая завершенные и запланированные. По умолчанию обрабатывается как false.
Response
200: OK
Запрос успешно обработан Cardsmobile. В теле ответа — JSON-объект, содержащий список промо-акций партнера:
HTTP: 200
HTTP: 200
{
"metadata": {
"limit": 15,
"offset": 0,
"totalCount": 2,
"activeOnly": false
},
"items": [
{
"promoId": 1010,
"name": "Скидки ПО-ЧЁРНОМУ!",
"startDate": "2020-09-01T00:00:00+03",
"endDate": "2020-09-10T00:00:00+03",
"status": "active"
},
{
"promoId": 977,
"name": "Встречайте товар недели!",
"startDate": "2020-08-20T15:00:00+03",
"endDate": "2020-08-27T21:00:00+03",
"status": "completed"
}
]
}
400: Bad Request
Неверный формат запроса. Ответ содержит описание ошибки:
HTTP: 400
HTTP: 400
{
"code": "REQUEST_PARAMS_ERROR",
"details": "Invalid request parameters format"
}

Параметры ответа:

Параметр

Тип

Значение

metadata

Object

Объект метаданных, в котором возвращаются указанные в запросе значения фильтров и ограничений, а также значение общего количества записей.

metadata.limit

Number

Количество выводимых элементов списка.

metadata.offset

Number

Количество пропускаемых элементов списка.

metadata.totalCount

Number

Общее количество записей.

metadata.activeOnly

Boolean

true: вывести только активные акции.

false: вывести все акции.

items

Array

Массив объектов Item, содержащих сведения об акциях. Описание объекта Item см. в разделе Объекты API.

get
Получение информации об акции по идентификатору

https://api.cardsmobile.ru/promo/v1/details?promoId={id}
Получение полной информации по выбранной акции.
Request
Response
Request
Query Parameters
promoId
required
number
Уникальный идентификатор акции, присвоенный узлом Cardsmobile при создании акции.
Response
200: OK
Запрос успешно обработан Cardsmobile. В теле ответа — JSON-объект, содержащий подробную информацию о запрашиваемой промо-акции:
HTTP: 200
HTTP: 200
{
"promoId": 1010,
"name": "Скидки ПО-ЧЁРНОМУ!",
"startDate": "2020-09-01T00:00:00+03",
"endDate": "2020-09-10T00:00:00+03",
"status": "active",
"images": {
"imageWide": "https://promo.partner.ru/wide.jpg",
"imageSquare": "https://promo.partner.ru/square.jpg"
},
"description": "<p>Чёрная пятница уже здесь и громит цены!</p>\n<p>Самое время найти свою скидку и устроить шоппинг ПО-ЧЁРНОМУ!</p>\n<p><a href=\"https://www.partner.ru/promo/black-friday/?utm_source=crm&utm_medium=wallet&utm_content=promo&utm_campaign=261119_bf_wallet_w48\">Подробнее об акции</a></p>",
"discount": "10",
"source": "api"
}
400: Bad Request
Неверный форма запроса. Ответ содержит описание ошибки:
HTTP: 400
HTTP: 400
HTTP: 400
{
"code": "NO_EXPECTED_PARAMETERS",
"details": "No expected parameters in the request"
}
HTTP: 400
{
"code": "DATABASE_CONNECTION_ERROR",
"details": "Error connecting to database"
}
422: Unprocessable Entity
Ошибка обработки бизнес-сценария. Ответ содержит описание ошибки:
HTTP: 422
HTTP: 422
{
"code": "PROMOID_NOT_FOUND",
"details": "promoId not found"
}

Тело запроса пустое.

Параметры ответа:

Параметр

Тип

Значение

promoId

Number

Уникальный идентификатор акции.

name

String

Наименование акции.

startDate

String

Дата начала акции в формате YYYY-MM-DDTHH:MM:SS+00.

endDate

String

Дата окончания акции в формате YYYY-MM-DDTHH:MM:SS+00.

null — бессрочная акция (актуально для source = rmc).

status

String

Статус акции, рассчитанный исходя из срока ее действия:

active — активная акция;

completed — завершенная акция;

planned — запланированная акция.

images

Object

Графические изображения акции для отображения на экране предъявления карты в Кошельке.

images.imageWide

String

Гиперссылка на файл с большим изображением предложения акции (1080×420 пикселей).

images.imageSquare

String

Гиперссылка на файл с малым изображением предложения акции (600×600 пикселей).

description

String

Текстовое описание предложения в разметке HTML для отображения в каталоге Кошелька.

discount

Number

Размер скидки по акции. Отображается в качестве ярлыка на изображении предложения.

0 — нет скидки по акции.

source

String

Источник загрузки данных акции в Кошелёк:

api — источником является Promo API.

rmc — источником является Личный кабинет ритейлера.

post
​Создание новой акции

https://api.cardsmobile.ru/promo/v1/create
Создание новой промо-акции.
Request
Response
Request
Body Parameters
name
required
string
Наименование акции (до 255 символов).
startDate
required
string
Дата начала акции в формате YYYY-MM-DDTHH:MM:SS+00.
endDate
required
string
Дата окончания акции в формате YYYY-MM-DDTHH:MM:SS+00.
images
required
object
Графические изображения акции для отображения на экране предъявления карты в Кошельке.
images.imageWide
required
string
Гиперссылка (до 1024 символов) на файл с большим изображением предложения (1080×420 пикселей).
images.imageSquare
required
string
Гиперссылка (до 1024 символов) на файл с малым изображением предложения (600×600 пикселей).
description
required
string
Текстовое описание предложения для отображения в каталоге Кошелька (до 10 000 символов в разметке HTML). Поддерживаемые HTML-теги: <a> <b> <br> <i> <ol>, <li> <ul>, <li> <p> <s> <u>
discount
optional
number
Размер скидки по акции (целое число от 1 до 100). Отображается в качестве ярлыка на изображении предложения. Если скидки нет, параметр не передается или передается значение 0.
Response
200: OK
Запрос успешно обработан Cardsmobile. В теле ответа — JSON-объект, содержащий идентификатор и текущий статус созданной промо-акции:
HTTP: 200
HTTP: 200
{
"promoId": 1020,
"status": "planned"
}
400: Bad Request
Неверный формат запроса. Ответ содержит описание ошибки:
HTTP: 400
HTTP: 400
HTTP: 400
HTTP: 400
{
"code": "JSON_VALIDATION_ERROR",
"details": "Invalid JSON request format"
}
HTTP: 400
{
"code": "IMAGE_VALIDATION_ERROR",
"details": "Image validation error"
}
HTTP: 400
{
"code": "DATA_VALIDATION_ERROR",
"details": "Data validation error"
}

Параметры ответа:

Параметр

Тип

Значение

promoId

Number

Уникальный идентификатор акции.

status

String

Статус акции, рассчитанный исходя из срока ее действия:

active — активная акция;

completed — завершенная акция;

planned — запланированная акция.

post
Обновление данных существующей акции

https://api.cardsmobile.ru/promo/v1/update
Обновление данных созданной промо-акции.
Request
Response
Request
Body Parameters
promoId
required
number
Уникальный идентификатор акции (выдается узлом Cardsmobile при создании акции и не может быть обновлен).
name
required
string
Наименование акции (до 255 символов).
startDate
required
string
Дата начала акции в формате YYYY-MM-DDTHH:MM:SS+00.
endDate
required
string
Дата окончания акции в формате YYYY-MM-DDTHH:MM:SS+00.
images
required
object
Графические изображения акции для отображения на экране предъявления карты в Кошельке.
images.imageWide
required
string
Гиперссылка (до 1024 символов) на файл с большим прямоугольным изображением предложения (1080×420 пикселей).
images.imageSquare
required
string
Гиперссылка (до 1024 символов) на файл с малым квадратным изображением предложения (600×600 пикселей).
description
required
string
Текстовое описание предложения для отображения в каталоге Кошелька (до 10 000 символов в разметке HTML). Поддерживаемые HTML-теги: <a> <b> <br> <i> <ol>, <li> <ul>, <li> <p> <s> <u>
discount
optional
number
Размер скидки по акции (целое число от 1 до 100). Отображается в качестве ярлыка на изображении предложения. Если скидки нет, параметр не передается или передается значение 0.
Response
200: OK
Запрос успешно обработан Cardsmobile. В теле ответа — JSON-объект, содержащий идентификатор и текущий статус обновленной промо-акции:
HTTP: 200
HTTP: 200
{
"promoId": 1020,
"status": "planned"
}
400: Bad Request
Неверный формат запроса. Ответ содержит описание ошибки:
HTTP: 400
HTTP: 400
HTTP: 400
HTTP: 400
{
"code": "JSON_VALIDATION_ERROR",
"details": "Invalid JSON request format"
}
HTTP: 400
{
"code": "IMAGE_VALIDATION_ERROR",
"details": "Image validation error"
}
HTTP: 400
{
"code": "DATA_VALIDATION_ERROR",
"details": "Data validation error"
}
422: Unprocessable Entity
Ошибка обработки бизнес-сценария. Ответ содержит описание ошибки:
HTTP: 422
HTTP: 422
{
"code": "PROMOID_NOT_FOUND",
"details": "promoId not found"
}

Параметры ответа:

Параметр

Тип

Значение

promoId

Number

Уникальный идентификатор акции.

status

String

Статус акции, рассчитанный исходя из срока ее действия:

active — активная акция;

completed — завершенная акция;

planned — запланированная акция.