Kom i gang

Hva hver bruker kan se

En nøkkel ser nøyaktig det samme som brukeren ser i kontrollpanelet. Du trenger ikke å konfigurere noe i API-et: Reglene kommer fra brukerens organisasjoner og tillatelser.

Bare brukerens organisasjoner

API-et tar bare hensyn til organisasjonene som er knyttet til brukeren, altså de samme som brukeren kan velge i kontrollpanelet.

Administratorer ser alt i organisasjonen

En administrator for organisasjonen, eller for hovedorganisasjonen, ser alle TV-ene, filene og spillelistene i organisasjonen.

For alle andre avgjør tillatelsene

For andre brukere gjelder tillatelsene til å se TV-er, filer og spillelister i hver organisasjon, altså de samme som gir tilgang til disse sidene i kontrollpanelet.

Endringer gjelder umiddelbart

En fjernet tillatelse, en fjernet organisasjon eller en deaktivert bruker i kontrollpanelet gjelder allerede fra neste forespørsel.

Dette vises ikke

Elementer fra organisasjoner uten tillatelse vises ikke i lister. Hvis du ber om et av dem direkte, får du 404, som om det ikke fantes.
I en spilleliste returneres en fil som brukeren ikke kan se, med file satt til null. TV-ene til en spilleliste og spillelistene til en fil viser bare det brukeren kan se.
Slettede elementer og TV-er som ennå ikke er aktivert, vises ikke.

Kall /organizations for å finne ut hva en nøkkel kan hente: Hver organisasjon returneres med admin og permissions.

Hvis systemet ditt bare trenger en del av dataene, kan du opprette en egen bruker for det i kontrollpanelet, med bare de nødvendige tillatelsene, og generere nøkkelen i kontoen til denne brukeren.

ForespørselcURLPHPJavaScript

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 annen organisasjon404

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