Dechrau arni

API y platfform

Gyda'r API, gall eich systemau ddarllen y setiau teledu, y ffeiliau a'r rhestrau chwarae yn eich cyfrif heb agor y Panel Rheoli. Defnyddiwch yr API i ddangos statws y setiau teledu yn eich system fonitro, i wirio beth sy'n chwarae ar bob sgrin neu i greu adroddiadau.

Mae pob allwedd yn gweld yn union yr hyn y mae ei defnyddiwr yn ei weld yn y Panel Rheoli: yr un sefydliadau ac, ym mhob sefydliad, yr hyn y mae caniatâd y defnyddiwr hwnnw yn caniatáu iddo ei restru.

Darllen yn unig

Yn y fersiwn hon, dim ond darllen data y mae'r API yn ei wneud. Does dim byd yn eich cyfrif yn cael ei newid.

Yr un mynediad â'r Panel Rheoli

Pan fydd caniatâd yn cael ei dynnu'n ôl yn y Panel Rheoli, mae'n berthnasol i'r API ar unwaith.

JSON dros HTTPS

Ymatebion JSON, gyda dyddiadau yn ISO 8601 gan gynnwys y gylchfa amser.

Fformat yr ymatebion

Mae'r ymatebion yn JSON (UTF-8). Daw eitem unigol yn data; mae rhestrau hefyd yn cynnwys meta, gyda'r tudaleniad.
Mae dyddiadau'n defnyddio ISO 8601 gyda'r gylchfa amser, fel 2026-11-03T14:32:10-03:00.
Mae gan bob eitem uid, yr un a ddefnyddir yn y Panel Rheoli. Defnyddiwch ef i nôl yr eitem yn nes ymlaen.
Mae maes heb werth yn dod fel null. Gall meysydd newydd gael eu hychwanegu ar unrhyw adeg, felly anwybyddwch y rhai nad ydych yn eu hadnabod.

Dechreuwch yma

1Dilysu: cynhyrchwch allwedd yn Fy Nghyfrif › API a'i hanfon yn y pennyn X-API-Key.
2Eich defnyddiwr: gwnewch eich cais cyntaf i brofi'r allwedd.
3Beth all pob defnyddiwr ei weld: gwelwch pa sefydliadau ac eitemau y gall yr allwedd eu darllen.

URL sylfaenol

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

Beth allwch chi ei ddarllen

/meeich defnyddiwr a'r allwedd sy'n cael ei defnyddio
/organizationssefydliadau a chaniatâd
/tvssetiau teledu a'u statws
/filesffeiliau a lanlwythwyd
/playlistsrhestrau chwarae a'u heitemau

Cais cyntafcURLPHPJavaScript

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

Ymateb200

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