Сценарии обработки запросов

Old Dashboard принимает HTTP POST запросы, данные передаются в формате JSON.

Все запросы обрабатываются синхронно, HTTP-ответ на запрос содержит требуемую информацию.

Базовые URL

Основным URL для запросов является https://data.ecommpay.com.

Запросы выполняются посредством протокола HTTP 1.1 с использованием TLS 1.2.

Формат запроса в Old Dashboard

Каждый запрос отправляется на отдельный URL. URL и параметры запросов приведены в Data API.

Версия запроса указывается в URL запроса. Например, запрос на получение баланса будет выглядеть следующим образом:

v1/balance/get

Ограничения на значения в параметрах приведены в запросах в Data API.

Каждый запрос подписывается для обеспечения безопасности данных. Подробнее см. в Работа с подписью к данным.

Формат ответа Old Dashboard

На каждый запрос, независимо от способа его обработки, Old Dashboard синхронно отправляет HTTP POST ответ. Данные передаются в теле ответа в формате JSON.

Old Dashboard использует HTTP-коды для обозначения успешности или неуспешности запроса. В общем случае код 200 показывает, что запрос успешен, коды в 4xx диапазоне указывают на ошибку в предоставленных данных (например, в запросе не был передан обязательный параметр), а код 500 указывает на сбой в Old Dashboard.

Прим.: В отдельных случаях набор параметров может быть изменен без предварительного уведомления; ваша система должна проигнорировать добавленные параметры.

Используемые HTTP-коды ответов

Табл. 1.
Коды HTTP-ответов Описание
200 OK Запрос успешно выполнен. В теле запроса выводится непосредственно запрошенная информация.
400 Bad Request Запрос не может быть выполнен из-за ошибки валидации данных: не переданы обязательные параметры или ошибка подписи. В теле ответа приводятся статус получения запроса (error) и уточненные данные об ошибке.
401 Authorization Required Неправильные данные для авторизации. В теле ответа приводятся статус получения запроса (error) и уточненные данные об ошибке.
500 Internal Error Запрос не может быть выполнен из-за ошибки сервера. В теле ответа приводятся статус получения запроса (error) и уточненные данные об ошибке.

Ошибки

Если возникшую ошибку возможно обработать и определить, то Old Dashboard вернет сообщение об ошибке в теле ответа.

Параметр Описание
name Фиксированное значение error
code Код HTTP-заголовка
message Уточненное сообщение об ошибке (если возможно)
status Фиксированное значение false