Початок роботи

API платформи

Через API ваші системи отримують дані про телевізори, файли й плейлисти вашого облікового запису, не відкриваючи панель керування. Використовуйте його, щоб показувати статус телевізорів у власній системі моніторингу, перевіряти, що відтворюється на кожному екрані, або формувати звіти.

Кожному ключу доступне саме те, що його користувач бачить у панелі керування: ті самі компанії, а в кожній компанії — те, що відкривають йому його дозволи.

Лише читання

У цій версії API лише читає дані. У вашому обліковому записі нічого не змінюється.

Той самий доступ, що й у панелі

Дозвіл, знятий у панелі керування, одразу перестає діяти і в API.

JSON через HTTPS

Відповіді у форматі JSON, дати — в ISO 8601 із часовим поясом.

Формат відповідей

Відповіді надходять у форматі JSON (UTF-8). Окремий об’єкт повертається в data; списки також містять meta з даними пагінації.
Дати передаються у форматі ISO 8601 із часовим поясом, наприклад 2026-11-03T14:32:10-03:00.
Кожен об’єкт має uid — той самий, що використовується в панелі керування. За ним об’єкт можна запросити пізніше.
Поле без значення повертається як null. Нові поля можуть з’явитися будь-коли, тож ігноруйте ті, яких не знаєте.

З чого почати

1Автентифікація: створіть ключ у розділі Мій обліковий запис › API і передавайте його в заголовку X-API-Key.
2Ваш користувач: виконайте перший запит, щоб перевірити ключ.
3Що бачить кожен користувач: дізнайтеся, які компанії та об’єкти доступні ключу.

Базовий URL

https://api.on-cloud.live/v1

Що можна отримати

/meваш користувач і поточний ключ
/organizationsкомпанії та дозволи
/tvsтелевізори та їхній статус
/filesзавантажені файли
/playlistsплейлисти та їхні елементи

Перший запитcURLPHPJavaScript

curl "https://api.on-cloud.live/v1/me" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/me');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/me', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

Відповідь200

{
  "data": {
    "uid": "3c59dc048e8850243be8079a5c74d079",
    "name": "Mariana Souza",
    "email": "mariana@exemplo.com.br",
    "language": "pt_BR",
    "api_key": {
      "name": "Monitoramento",
      "prefix": "apk_527d541b",
      "created_at": "2026-11-01T09:15:42-03:00",
      "last_used_at": "2026-11-03T14:31:58-03:00"
    }
  }
}