צעדים ראשונים

ה-API של הפלטפורמה

בעזרת ה-API, המערכות שלך יכולות לקרוא את הטלוויזיות, הקבצים והפלייליסטים בחשבון שלך בלי לפתוח את לוח הבקרה. אפשר להשתמש בו כדי להציג את סטטוס הטלוויזיות במערכת הניטור שלך, לבדוק מה מוצג בכל מסך או להפיק דוחות.

כל מפתח רואה בדיוק את מה שהמשתמש שלו רואה בלוח הבקרה: אותם ארגונים, ובכל ארגון את מה שההרשאות של המשתמש מאפשרות לו להציג ברשימה.

פורמט התגובות

• התגובות הן ב-JSON (UTF-8). פריט בודד מגיע ב-data; רשימות כוללות גם את meta, עם נתוני העימוד.
• התאריכים בתקן ISO 8601 כולל אזור הזמן, למשל 2026-11-03T14:32:10-03:00.
• לכל פריט יש uid, זהה לזה שמשמש בלוח הבקרה. אפשר להשתמש בו כדי לשלוף את הפריט מאוחר יותר.
• שדה ללא ערך מגיע כ-null. שדות חדשים עשויים להתווסף בכל עת, ולכן יש להתעלם משדות לא מוכרים.

מתחילים כאן

1. 1אימות: יש ליצור מפתח תחת החשבון שלי › API ולשלוח אותו בכותרת X-API-Key.
2. 2המשתמש שלך: יש לשלוח בקשה ראשונה כדי לבדוק את המפתח.
3. 3מה כל משתמש יכול לראות: כאן רואים לאילו ארגונים ופריטים המפתח יכול לגשת.

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

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