Първи стъпки

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. 1Удостоверяване: създайте ключ в Моят акаунт › API и го изпращайте в заглавката X-API-Key.
  2. 2Вашият потребител: направете първата заявка, за да проверите ключа.
  3. 3Какво вижда всеки потребител: вижте до кои организации и обекти има достъп ключът.

Базов адрес

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

Какво можете да четете

  • /meвашият потребител и използваният ключ
  • /organizationsорганизации и права
  • /tvsтелевизори и тяхното състояние
  • /filesкачени файлове
  • /playlistsплейлисти и техните елементи
Първа заявка
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"
    }
  }
}