레퍼런스 · 계정

회사

사용자가 접근할 수 있는 회사와, 각 회사에서 API로 조회할 수 있는 항목을 나열합니다. 이 응답은 페이지로 나뉘지 않습니다.

매개변수

이 엔드포인트에는 매개변수가 없습니다.

각 항목의 필드

uid string

회사 식별자. 목록 엔드포인트의 organization 매개변수에 사용하세요.

name string

회사 이름.

neutral_zone boolean

중립 영역 회사이면 true. 중립 영역 회사의 파일과 재생목록은 다른 모든 회사에서 사용할 수 있습니다.

admin boolean

사용자가 해당 회사 또는 기본 회사의 관리자이면 true. 이 경우 사용자는 회사의 모든 항목을 볼 수 있습니다.

permissions object

사용자가 이 회사에서 조회할 수 있는 항목.

permissions.tvs boolean

TV를 볼 수 있으면 true.

permissions.files boolean

파일을 볼 수 있으면 true.

permissions.playlists boolean

재생목록을 볼 수 있으면 true.

발생 가능한 오류

• 키 및 요청 한도 관련 오류는 모든 엔드포인트에 적용됩니다. 모든 오류 보기

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();

{
  "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
      }
    }
  ]
}