Prvi koraki

Kaj vidi posamezni uporabnik

Ključ vidi natanko to, kar njegov uporabnik vidi na nadzorni plošči. V API-ju ni treba ničesar nastavljati: pravila izhajajo iz organizacij in dovoljenj uporabnika.

Samo organizacije uporabnika

API upošteva samo organizacije, povezane z uporabnikom – iste, ki jih lahko izbere na nadzorni plošči.

Administrator vidi vse v organizaciji

Administrator organizacije ali glavne organizacije vidi vse njene televizorje, datoteke in sezname predvajanja.

Za druge so odločilna dovoljenja

Za druge uporabnike v vsaki organizaciji veljajo dovoljenja za ogled televizorjev, datotek in seznamov predvajanja – ista, ki odklenejo te strani na nadzorni plošči.

Spremembe veljajo takoj

Ko na nadzorni plošči odvzamete dovoljenje, odstranite organizacijo ali deaktivirate uporabnika, sprememba velja že pri naslednji zahtevi.

Kaj ni prikazano

Elementi organizacij brez dovoljenja se na seznamih ne prikažejo. Neposredna zahteva za katerega od njih vrne 404, kot da ne bi obstajal.
Na seznamu predvajanja ima datoteka, ki je uporabnik ne more videti, file nastavljen na null. Televizorji seznama predvajanja in seznami predvajanja datoteke prikazujejo samo tisto, kar lahko uporabnik vidi.
Izbrisani elementi in televizorji, ki še niso bili aktivirani, se ne prikažejo.

Če želite izvedeti, kaj lahko ključ bere, pokličite /organizations: vsaka organizacija vsebuje admin in permissions.

Če vaš sistem potrebuje samo del podatkov, na nadzorni plošči ustvarite zanj ločenega uporabnika samo s potrebnimi dovoljenji in ključ ustvarite v računu tega uporabnika.

ZahtevacURLPHPJavaScript

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

Odgovor200

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

Element druge organizacije404

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