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

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

Модель взаимодействия

Promo API использует модель REST, данные передаются в виде объектов JSON.

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

Провайдером Promo API выступает узел платформы Кошелька. Партнёру передаются следующие параметры для подключения к API:

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

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

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

Все методы API ожидают в заголовке запроса:

Content-type ="application/json;charset=utf-8"

Требования к формату изображений

Ожидаемый формат изображений: JPG или PNG. Требования к разрешению изображений приведены в описаниях запросов API.

Коды HTTP

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

В случае ошибки обработки запроса будет возвращен один из HTTP-кодов с описанием ошибки в теле ответа в формате JSON:

Формат тела ошибки

В случае получения одного из допустимых 4XX HTTP-кодов в ответ на запрос, в теле ошибки будет передан объект JSON, содержащий поля code и details:

{
  "code": string, //Код ошибки. Не равен HTTP-коду. Осмысленное значение в формате UPPER_SNAKE_CASE.
  "details": string //Описание ошибки на английском языке. Не предназначено для отображения конечному пользователю.
}