Формат запиту/відповіді ​

Взаємодія з сервісом завжди відбувається в форматі JSON в кодуванні UTF-8.

Запит має вклювати наступні Headers:

Content-Type: application/json
Content-Length: <довжина запиту>
X-Api-Key: <ваш API-KEY>

Content-Type: application/json
Content-Length: <довжина запиту>
X-Api-Key: <ваш API-KEY>

Відповідь буде включати наступні Headers:

Content-Type: application/json; charset=utf-8
WWW-Authenticate: <ваш API-KEY>

Content-Type: application/json; charset=utf-8
WWW-Authenticate: <ваш API-KEY>

Всі запити завжди повертають код 200 OK, навіть якщо сталися логічні помилки.

Якщо не надано ключ API або він невірний - повертається 401 Unauthorized.

Інші коди відповіді свідчать про помилики на мережевому рівні.

Формат відповіді для об'єкту: ​

{
    "success": true|false,
    "data": {
        // object
    },
    errors: [
        "error1", "error2"
    ]
 }

{
    "success": true|false,
    "data": {
        // object
    },
    errors: [
        "error1", "error2"
    ]
 }

де:

• success - запит виконано успішно
• data - якщо success = true, відповідний обєкт або масив
• errors - якщо success = false, масив помилок

Формат відповіді для масиву: ​

{
    "success": true|false,
    "count": 1,
    "data": [
        // array
    ],
    errors: [
        "error1", "error2"
    ]
 }

{
    "success": true|false,
    "count": 1,
    "data": [
        // array
    ],
    errors: [
        "error1", "error2"
    ]
 }

де:

• success - запит виконано успішно
• count - загальна кількість записів
• data - якщо success = true, відповідний обєкт або масив
• errors - якщо success = false, масив помилок