Довідник · Обліковий запис

Компанії

Повертає компанії, до яких користувач має доступ, і для кожної — що він може отримувати через API. Ця відповідь не розбивається на сторінки.

Параметри

Цей ендпоінт не приймає параметрів.

Поля кожного об’єкта

uid string

Ідентифікатор компанії. Використовуйте його в параметрі organization списків.

name string

Назва компанії.

neutral_zone boolean

true, якщо це компанія нейтральної зони: її файли й плейлисти можуть використовувати всі інші компанії.

admin boolean

true, якщо користувач — адміністратор компанії або основної компанії. У такому разі він бачить у компанії все.

permissions object

Що користувач може отримувати в цій компанії.

permissions.tvs boolean

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