Запросы API

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

Документация перемещена

Информация на этой странице не обновляется и может быть устаревшей. Наиболее полная и актуальная версия документации для разработчиков доступна по новому адресу:

https://developers.koshelek.app

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

GET https://<base-URL>/partner/api/place/{placeId}/checkins

Узел партнера запрашивает у Cardsmobile список чек-инов, активных в данный момент, и возвращает актуальный список на экран кассового ПО.

Path Parameters

Name	Type	Description
placeId*	string	Идентификатор точки обслуживания, для которой выполняется запрос

Headers

Name	Type	Description
offerId*	string	Идентификатор программы лояльности партнера в системе Cardsmobile

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

Запрос на погашение активного чек-ина.

Headers

Name	Type	Description
offerId*	string	Идентификатор программы лояльности партнера в системе Cardsmobile

Request Body

Name	Type	Description
checkinNumber*	string	Идентификатор чек-ина

200: OK Запрос обработан. Тело ответа пустое:

422: Unprocessable Entity Ошибка обработки запроса. Ответ содержит описание произошедшей ошибки:

{
   "error": {
      "gsonDiscriminator": "ru.cardsmobile.checkin.sp.partner.ObjectNotFountException",
      "code": "ObjectNotFountException",
      "detailMessage": "Место не найдено",
      "clientMessage": "Место не найдено",
      "reason": "ObjectNotFountException"
   }
}

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

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

{"checkinNumber": 1025}

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