Prvi koraci

Šta koji korisnik vidi

Ključ vidi tačno ono što njegov korisnik vidi na kontrolnoj ploči. U API-ju ne treba ništa podešavati: pravila potiču iz organizacija i dozvola korisnika.

Samo organizacije korisnika

API uzima u obzir samo organizacije povezane s korisnikom, iste one koje može odabrati na kontrolnoj ploči.

Administrator vidi sve u organizaciji

Administrator organizacije, ili glavne organizacije, vidi sve njene TV uređaje, datoteke i playliste.

Ostali zavise od dozvola

Za ostale korisnike u svakoj organizaciji važe dozvole za pregled TV uređaja, datoteka i playlista, iste one koje otključavaju te stranice na kontrolnoj ploči.

Izmjene važe odmah

Uklonjena dozvola, uklonjena organizacija ili deaktiviran korisnik na kontrolnoj ploči važe već od sljedećeg zahtjeva.

Šta ostaje izvan odgovora

Stavke organizacija bez dozvole ne pojavljuju se u listama. Direktan zahtjev za neku od njih vraća 404, kao da ne postoji.
U playlisti, datoteka koju korisnik ne može vidjeti stiže s file jednakim null. TV uređaji neke playliste i playliste neke datoteke prikazuju samo ono što korisnik može vidjeti.
Izbrisane stavke i TV uređaji koji još nisu aktivirani ne pojavljuju se.

Da saznate šta ključ može čitati, pozovite /organizations: svaka organizacija stiže s admin i permissions.

Ako vašem sistemu treba samo dio podataka, kreirajte na kontrolnoj ploči zasebnog korisnika za njega, samo s potrebnim dozvolama, a ključ kreirajte na računu tog korisnika.

ZahtjevcURLPHPJavaScript

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

Stavka druge organizacije404

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