Отправка запросов на платформу Cardsmobile может быть осуществлена с помощью REST API.
Строка запроса формируется следующим образом: http://<хост>:<порт>/<остальная часть пути>.
https://localhost:28089/v1/card/anonymous
Получение карты по данным клиента
Описание запроса
Для получения карты по данным клиента необходимо выполнить запрос типа GET на URL:
http://<хост>:<порт>/v1/card?msisdn=<номер_телефона>&email=<электронный_адрес>&birthDate=<дата_рождения>
Параметры запроса:
| Наименование | Тип данных | Описание | Примечания |
|---|
| msisdn | строковый | Номер телефона | Обязательный параметр |
| email | строковый | Электронный адрес | Обязательный параметр |
| birthDate | строковый | Дата рождения | Обязательный параметр |
В результате будет получена информация по карте клиента.
В случае, если при получении данных по карте произошла ошибка, в ответе на запрос будет получен статус 422.
Получение карты по номеру (с балансом)
Описание запроса
Для получения карты по данным клиента необходимо выполнить запрос типа GET на URL:
https://<хост>:<порт>/v1/card/<номер карты>
В результате будет получена информация по карте клиента.
Получение покупок по карте
Описание запроса
Для получения карты по данным клиента необходимо выполнить запрос типа GET на URL:
https://<хост>:<порт>/<номер карты>/purchases?startDate=<значение>&endDate=<значение>
Параметры запроса:
| Наименование | Тип данных | Описание | Примечания |
|---|
| startDate | строковый | Дата начала | Обязательный параметр |
| endDate | строковый | Дата окончания |
|
В результате будет получен список покупок по карте за указанный промежуток времени.
Обновление разрешенных каналов связи клиента по номеру карты
Описание запроса
Для получения карты по данным клиента необходимо выполнить запрос типа PUT на URL:
https://<хост>:<порт>/v1/card/<номер_карты>/communication
Тело запроса:
| Наименование | Тип данных | Возможные значения | Описание | Примечания |
|---|
| allow | строковый | | Разрешенные каналы связи | Обязательный параметр. Не указанные в параметре каналы связи будут отключены. |
{
"allow": ["call", "sms", "telegram", "email"]
}
В результате разрешенные каналы связи будут обновлены.
Обновление данных клиента по номеру карты
Описание запроса
Для получения карты по данным клиента необходимо выполнить запрос типа POST на URL:
https://<хост>:<порт>/v1/card/<номер карты>
Тело запроса:
| Наименование | Тип данных | Описание |
|---|
| phone | строковый | Номер телефона |
| email | строковый | Электронный адрес |
| surname | строковый | Фамилия |
| firstname | строковый | Имя |
| sex | строковый | Пол |
| birthDate | строковый | Дата рождения |
{
"phone": "79600000900",
"email": "user@example.com",
"surname": "Петров",
"firstname": "Петр",
"patronymic": "Петрович",
"sex": "м",
"birthDate": "1990-01-01"
}
В результате данные о клиенте будут перезаписаны, с кассового сервера будет получен ID клиента.
Выдача карты на сервисе cardissuance
Описание запроса
Для получения карты по данным клиента необходимо выполнить запрос типа POST на URL:
https://<хост>:<порт>/v1/provided/<номер карты>
Тело запроса:
| Наименование | Тип данных | Описание |
|---|
| phone | строковый | Номер телефона |
| email | строковый | Электронный адрес |
| surname | строковый | Фамилия |
| firstname | строковый | Имя |
| sex | строковый | Пол |
| birthDate | строковый | Дата рождения |
{
"phone": "79600000900",
"email": "user@example.com",
"surname": "Петров",
"firstname": "Петр",
"patronymic": "Петрович",
"sex": "м",
"birthDate": "1990-01-01"
}
В результате клиенту будет выдана карта.
В случае, если произошла ошибка при выдаче карты, в ответе на запрос будет получен статус 422.
Резервирование номера карты на сервисе cardissuance и выдача карты по ранее зарезервированному номеру на сервисе cardissuance
Описание запроса
Для резервирования номера карты по данным клиента необходимо выполнить запрос типа GET на URL:
https://<хост>:<порт>/v1/card/anonymous
В результате будет получен номер карты.
Для получения карты с использованием номера карты, полученного в ответе на первый запрос, необходимо выполнить запрос типа POST на URL:
https://<хост>:<порт>/v1/card/anonymous/<cardNumber>
Тело запроса:
| Наименование | Тип данных | Описание |
|---|
| phone | строковый | Номер телефона |
| email | строковый | Электронный адрес |
| surname | строковый | Фамилия |
| firstname | строковый | Имя |
| sex | строковый | Пол |
| birthDate | строковый | Дата рождения |
{
"phone": "79600000900",
"email": "user@example.com",
"surname": "Петров",
"firstname": "Петр",
"patronymic": "Петрович",
"sex": "м",
"birthDate": "1990-01-01"
}
В результате будет получена карта по ранее зарезервированному номеру.
В случае, если произошла ошибка при выдаче карты по зарезервированному ранее номеру, в ответе на запрос будет получен статус 422.