Első lépések

A platform API-ja

Az API-val a rendszerei a vezérlőpult megnyitása nélkül kérdezhetik le a fiókjához tartozó TV-ket, fájlokat és lejátszási listákat. Használhatja arra, hogy a TV-k állapotát megjelenítse a saját monitorozó rendszerében, ellenőrizze, mi fut az egyes képernyőkön, vagy jelentéseket készítsen.

Minden kulcs pontosan azt látja, amit a hozzá tartozó felhasználó a vezérlőpulton: ugyanazokat a szervezeteket, és az egyes szervezetekben azt, amit a felhasználó jogosultságai engednek listázni.

Csak olvasás

Ebben a verzióban az API csak lekérdez. A fiókjában semmi sem változik.

Ugyanaz a hozzáférés, mint a vezérlőpulton

A vezérlőpulton megvont jogosultság az API-ban is azonnal érvénybe lép.

JSON HTTPS-en keresztül

JSON-válaszok, a dátumok ISO 8601 formátumban, időzónával.

A válaszok formátuma

A válaszok JSON formátumúak (UTF-8). Egyetlen elem a data mezőben érkezik; a listák a meta mezőt is tartalmazzák, benne a lapozási adatokkal.
A dátumok ISO 8601 formátumúak, időzónával, például 2026-11-03T14:32:10-03:00.
Minden elemnek van egy uid azonosítója, ugyanaz, mint a vezérlőpulton. Ezzel később lekérdezheti az elemet.
Az érték nélküli mezők értéke null. Bármikor kerülhetnek be új mezők, ezért hagyja figyelmen kívül azokat, amelyeket nem ismer.

Kezdje itt

1Hitelesítés: generáljon kulcsot a Saját fiók › API menüpontban, és küldje el az X-API-Key fejlécben.
2Saját felhasználó: küldje el az első kérést, és próbálja ki a kulcsot.
3Mit láthatnak a felhasználók: nézze meg, mely szervezeteket és elemeket kérdezheti le a kulccsal.

Alapcím

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

Mit kérdezhet le

/mea saját felhasználója és a használt kulcs
/organizationsszervezetek és jogosultságok
/tvsTV-k és állapotuk
/filesfeltöltött fájlok
/playlistslejátszási listák és elemeik

Első kéréscURLPHPJavaScript

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

Válasz200

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