快速入门

各用户可查看的内容

密钥能看到的内容与其所属用户在控制面板中看到的完全一致。无需在 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."
  }
}