Első lépések

Mit láthatnak a felhasználók

A kulcs pontosan azt látja, amit a hozzá tartozó felhasználó a vezérlőpulton. Az API-ban semmit sem kell beállítani: a szabályok a felhasználó szervezeteiből és jogosultságaiból következnek.

Csak a felhasználó szervezetei

Az API csak a felhasználóhoz kapcsolt szervezeteket veszi figyelembe, ugyanazokat, amelyeket a vezérlőpulton kiválaszthat.

Az adminisztrátor mindent lát a szervezetben

A szervezet vagy a fő szervezet adminisztrátora a szervezet összes TV-jét, fájlját és lejátszási listáját látja.

A többiek a jogosultságaiktól függnek

A többi felhasználóra szervezetenként a TV-k, fájlok és lejátszási listák megtekintésére vonatkozó jogosultságok érvényesek – ugyanazok, amelyek a vezérlőpulton ezeket az oldalakat elérhetővé teszik.

A változások azonnal érvénybe lépnek

Ha a vezérlőpulton megvonnak egy jogosultságot, eltávolítanak egy szervezetet vagy inaktiválnak egy felhasználót, az már a következő kérésnél érvényes.

Ami kimarad

Azoknak a szervezeteknek az elemei, amelyekhez nincs jogosultság, nem jelennek meg a listákban. Ha közvetlenül kér le egyet közülük, 404 a válasz, mintha nem is létezne.
Egy lejátszási listában az a fájl, amelyet a felhasználó nem láthat, null értékű file mezővel érkezik. A lejátszási lista TV-i és a fájl lejátszási listái csak azt mutatják, amit a felhasználó láthat.
A törölt elemek és a még nem aktivált TV-k nem jelennek meg.

Ha tudni szeretné, mit kérdezhet le egy kulcs, hívja meg a /organizations végpontot: minden szervezet admin és permissions mezővel érkezik.

Ha a rendszerének csak az adatok egy részére van szüksége, hozzon létre neki külön felhasználót a vezérlőpulton, csak a szükséges jogosultságokkal, és ennek a felhasználónak a fiókjában generálja a kulcsot.

KéréscURLPHPJavaScript

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

Válasz200

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

Másik szervezet eleme404

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