Primers passos

Què pot veure cada usuari

La clau veu exactament el mateix que veu al tauler l'usuari a qui pertany. No cal configurar res a l'API: les regles provenen de les organitzacions i dels permisos de l'usuari.

Només les organitzacions de l'usuari

L'API només té en compte les organitzacions vinculades a l'usuari, les mateixes que pot triar al tauler.

L'administrador ho veu tot de l'organització

Qui és administrador de l'organització, o de l'organització principal, en veu totes les TV, els fitxers i les llistes de reproducció.

La resta depèn dels permisos

Per als altres usuaris s'apliquen, a cada organització, els permisos per veure TV, fitxers i llistes de reproducció, els mateixos que donen accés a aquestes pàgines al tauler.

Els canvis s'apliquen a l'instant

Si al tauler es retira un permís, es treu una organització o es desactiva un usuari, el canvi ja s'aplica a la sol·licitud següent.

Què en queda fora

Els elements d'organitzacions sense permís no apareixen als llistats. Si se'n demana un directament, s'obté 404, com si no existís.
En una llista de reproducció, un fitxer que l'usuari no pot veure apareix amb file igual a null. Les TV d'una llista i les llistes d'un fitxer només mostren el que l'usuari pot veure.
Els elements suprimits i les TV que encara no s'han activat no apareixen.

Per saber què pot consultar una clau, crideu /organizations: cada organització inclou admin i permissions.

Si el vostre sistema només necessita una part de les dades, creeu al tauler un usuari exclusiu per a aquest sistema, amb els permisos necessaris, i genereu la clau al compte d'aquest usuari.

Sol·licitudcURLPHPJavaScript

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

Resposta200

{
  "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 d'una altra organització404

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