Store API v1.0.0
API для управления информацией о торговых точках, подключённых к Koshelek Pay.
Общие сведения
Руководство предназначено для торгово-сервисных предприятий (ТСП), использующих Кошелёк Pay API для оплаты товаров и услуг на кассе.
Store API предназначен для управления данными о торговых точках (магазинах) ТСП, принимающих оплату через Кошелёк Pay: добавление (регистрация) информации о новых магазинах, получение и обновление информации о зарегистрированных магазинах.
Подключение к API
Провайдером API выступает сервер Кошелька. Потребителями API являются узлы ЦОД ТСП. Партнёру передаются следующие параметры для подключения к Store API:
| Параметр | Описание |
|---|---|
| Login | Имя пользователя и пароль для авторизации запросов API. |
| Password | Пароль для авторизации запросов API. |
| API Base URL | URL для подключения к API: https://api.koshelek.app/ |
Авторизация
Взаимодействие осуществляется по протоколу HTTPS. Для авторизации запросов к Store API необходимо использовать HTTP Basic Authentication (RFC 7617). Данные для авторизации запросов передаются в HTTP-заголовке Authorization в виде Basic <BASE64STRING>, где <BASE64STRING> — это строка вида login:password, закодированная в base64.
Кодировки
Как в запросах, так и в ответах используется кодировка UTF-8.
Формат и структура сообщений
Все методы API ожидают тип данных в заголовке: Content-Type = application/json и возвращают тело ответа в формате application/json.
Коды HTTP
В случае успешной обработки запроса, со стороны узла Кошелька будет возвращён тип данных, описанный в документации запроса, и HTTP-код 200.