Алғашқы қадамдар

Платформа API

API арқылы жүйелеріңіз басқару панелін ашпай-ақ аккаунтыңыздағы теледидарларды, файлдарды және ойнату тізімдерін сұрай алады. Оны теледидарлардың күйін өз мониторинг жүйеңізде көрсету, әр экранда не көрсетіліп жатқанын тексеру немесе есептер жасау үшін пайдаланыңыз.

Әр кілт өз пайдаланушысы басқару панелінде көретін нәрсені дәл солай көреді: сол ұйымдарды және әр ұйымда пайдаланушының рұқсаттары тізімдеуге мүмкіндік беретін элементтерді.

Тек оқу үшін

Бұл нұсқада API тек деректерді оқиды. Аккаунтыңызда ештеңе өзгертілмейді.

Басқару панеліндегідей қолжетімділік

Басқару панелінде алынып тасталған рұқсат API үшін де бірден күшіне енеді.

HTTPS арқылы JSON

Жауаптар JSON форматында, күндер уақыт белдеуі көрсетілген ISO 8601 форматында беріледі.

Жауап форматы

Жауаптар JSON (UTF-8) форматында беріледі. Жалғыз элемент data ішінде келеді; тізімдерде сондай-ақ беттеу мәліметтері бар meta болады.
Күндер уақыт белдеуімен бірге ISO 8601 форматында беріледі, мысалы: 2026-11-03T14:32:10-03:00.
Әр элементтің басқару панеліндегімен бірдей uid идентификаторы бар. Элементті кейін сұрау үшін осыны пайдаланыңыз.
Мәні жоқ өріс null болып келеді. Жаңа өрістер кез келген уақытта қосылуы мүмкін, сондықтан өзіңізге белгісіз өрістерді елемеңіз.

Осы жерден бастаңыз

1Аутентификация: Менің аккаунтым › API бөлімінде кілт жасап, оны X-API-Key тақырыбында жіберіңіз.
2Сіздің пайдаланушыңыз: кілтті тексеру үшін алғашқы сұранысты жіберіңіз.
3Әр пайдаланушы нені көре алады: кілт қандай ұйымдар мен элементтерді сұрай алатынын қараңыз.

Негізгі URL

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

Нені сұрауға болады

/meпайдаланушыңыз және қолданылып жатқан кілт
/organizationsұйымдар мен рұқсаттар
/tvsтеледидарлар және олардың күйі
/filesжүктелген файлдар
/playlistsойнату тізімдері және олардың элементтері

Алғашқы сұраныс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();

Жауап200

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