المرجع · الحساب

المؤسسات

تعرض المؤسسات التي يمكن للمستخدم الوصول إليها، وما يمكنه الاطلاع عليه في كل منها عبر API. هذه الاستجابة غير مقسّمة إلى صفحات.

المعاملات

لا تقبل نقطة النهاية هذه أي معاملات.

حقول كل عنصر

uid string

معرّف المؤسسة. استخدمه في المعامل organization الخاص بالقوائم.

name string

اسم المؤسسة.

neutral_zone boolean

true إذا كانت مؤسسة في المنطقة المحايدة، يمكن لجميع المؤسسات الأخرى استخدام ملفاتها وقوائم تشغيلها.

admin boolean

true إذا كان المستخدم مسؤولًا عن المؤسسة أو عن المؤسسة الرئيسية. وفي هذه الحالة، يرى كل شيء في المؤسسة.

permissions object

ما يمكن للمستخدم الاطلاع عليه في هذه المؤسسة.

permissions.tvs boolean

true إذا كان يستطيع رؤية أجهزة التلفزيون.

permissions.files boolean

true إذا كان يستطيع رؤية الملفات.

permissions.playlists boolean

true إذا كان يستطيع رؤية قوائم التشغيل.

الأخطاء المحتملة

• تنطبق أخطاء المفتاح وحد الطلبات على جميع نقاط النهاية. عرض جميع الأخطاء

curl "https://api.on-cloud.live/v1/organizations" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/organizations');
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/organizations', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

{
  "data": [
    {
      "uid": "8f14e45fceea167a5a36dedd4bea2543",
      "name": "Loja Centro",
      "neutral_zone": false,
      "admin": true,
      "permissions": {
        "tvs": true,
        "files": true,
        "playlists": true
      }
    },
    {
      "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
      "name": "Loja Shopping Norte",
      "neutral_zone": false,
      "admin": true,
      "permissions": {
        "tvs": true,
        "files": true,
        "playlists": true
      }
    }
  ]
}