入門指南

各用戶可查看的內容

金鑰可查看的內容，與其用戶在控制台看到的完全相同。毋須在 API 作任何設定：規則來自該用戶的公司及權限。

只限用戶所屬的公司

API 只會考慮與用戶連結的公司，即該用戶在控制台可選擇的公司。

管理員可查看公司的所有內容

公司或主公司的管理員，可查看該公司所有電視、檔案及播放清單。

其他用戶視乎權限而定

其他用戶則按其在每間公司查看電視、檔案及播放清單的權限而定，即在控制台開放這些頁面的同一組權限。

變更即時生效

在控制台移除權限、移除公司或停用用戶後，由下一個請求起即時生效。

不會顯示的內容

沒有權限的公司的項目不會出現在列表中。直接請求其中任何一個項目，會傳回 404，就像該項目不存在一樣。
在播放清單中，用戶無權查看的檔案會以 file 為 null 的方式傳回。播放清單的電視及檔案所屬的播放清單，只會顯示用戶可查看的部分。
已刪除的項目及尚未啟用的電視不會顯示。

如想知道某個金鑰可查詢哪些內容，請呼叫 /organizations：每間公司都會附有 admin 及 permissions。

如你的系統只需要部分資料，請在控制台為它另外建立一個用戶，只授予所需權限，並在該用戶的帳戶產生金鑰。

請求cURLPHPJavaScript

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

回應200

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

其他公司的項目404

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