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