เริ่มต้นใช้งาน

ผู้ใช้แต่ละคนเห็นอะไรได้บ้าง

คีย์เห็นข้อมูลเดียวกับที่ผู้ใช้เจ้าของคีย์เห็นในแผงควบคุมทุกประการ ไม่ต้องตั้งค่าใด ๆ ใน API: กฎทั้งหมดมาจากองค์กรและสิทธิ์ของผู้ใช้

สิ่งที่ไม่แสดง

• รายการขององค์กรที่ไม่มีสิทธิ์จะไม่ปรากฏในการแสดงรายการ การขอรายการเหล่านั้นโดยตรงจะได้ 404 เหมือนกับว่าไม่มีรายการนั้นอยู่
• ในเพลย์ลิสต์ ไฟล์ที่ผู้ใช้ไม่มีสิทธิ์ดูจะมี file เป็น null ทีวีของเพลย์ลิสต์และเพลย์ลิสต์ของไฟล์จะแสดงเฉพาะสิ่งที่ผู้ใช้มีสิทธิ์ดู
• รายการที่ถูกลบและทีวีที่ยังไม่ได้เปิดใช้งานจะไม่ปรากฏ

หากต้องการทราบว่าคีย์ดึงข้อมูลอะไรได้บ้าง ให้เรียก /organizations: แต่ละองค์กรจะมี admin และ permissions มาด้วย

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

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}