Kom igång

Vad varje användare kan se

En nyckel ser exakt det som dess användare ser i kontrollpanelen. Du behöver inte konfigurera något i API:et: reglerna kommer från användarens organisationer och behörigheter.

Bara användarens organisationer

API:et tar bara hänsyn till de organisationer som är kopplade till användaren, alltså samma som användaren kan välja i kontrollpanelen.

Administratörer ser allt i organisationen

En administratör för organisationen, eller för huvudorganisationen, ser alla organisationens TV-apparater, filer och spellistor.

För alla andra avgör behörigheterna

För andra användare gäller i varje organisation behörigheterna att se TV-apparater, filer och spellistor, alltså samma som ger åtkomst till de sidorna i kontrollpanelen.

Ändringar gäller direkt

En borttagen behörighet, en borttagen organisation eller en inaktiverad användare i kontrollpanelen gäller redan från nästa anrop.

Det här visas inte

Objekt från organisationer utan behörighet visas inte i listor. Om du hämtar ett av dem direkt får du 404, som om det inte fanns.
I en spellista returneras en fil som användaren inte kan se med file satt till null. En spellistas TV-apparater och en fils spellistor visar bara det användaren kan se.
Borttagna objekt och TV-apparater som ännu inte har aktiverats visas inte.

Anropa /organizations för att ta reda på vad en nyckel kan hämta: varje organisation returneras med admin och permissions.

Om ditt system bara behöver en del av datan kan du skapa en egen användare för det i kontrollpanelen, med bara de behörigheter som behövs, och generera nyckeln i den användarens konto.

AnropcURLPHPJavaScript

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

Objekt från en annan organisation404

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