Организация технического взаимодействия

CardsMobile Check-In Service

Взаимодействие с хостом CardsMobile осуществляется через API, как показано на рисунке ниже:

Check-In Service: организация технического взаимодействия

Авторизация запросов к API

Провайдером API-интерфейсов "CardsMobile Place Info API" и "CardsMobile Check-In API" выступает хост CardsMobile. Для авторизации запросов используется HTTP Basic Authentication.

При подключении партнеру передаются параметры, необходимые для интеграции с хостом CardsMobile:

Параметры

Описание

host:port

Адрес и порт хоста CardsMobile, предоставляющего API. Отличается для "CardsMobile Place Info API" и "CardsMobile Check-In API".

login:password

Имя пользователя и пароль, необходимые для авторизации на хосте CardsMobile.

offerId

Идентификатор партнерской программы лояльности в системе CardsMobile; обязателен для указания в заголовках запросов к API.

Требования к кодировкам

Как в запросах, так и в ответах используется кодировка UTF-8.

Коды ответов API

В случае успешного выполнения запроса со стороны хоста CardsMobile будет возвращен тип данных, описанный в документации запроса, и HTTP-код 200.

В случае ошибки обработки бизнес-сценария запроса (например, не найден ID чек-ина) будет возвращен HTTP-код 422 и строковое сообщение с описанием причины ошибки на русском языке в кодировке UTF-8.