Pradžia

Platformos API

API leidžia jūsų sistemoms gauti jūsų paskyros televizorių, failų ir grojaraščių duomenis neatidarant valdymo skydelio. Naudokite API televizorių būsenai rodyti savo stebėsenos sistemoje, tikrinti, kas rodoma kiekviename ekrane, ar rengti ataskaitas.

Kiekvienas raktas mato lygiai tą patį, ką jo naudotojas mato valdymo skydelyje: tas pačias organizacijas ir kiekvienoje organizacijoje tai, ką leidžia matyti naudotojo teisės.

Tik skaitymas

Šioje versijoje API duomenis tik skaito. Jūsų paskyroje niekas nekeičiama.

Ta pati prieiga kaip valdymo skydelyje

Valdymo skydelyje atimta teisė iš karto galioja ir API.

JSON per HTTPS

Atsakymai pateikiami JSON formatu, datos – ISO 8601 formatu su laiko juosta.

Atsakymų formatas

Atsakymai pateikiami JSON formatu (UTF-8). Vienas elementas grąžinamas lauke data; sąrašuose taip pat yra meta su puslapiavimo informacija.
Datos pateikiamos ISO 8601 formatu su laiko juosta, pavyzdžiui, 2026-11-03T14:32:10-03:00.
Kiekvienas elementas turi uid – tą patį, kuris naudojamas valdymo skydelyje. Naudokite jį, kai vėliau norėsite gauti šį elementą.
Laukas be reikšmės grąžinamas kaip null. Nauji laukai gali būti pridėti bet kada, todėl nepaisykite tų, kurių nežinote.

Pradėkite čia

1Autentifikavimas: sukurkite raktą skiltyje Mano paskyra › API ir siųskite jį antraštėje X-API-Key.
2Jūsų naudotojas: atlikite pirmąją užklausą ir patikrinkite raktą.
3Ką gali matyti kiekvienas naudotojas: sužinokite, kurias organizacijas ir elementus raktas gali matyti.

Bazinis URL

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

Ką galima gauti

/mejūsų naudotojas ir naudojamas raktas
/organizationsorganizacijos ir teisės
/tvstelevizoriai ir jų būsena
/filesįkelti failai
/playlistsgrojaraščiai ir jų elementai

Pirmoji užklausacURLPHPJavaScript

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();

Atsakymas200

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