Primii pași

Ce poate vedea fiecare utilizator

Cheia vede exact ce vede utilizatorul ei în panoul de control. Nu trebuie configurat nimic în API: regulile provin din organizațiile și permisiunile utilizatorului.

Doar organizațiile utilizatorului

API-ul ia în considerare doar organizațiile asociate utilizatorului, aceleași pe care le poate alege în panoul de control.

Administratorul vede tot din organizație

Cine este administrator al organizației sau al organizației principale vede toate TV-urile, fișierele și playlisturile acesteia.

Pentru ceilalți contează permisiunile

Pentru ceilalți utilizatori se aplică, în fiecare organizație, permisiunile de a vedea TV-uri, fișiere și playlisturi, aceleași care deblochează paginile respective în panoul de control.

Modificările se aplică imediat

O permisiune retrasă, o organizație eliminată sau un utilizator dezactivat în panoul de control au efect încă de la următoarea cerere.

Ce nu este inclus

Elementele organizațiilor fără permisiune nu apar în liste. Solicitarea directă a unuia dintre ele returnează 404, ca și cum nu ar exista.
Într-un playlist, un fișier pe care utilizatorul nu îl poate vedea vine cu file egal cu null. TV-urile unui playlist și playlisturile unui fișier arată doar ce poate vedea utilizatorul.
Elementele șterse și TV-urile care nu au fost încă activate nu apar.

Pentru a afla ce poate consulta o cheie, apelați /organizations: fiecare organizație vine cu admin și permissions.

Dacă sistemul dumneavoastră are nevoie doar de o parte din date, creați în panoul de control un utilizator dedicat, doar cu permisiunile necesare, și generați cheia în contul acestui utilizator.

CererecURLPHPJavaScript

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

Răspuns200

{
  "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 din altă organizație404

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