快速入门

平台 API

借助 API，您的系统无需打开控制面板即可查询账户中的电视、文件和播放列表。您可以用它在自己的监控系统中显示电视状态、核对每块屏幕正在播放的内容，或生成报表。

每个密钥能看到的内容与其所属用户在控制面板中看到的完全一致：相同的组织，以及在每个组织中该用户的权限允许列出的内容。

响应格式

• 响应为 JSON（UTF-8）格式。单个项目位于 data 中；列表还会包含存放分页信息的 meta。
• 日期采用带时区的 ISO 8601 格式，例如 2026-11-03T14:32:10-03:00。
• 每个项目都有一个 uid，与控制面板中使用的相同。之后可以用它查询该项目。
• 没有值的字段返回 null。我们可能随时新增字段，请忽略您不认识的字段。

从这里开始

1. 1身份验证: 在我的账户 › API 中生成密钥，并通过 X-API-Key 请求头发送。
2. 2当前用户: 发送第一个请求，测试密钥是否可用。
3. 3各用户可查看的内容: 了解该密钥可以查询哪些组织和项目。

curl "https://api.on-cloud.live/v1/me" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/me');
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/me', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

{
  "data": {
    "uid": "3c59dc048e8850243be8079a5c74d079",
    "name": "Mariana Souza",
    "email": "mariana@exemplo.com.br",
    "language": "pt_BR",
    "api_key": {
      "name": "Monitoramento",
      "prefix": "apk_527d541b",
      "created_at": "2026-11-01T09:15:42-03:00",
      "last_used_at": "2026-11-03T14:31:58-03:00"
    }
  }
}