Дополнительные сценарии

Cardsmobile Loyalty API

Методы, описываемые ниже, не обязательны для реализации. Необходимость их использования оговаривается с Cardsmobile на этапе согласования сценариев.

get
Запрос списка номеров телефонов пользователей, к которым применяются особые условия программы лояльности

https://<base-url>/v1/card/getAllUsers
Запрос возвращает список номеров телефонов зарегистрированных пользователей, сформированный партнером с учетом специальных условий.
Request
Response
200: OK
Возвращается в случае успешной обработки запроса. Тело ответа содержит массив номеров телефонов для всех существующих и активных клиентов лояльности, удовлетворяющих заданному критерию, либо пустой массив, если клиентов не найдено:
А. Список пользователей
Б. Пользователи не найдены
[
"79000123456", //Номер телефона без +
"79000123457"
]
[]
422: Unprocessable Entity
Возвращается в случае любой ошибки обработки запроса. Тело ответа содержит сведения (код и описание) о произошедшей ошибке:
{
"code": "123",
"description": "Недоступен сервер баз данных"
}

Пример запроса:

GET /v1/card/getAllUsers

Критерии формирования списка номеров

Формирование списка номеров телефонов должно определяться внутренней бизнес-логикой партнера. Например, это может быть список номеров клиентов, для которых разрешен выпуск внутренней «корпоративной карты сотрудника», дающей особые привилегии в рамках программы лояльности.

get
Запрос расширенного списка пользователей, к которым применяются особые условия программы лояльности

https://<base-url>/v1/card/getAllUsersExtended
Запрос возвращает список номеров телефонов и дополнительных параметров (если есть), сформированный партнером с учетом специальных условий.
Request
Response
200: OK
Возвращается в случае успешной обработки запроса. Тело ответа содержит массив номеров телефонов и дополнительных параметров (если есть) для всех существующих и активных клиентов лояльности, удовлетворяющих заданному критерию, либо пустой массив, если клиентов не найдено:
А. Пользователи найдены
Б. Пользователи не найдены
[
{
"phone": "79000123456", //Номер телефона без +
"params": [ //Доп. параметры (если есть)
{
"name": "", //Имя параметра
"value": "" //Значение параметра
}
]
}
]
[]
422: Unprocessable Entity
Возвращается в случае любой ошибки обработки запроса. Тело ответа содержит сведения (код и описание) о произошедшей ошибке:
{
"code": "123",
"description": "Недоступен сервер баз данных"
}

Пример запроса:

GET /v1/card/getAllUsersExtended

Критерии формирования списка

Аналогично предыдущему запросу.