Pagsisimula

API ng platform

Sa API, mababasa ng iyong mga system ang mga TV, file at playlist ng iyong account nang hindi binubuksan ang control panel. Gamitin ito para ipakita ang status ng mga TV sa sarili mong monitoring, tingnan kung ano ang ipinapalabas sa bawat screen o gumawa ng mga ulat.

Nakikita ng bawat key ang eksaktong nakikita ng user nito sa control panel: ang parehong mga organisasyon at, sa bawat organisasyon, ang pinapayagan ng kanyang mga pahintulot na mailista.

Pagbasa lang

Sa bersyong ito, nagbabasa lang ang API. Walang binabago sa iyong account.

Parehong access sa control panel

Agad na umiiral sa API ang pahintulot na tinanggal sa control panel.

JSON sa HTTPS

Mga response sa JSON at mga petsa sa ISO 8601 na may time zone.

Format ng mga response

Nasa JSON (UTF-8) ang mga response. Nasa data ang isang item; ang mga listahan ay may kasama ring meta, na naglalaman ng pagination.
Nasa ISO 8601 ang mga petsa, kasama ang time zone, gaya ng 2026-11-03T14:32:10-03:00.
Bawat item ay may uid, ang parehong ginagamit sa control panel. Gamitin ito para makuha ang item sa ibang pagkakataon.
Ang field na walang value ay dumarating bilang null. Maaaring magdagdag ng mga bagong field anumang oras, kaya huwag pansinin ang mga hindi mo kilala.

Magsimula rito

1Pag-authenticate: gumawa ng key sa Aking Account › API at ipadala ito sa header na X-API-Key.
2Ang iyong user: gawin ang unang request para subukan ang key.
3Ano ang nakikita ng bawat user: tingnan kung aling mga organisasyon at item ang mababasa ng key.

Base URL

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

Ano ang mababasa mo

/meang iyong user at ang key na ginagamit
/organizationsmga organisasyon at pahintulot
/tvsmga TV at ang status nila
/filesmga na-upload na file
/playlistsmga playlist at ang mga item nila

Unang requestcURLPHPJavaScript

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

Response200

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