Подключение к API

Требования для подключения партнера

Провайдером API выступает узел Cardsmobile. Партнеру передаются следующие параметры для подключения к API:

Параметры

Описание

host:port

Адрес и порт узла Cardsmobile, предоставляющего API.

login:password

Имя пользователя и пароль для авторизации API-запросов.

offerId

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

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

Взаимодействие осуществляется по протоколу HTTPS. Для авторизации запросов необходимо использовать HTTP Basic Authentication (RFC 7617). Данные для авторизации запросов передаются в заголовке "Authorization".

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

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

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

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

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