시작하기

사용자별 조회 범위

키는 해당 키를 소유한 사용자가 관리 패널에서 보는 것과 정확히 같은 범위를 조회합니다. API에서 따로 설정할 필요는 없으며, 규칙은 사용자의 회사와 권한에 따라 정해집니다.

사용자의 회사만 대상

API는 사용자에게 연결된 회사, 즉 관리 패널에서 해당 사용자가 선택할 수 있는 회사만 대상으로 합니다.

관리자는 회사의 모든 항목 조회

회사 또는 기본 회사의 관리자는 해당 회사의 모든 TV, 파일, 재생목록을 볼 수 있습니다.

그 외 사용자는 권한에 따라 결정

다른 사용자에게는 회사별 TV, 파일, 재생목록 보기 권한이 적용됩니다. 관리 패널에서 해당 페이지를 열 수 있게 하는 권한과 같습니다.

변경 사항은 즉시 적용

관리 패널에서 권한을 해제하거나, 사용자에게서 회사를 제외하거나, 사용자를 비활성화하면 바로 다음 요청부터 적용됩니다.

조회되지 않는 항목

권한이 없는 회사의 항목은 목록에 나타나지 않습니다. 이러한 항목을 직접 요청하면 존재하지 않는 것처럼 404가 반환됩니다.
재생목록에서 사용자가 볼 수 없는 파일은 file 값이 null로 반환됩니다. 재생목록의 TV와 파일의 재생목록에는 사용자가 볼 수 있는 항목만 표시됩니다.
삭제된 항목과 아직 활성화되지 않은 TV는 나타나지 않습니다.

키로 조회할 수 있는 항목을 확인하려면 /organizations를 호출하세요. 각 회사와 함께 admin 및 permissions가 반환됩니다.

시스템에 일부 데이터만 필요하다면 관리 패널에서 해당 시스템 전용 사용자를 만들어 필요한 권한만 부여하고, 그 사용자의 계정에서 키를 생성하세요.

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

다른 회사의 항목404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}