スタートガイド

プラットフォームAPI

APIを使うと、コントロールパネルを開かなくても、お使いのシステムからアカウント内のTV、ファイル、プレイリストを参照できます。自社の監視システムでのTVステータスの表示、各画面で再生中の内容の確認、レポートの作成などにご利用ください。

各キーで参照できる範囲は、そのキーのユーザーがコントロールパネルで見られる範囲とまったく同じです。対象となる組織は同じで、各組織ではそのユーザーの権限で一覧表示できるものだけが含まれます。

レスポンスの形式

• レスポンスは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"
    }
  }
}