Aloitus

Mitä kukin käyttäjä näkee

Avain näkee täsmälleen saman kuin sen käyttäjä ohjauspaneelissa. API:ssa ei tarvitse määrittää mitään: säännöt tulevat käyttäjän organisaatioista ja oikeuksista.

Vain käyttäjän organisaatiot

API ottaa huomioon vain käyttäjään liitetyt organisaatiot, samat, jotka hän voi valita ohjauspaneelissa.

Ylläpitäjä näkee kaiken organisaatiossa

Organisaation tai pääorganisaation ylläpitäjä näkee kaikki sen TV:t, tiedostot ja soittolistat.

Muilla oikeudet ratkaisevat

Muihin käyttäjiin sovelletaan kunkin organisaation oikeuksia nähdä TV:t, tiedostot ja soittolistat – samoja oikeuksia, jotka avaavat nämä sivut ohjauspaneelissa.

Muutokset tulevat voimaan heti

Kun ohjauspaneelissa poistetaan oikeus tai organisaatio tai käyttäjä poistetaan käytöstä, muutos koskee jo seuraavaa pyyntöä.

Mitä ei näytetä

Niiden organisaatioiden kohteet, joihin ei ole oikeutta, eivät näy luetteloissa. Jos tällaista kohdetta pyydetään suoraan, vastaus on 404, ikään kuin sitä ei olisi olemassa.
Soittolistassa tiedostolla, jota käyttäjä ei näe, kentän file arvo on null. Soittolistan TV:t ja tiedoston soittolistat näyttävät vain sen, mitä käyttäjä saa nähdä.
Poistetut kohteet ja TV:t, joita ei ole vielä aktivoitu, eivät näy.

Jos haluat tietää, mitä avaimella voi hakea, kutsu päätepistettä /organizations: jokaisen organisaation mukana tulevat admin ja permissions.

Jos järjestelmäsi tarvitsee vain osan tiedoista, luo sille ohjauspaneelissa oma käyttäjä, jolla on vain tarvittavat oikeudet, ja luo avain tämän käyttäjän tilillä.

PyyntöcURLPHPJavaScript

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

Vastaus200

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

Toisen organisaation kohde404

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