參考資料 · 帳戶

公司

GET /v1/organizations

列出用戶可存取的公司，以及在每間公司中可透過 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。

可能出現的錯誤

金鑰錯誤及次數限制錯誤適用於所有端點。查看所有錯誤

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