İlk addımlar

Platformanın API-si

API sayəsində sistemləriniz idarəetmə panelini açmadan hesabınızdakı TV-ləri, faylları və pleylistləri sorğulaya bilər. Ondan TV-lərin statusunu öz monitorinq sisteminizdə göstərmək, hər ekranda nəyin yayımlandığını yoxlamaq və ya hesabatlar hazırlamaq üçün istifadə edin.

Hər açar onun istifadəçisinin idarəetmə panelində gördüklərini olduğu kimi görür: eyni şirkətləri və hər şirkətdə istifadəçinin icazələrinin siyahıya almağa imkan verdiyi elementləri.

Yalnız oxumaq üçün

Bu versiyada API yalnız məlumatları oxuyur. Hesabınızda heç nə dəyişdirilmir.

İdarəetmə panelindəki kimi giriş

İdarəetmə panelində geri alınan icazə API-yə də dərhal şamil olunur.

HTTPS üzərindən JSON

Cavablar JSON formatında, tarixlər isə saat qurşağı ilə birlikdə ISO 8601 formatındadır.

Cavab formatı

Cavablar JSON (UTF-8) formatındadır. Tək element data daxilində gəlir; siyahılarda səhifələmə məlumatları olan meta da olur.
Tarixlər saat qurşağı ilə birlikdə ISO 8601 formatında gəlir, məsələn: 2026-11-03T14:32:10-03:00.
Hər elementin idarəetmə panelində istifadə olunanla eyni olan uid identifikatoru var. Elementi sonradan sorğulamaq üçün ondan istifadə edin.
Dəyəri olmayan sahə null kimi gəlir. İstənilən vaxt yeni sahələr əlavə oluna bilər, ona görə də tanımadığınız sahələri nəzərə almayın.

Buradan başlayın

1Autentifikasiya: Hesabım › API bölməsində açar yaradın və onu X-API-Key başlığında göndərin.
2İstifadəçiniz: açarı yoxlamaq üçün ilk sorğunu göndərin.
3Hər istifadəçi nəyi görə bilər: açarın hansı şirkətləri və elementləri sorğulaya biləcəyinə baxın.

Əsas URL

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

Nələri sorğulamaq olar

/meistifadəçiniz və istifadə olunan açar
/organizationsşirkətlər və icazələr
/tvsTV-lər və onların statusu
/filesyüklənmiş fayllar
/playlistspleylistlər və onların elementləri

İlk sorğucURLPHPJavaScript

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

Cavab200

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