Kom godt i gang

Hvad hver bruger kan se

En nøgle ser præcis det samme, som dens bruger ser i kontrolpanelet. Der skal ikke konfigureres noget i API'et: Reglerne kommer fra brugerens organisationer og tilladelser.

Kun brugerens organisationer

API'et tager kun højde for de organisationer, der er knyttet til brugeren, altså de samme, som brugeren kan vælge i kontrolpanelet.

Administratorer ser alt i organisationen

En administrator af organisationen eller af hovedorganisationen ser alle organisationens TV'er, filer og playlister.

For alle andre afgør tilladelserne

For andre brugere gælder tilladelserne til at se TV'er, filer og playlister i hver organisation, altså de samme, der giver adgang til disse sider i kontrolpanelet.

Ændringer gælder med det samme

En fjernet tilladelse, en fjernet organisation eller en deaktiveret bruger i kontrolpanelet gælder allerede fra næste forespørgsel.

Hvad der ikke vises

Elementer fra organisationer uden tilladelse vises ikke i lister. Hvis du henter et af dem direkte, får du 404, som om det ikke fandtes.
I en playliste returneres en fil, som brugeren ikke kan se, med file sat til null. En playlistes TV'er og en fils playlister viser kun det, brugeren kan se.
Slettede elementer og TV'er, der endnu ikke er aktiveret, vises ikke.

Kald /organizations for at finde ud af, hvad en nøgle kan hente: Hver organisation returneres med admin og permissions.

Hvis dit system kun har brug for en del af dataene, kan du oprette en bruger kun til systemet i kontrolpanelet, med de nødvendige tilladelser, og generere nøglen på den brugers konto.

ForespørgselcURLPHPJavaScript

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

Svar200

{
  "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 fra en anden organisation404

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