Unuaj paŝoj
API de la platformo
Per la API, viaj sistemoj povas konsulti la televidilojn, dosierojn kaj ludlistojn de via konto sen malfermi la kontrolpanelon. Uzu ĝin por montri la staton de la televidiloj en via monitora sistemo, kontroli kio aperas sur ĉiu ekrano aŭ krei raportojn.
Ĉiu ŝlosilo vidas ekzakte tion, kion ĝia uzanto vidas en la kontrolpanelo: la samajn organizaĵojn kaj, en ĉiu organizaĵo, tion, kion la permesoj de tiu uzanto permesas listigi.
Nur legado
En ĉi tiu versio, la API nur konsultas datumojn. Nenio ŝanĝiĝas en via konto.
Sama aliro kiel en la kontrolpanelo
Permeso forigita en la kontrolpanelo tuj validas ankaŭ por la API.
JSON per HTTPS
Respondoj en JSON kaj datoj laŭ ISO 8601 kun horzono.
Formato de la respondoj
- La respondoj estas en JSON (UTF-8). Unuopa ero venas en
data; listoj ankaŭ enhavasmeta, kun la paĝigo. - La datoj estas laŭ ISO 8601 kun la horzono, ekzemple
2026-11-03T14:32:10-03:00. - Ĉiu ero havas
uid, la saman uzatan en la kontrolpanelo. Uzu ĝin por poste konsulti la eron. - Kampo sen valoro venas kiel
null. Novaj kampoj povas esti aldonitaj iam ajn, do ignoru tiujn, kiujn vi ne konas.
Komencu ĉi tie
- 1Aŭtentigo: generu ŝlosilon en Mia konto › API kaj sendu ĝin en la kaplinio
X-API-Key. - 2Via uzanto: faru la unuan peton por testi la ŝlosilon.
- 3Kion ĉiu uzanto povas vidi: vidu, kiujn organizaĵojn kaj erojn la ŝlosilo povas konsulti.
Baza adreso
https://api.on-cloud.live/v1
Kion vi povas konsulti
/mevia uzanto kaj la uzata ŝlosilo/organizationsorganizaĵoj kaj permesoj/tvstelevidiloj kaj ilia stato/filesalŝutitaj dosieroj/playlistsludlistoj kaj iliaj eroj
Unua peto
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();Respondo200
{
"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"
}
}
}