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

Store API

Документация перемещена

Информация на этой странице не обновляется и может быть устаревшей. Наиболее полная и актуальная версия документации для разработчиков доступна по новому адресу:

https://developers.koshelek.app

Провайдером API выступает сервер Кошелька. Потребителями API выступают узлы ЦОД ТСП.

Параметры подключения

Партнёру (ТСП) передаются следующие параметры для подключения к Store API:

Параметр	Описание
Login	Имя пользователя для авторизации запросов API.
Password	Пароль для авторизации запросов API.
API Base URL	URL для подключения к API: https://api.koshelek.app/<partner-name>

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

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

Данные для авторизации запросов передаются в заголовке Authorization в виде Basic <BASE64STRING>, где <BASE64STRING> — это строка вида login:password, закодированная в base64.

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

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

Формат и структура сообщений

Все методы API ожидают тип данных в заголовке: Content-Type: application/json и возвращают тело ответа в формате "application/json".

Коды HTTP

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