参考 · 账户

组织

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