Начало работы

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"
    }
  }
}