Запросы API

Запросы при чек-ине посетителя в точке обслуживания

get
Запрос списка активных чек-инов

https://<base-URL>/partner/api/place/{placeId}/checkins
Узел партнера запрашивает у Cardsmobile список чек-инов, активных в данный момент, и возвращает актуальный список на экран кассового ПО.
Request
Response
Request
Path Parameters
placeId
required
string
Идентификатор точки обслуживания, для которой выполняется запрос
Headers
offerId
required
string
Идентификатор программы лояльности партнера в системе CardsMobile
Response
200: OK
Ответ содержит массив текущих активных чек-инов и соответствующих им карт лояльности:
[
{
"secretCode": "5533",
"checkinNumber": 1024,
"cardNumber": "000000111001"
},
{
"secretCode": "8387",
"checkinNumber": 1025,
"cardNumber": "000000111002"
},
{
"secretCode": "0022",
"checkinNumber": 1026,
"cardNumber": "000000111003"
}
]
422: Unprocessable Entity
Ответ содержит описание произошедшей ошибки:
{
"error": {
"gsonDiscriminator": "ru.cardsmobile.checkin.sp.partner.ObjectNotFountException",
"code": "ObjectNotFountException",
"detailMessage": "Место не найдено",
"clientMessage": "Место не найдено",
"reason": "ObjectNotFountException"
}
}

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

Параметр

Тип

Значение

secretCode

String

Секретный код чек-ина (4 цифры)

checkinNumber

String

Идентификатор чек-ина

cardNumber

String

Номер карты лояльности в информационной системе партнера

post
Регистрация использованного чек-ина

https://<base-URL>/partner/api/checkin/register
Запрос на погашение активного чек-ина.
Request
Response
Request
Headers
offerId
required
string
Идентификатор программы лояльности партнера в системе Cardsmobile
Body Parameters
checkinNumber
required
string
Идентификатор чек-ина
Response
200: OK
Тело ответа пустое:
422: Unprocessable Entity
Ответ содержит описание произошедшей ошибки:
{
"error": {
"gsonDiscriminator": "ru.cardsmobile.checkin.sp.partner.ObjectNotFountException",
"code": "ObjectNotFountException",
"detailMessage": "Место не найдено",
"clientMessage": "Место не найдено",
"reason": "ObjectNotFountException"
}
}

При добавлении к заказу карты лояльности, прошедшей чек-ин, кассовое ПО партнера должно инициировать деактивацию чек-ина; запрос на деактивацию должен быть передан на узел Cardsmobile.

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

{"checkinNumber": 1025}

После деактивации чек-ин будет отсутствовать в списке, получаемом в ответ на Запрос списка активных чек-инов. Чтобы совершить очередную покупку (заказ) с картой лояльности, пользователю потребуется выполнить новый чек-ин.