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

Для запросов ("Клиент - Сервер") используются HTTP GET или HTTP POST (рекомендуется) запросы. Ответы ("Сервер - Клиент") приходят в виде XML или JSON.

Структура запроса

Запросы отправляются на адрес проекта, например https://domain.rezonuniversal.com /api/ с разрешенных IP адресов.

Параметры можно слать как методом GET, так и методом POST. Список параметров, которые должны быть в каждом запросе:

Название параметра

Описание

Значения

key

Ключ доступа

*****

token

Токен доступа

********************************

Тип ответа*

xml / json

lang

Язык ответа

en / ru / ua

IP посетителя сайта

* Тип ответа также можно задать в переменной заголовка запроса Accept: application/json или application/xml соответственно.

Структура ответа

Любой ответ содержит "оболочку", которая определяет статус ответа, и количество данных.

<?xml version="1.0" encoding="utf-16"?>
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <StatusCode>200</StatusCode>
    <Status>OK</Status>
    <Body>
        <RequestID>422ecf71-2b7a-4db1-8046-5abe89919041</RequestID>
        <Data></Data>
        <TotalCount>0</TotalCount>
    </Body>
</Response>

{
   "StatusCode": "200",
   "Status": "OK",
   "Body": {
      "RequestID": "422ecf71-2b7a-4db1-8046-5abe89919041",
      "Data": [],
      "TotalCount": "0"
   }
}

Описание полей ответа

Название параметра

Описание

Дополнительная информация

StatusCode

Статус ответа

200 - Успешно, 400 - Неверный запрос, 401 - Не авторизовано, 500 - Ошибка сервера

Status

Статус в текстовом виде

Body/RequestID

Уникальный UID запроса

Body/Data

Основные данные

Body/TotalCount

Количество данных

Ограничение RPS

На текущий момент все методы API имеют ограничение на 2 RPS (requests per second).

Т.е. за 1 минуту Вы можете выполнить не более 120 запросов.

При превышении данного числа запросов система вернет ошибку 9003 RPS limit violetes

PreviousСтатистика NextПользователи сайта

Last updated 5 years ago