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