Check-In API v1.0.0
Warning
Сервис выведен из эксплуатации.
API для георегистрации мобильных карт лояльности.
Общие сведения
Руководство предназначено для компаний-партнёров ООО «Бесконтакт», выпускающих карты лояльности своих клиентов в мобильном приложении «Кошелёк».
Check-In API реализует сценарий географической регистрации (check-in) мобильной карты лояльности клиента при её предъявлении в точке обслуживания торгово-сервисной сети партнёра.
Подключение
Провайдером API выступает узел платформы Кошелька. Партнёру передаются следующие параметры для подключения к API:
| Параметр | Описание |
|---|---|
| host:port | Адрес и порт узла платформы Кошелька, предоставляющего API. |
| login:password | Имя пользователя и пароль для авторизации API-запросов. |
| offerId | Идентификатор партнёрской программы лояльности в системе Кошелька; обязателен для указания в заголовках запросов к API. |
Авторизация
Взаимодействие осуществляется по протоколу HTTPS. Для авторизации запросов необходимо использовать HTTP Basic Authentication (RFC 7617). Данные для авторизации запросов передаются в заголовке Authorization.
Кодировки
Как в запросах, так и в ответах используется кодировка UTF-8.
Коды HTTP
В случае успешного выполнения запроса со стороны узла платформы Кошелька будет возвращён HTTP-ответ с кодом 200, содержащий в теле ответа данные, описанные в документации запроса.
В случае ошибки обработки бизнес-сценария запроса (например, не найден ID чек-ина) будет возвращён HTTP-ответ с кодом 422, содержащий JSON-объект с описанием возникшей ошибки. В частности этот объект содержит строковое сообщение с описанием причины ошибки на русском языке (в кодировке UTF-8).