الخطوات الأولى

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