Формат запитів

PreviousСтатистика NextКористувачі сайту

Last updated 19 days ago

Формат запитів

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

Структура запиту

Запити направляються на адресу проекту, наприклад, з дозволених 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