Aan de slag

Wat elke gebruiker kan zien

Een sleutel ziet precies wat de bijbehorende gebruiker in het beheerpaneel ziet. U hoeft niets in te stellen in de API: de regels volgen uit de organisaties en rechten van de gebruiker.

Alleen de organisaties van de gebruiker

De API houdt alleen rekening met de organisaties die aan de gebruiker zijn gekoppeld, dezelfde die hij in het beheerpaneel kan kiezen.

Beheerders zien alles van de organisatie

Een beheerder van de organisatie, of van de hoofdorganisatie, ziet alle TV's, bestanden en playlists van die organisatie.

Voor anderen gelden de rechten

Voor andere gebruikers gelden per organisatie de rechten om TV's, bestanden en playlists te bekijken, dezelfde die deze pagina's in het beheerpaneel vrijgeven.

Wijzigingen gelden direct

Een ingetrokken recht, een verwijderde organisatie of een gedeactiveerde gebruiker in het beheerpaneel geldt al vanaf het volgende verzoek.

Wat buiten beeld blijft

Items van organisaties zonder rechten verschijnen niet in lijsten. Wie er rechtstreeks een opvraagt, krijgt 404, alsof het item niet bestaat.
In een playlist komt een bestand dat de gebruiker niet kan zien terug met file gelijk aan null. De TV's van een playlist en de playlists van een bestand tonen alleen wat de gebruiker kan zien.
Verwijderde items en TV's die nog niet zijn geactiveerd, verschijnen niet.

Wilt u weten wat een sleutel kan opvragen? Roep dan /organizations aan: elke organisatie komt terug met admin en permissions.

Heeft uw systeem maar een deel van de gegevens nodig? Maak dan in het beheerpaneel een aparte gebruiker voor dat systeem aan, met alleen de benodigde rechten, en genereer de sleutel in het account van die gebruiker.

VerzoekcURLPHPJavaScript

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

Antwoord200

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

Item van een andere organisatie404

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