Aloitus

Alustan API

API:n avulla järjestelmäsi voivat hakea tilisi TV:t, tiedostot ja soittolistat avaamatta ohjauspaneelia. Voit esimerkiksi näyttää TV:iden tilan omassa valvontajärjestelmässäsi, tarkistaa, mitä kullakin näytöllä toistetaan, tai koota raportteja.

Jokainen avain näkee täsmälleen saman kuin sen käyttäjä ohjauspaneelissa: samat organisaatiot ja kussakin organisaatiossa sen, mitä käyttäjän oikeudet sallivat listata.

Vain luku

Tässä versiossa API vain hakee tietoja. Tiliisi ei tehdä muutoksia.

Samat oikeudet kuin ohjauspaneelissa

Ohjauspaneelissa poistettu oikeus koskee heti myös API:a.

JSON HTTPS:n kautta

Vastaukset JSON-muodossa ja päivämäärät ISO 8601 -muodossa aikavyöhykkeineen.

Vastausten muoto

Vastaukset ovat JSON-muotoisia (UTF-8). Yksittäinen kohde palautetaan kentässä data; luetteloissa on lisäksi kenttä meta, jossa ovat sivutustiedot.
Päivämäärät ovat ISO 8601 -muodossa aikavyöhykkeen kanssa, esimerkiksi 2026-11-03T14:32:10-03:00.
Jokaisella kohteella on uid, sama kuin ohjauspaneelissa. Sen avulla voit hakea kohteen myöhemmin.
Jos kentällä ei ole arvoa, sen arvo on null. Uusia kenttiä voidaan lisätä milloin tahansa, joten ohita kentät, joita et tunne.

Aloita tästä

1Todennus: luo avain kohdassa Oma tili › API ja lähetä se otsakkeessa X-API-Key.
2Käyttäjäsi: tee ensimmäinen pyyntö ja testaa avain.
3Mitä kukin käyttäjä näkee: katso, mitä organisaatioita ja kohteita avaimella voi hakea.

Perusosoite

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

Mitä voit hakea

/mekäyttäjäsi ja käytössä oleva avain
/organizationsorganisaatiot ja oikeudet
/tvsTV:t ja niiden tila
/filesladatut tiedostot
/playlistssoittolistat ja niiden kohteet

Ensimmäinen pyyntö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();

Vastaus200

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