Darba sākšana

Platformas API

Ar API jūsu sistēmas var iegūt datus par jūsu konta TV, failiem un atskaņošanas sarakstiem, neatverot vadības paneli. Izmantojiet to, lai rādītu TV statusu savā uzraudzības sistēmā, pārbaudītu, kas tiek rādīts katrā ekrānā, vai veidotu pārskatus.

Katra atslēga redz tieši to pašu, ko tās lietotājs redz vadības panelī: tās pašas organizācijas un katrā organizācijā to, ko lietotāja atļaujas ļauj uzskaitīt.

Tikai lasīšanai

Šajā versijā API datus tikai nolasa. Jūsu kontā nekas netiek mainīts.

Tāda pati piekļuve kā vadības panelī

Vadības panelī atņemta atļauja uzreiz attiecas arī uz API.

JSON, izmantojot HTTPS

Atbildes JSON formātā, datumi ISO 8601 formātā ar laika joslu.

Atbilžu formāts

Atbildes ir JSON formātā (UTF-8). Viens vienums tiek atgriezts laukā data; sarakstos ir arī meta ar lapošanas informāciju.
Datumi tiek norādīti ISO 8601 formātā ar laika joslu, piemēram, 2026-11-03T14:32:10-03:00.
Katram vienumam ir uid — tas pats, ko izmanto vadības panelī. Izmantojiet to, lai vēlāk iegūtu šo vienumu.
Lauks bez vērtības tiek atgriezts kā null. Jebkurā brīdī var tikt pievienoti jauni lauki, tāpēc ignorējiet tos, kurus nepazīstat.

Sāciet šeit

1Autentifikācija: izveidojiet atslēgu sadaļā Mans konts › API un sūtiet to galvenē X-API-Key.
2Jūsu lietotājs: nosūtiet pirmo pieprasījumu, lai pārbaudītu atslēgu.
3Ko katrs lietotājs var redzēt: uzziniet, kuras organizācijas un vienumus atslēga var skatīt.

Bāzes URL

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

Ko var iegūt

/mejūsu lietotājs un izmantotā atslēga
/organizationsorganizācijas un atļaujas
/tvsTV un to statuss
/filesaugšupielādētie faili
/playlistsatskaņošanas saraksti un to vienumi

Pirmais pieprasījumscURLPHPJavaScript

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

Atbilde200

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