Prvi koraki

API platforme

Z API-jem lahko vaši sistemi berejo televizorje, datoteke in sezname predvajanja v vašem računu, ne da bi odprli nadzorno ploščo. Uporabite ga za prikaz stanja televizorjev v svojem nadzornem sistemu, za preverjanje, kaj se predvaja na posameznem zaslonu, ali za pripravo poročil.

Vsak ključ vidi natanko to, kar njegov uporabnik vidi na nadzorni plošči: iste organizacije in v vsaki od njih tisto, kar mu dovoljenja dopuščajo prikazati.

Samo branje

V tej različici API podatke samo bere. V vašem računu se nič ne spremeni.

Enak dostop kot na nadzorni plošči

Dovoljenje, odvzeto na nadzorni plošči, takoj velja tudi za API.

JSON prek HTTPS

Odgovori v obliki JSON, datumi v obliki ISO 8601 s časovnim pasom.

Oblika odgovorov

  • Odgovori so v obliki JSON (UTF-8). Posamezen element je v data; seznami vsebujejo še meta s podatki o ostranjevanju.
  • Datumi so v obliki ISO 8601 s časovnim pasom, na primer 2026-11-03T14:32:10-03:00.
  • Vsak element ima uid, enak kot na nadzorni plošči. Z njim lahko element pozneje pridobite.
  • Polje brez vrednosti ima vrednost null. Nova polja se lahko dodajo kadar koli, zato prezrite tista, ki jih ne poznate.

Začnite tukaj

  1. 1Preverjanje pristnosti: ustvarite ključ v razdelku Moj račun › API in ga pošiljajte v glavi X-API-Key.
  2. 2Vaš uporabnik: pošljite prvo zahtevo in preizkusite ključ.
  3. 3Kaj vidi posamezni uporabnik: preverite, katere organizacije in elemente lahko ključ bere.

Osnovni naslov

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

Kaj lahko berete

  • /mevaš uporabnik in uporabljeni ključ
  • /organizationsorganizacije in dovoljenja
  • /tvstelevizorji in njihovo stanje
  • /filesnaložene datoteke
  • /playlistsseznami predvajanja in njihovi elementi
Prva zahteva
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();
Odgovor200
{
  "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"
    }
  }
}