시작하기

플랫폼 API

API를 사용하면 관리 패널을 열지 않고도 연동된 시스템에서 계정의 TV, 파일, 재생목록을 조회할 수 있습니다. 자체 모니터링 시스템에 TV 상태를 표시하거나, 각 화면에서 재생 중인 콘텐츠를 확인하거나, 보고서를 만드는 데 활용하세요.

각 키는 해당 키를 소유한 사용자가 관리 패널에서 보는 것과 정확히 같은 범위를 조회합니다. 즉, 같은 회사를 대상으로 하며 각 회사에서는 그 사용자의 권한으로 목록을 볼 수 있는 항목만 조회합니다.

응답 형식

• 응답은 JSON(UTF-8) 형식입니다. 단일 항목은 data에 담기며, 목록에는 페이지 정보가 담긴 meta도 포함됩니다.
• 날짜는 2026-11-03T14:32:10-03:00처럼 시간대가 포함된 ISO 8601 형식입니다.
• 모든 항목에는 관리 패널에서 사용하는 것과 같은 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"
    }
  }
}