入門指南

平台 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"
    }
  }
}