Hapat e parë

Çfarë mund të shohë secili përdorues

Çelësi sheh saktësisht atë që sheh përdoruesi i tij në panelin e kontrollit. Nuk ka nevojë të konfiguroni asgjë në API: rregullat vijnë nga organizatat dhe lejet e përdoruesit.

Vetëm organizatat e përdoruesit

API-ja merr parasysh vetëm organizatat e lidhura me përdoruesin, të njëjtat që ai mund të zgjedhë në panelin e kontrollit.

Administratori sheh gjithçka në organizatë

Administratori i organizatës, ose i organizatës kryesore, sheh të gjithë televizorët, skedarët dhe listat e luajtjes së saj.

Të tjerët varen nga lejet

Për përdoruesit e tjerë vlejnë, në secilën organizatë, lejet për të parë televizorët, skedarët dhe listat e luajtjes, të njëjtat që hapin këto faqe në panelin e kontrollit.

Ndryshimet vlejnë menjëherë

Një leje e hequr, një organizatë e hequr ose një përdorues i çaktivizuar në panelin e kontrollit vlen që në kërkesën e radhës.

Çfarë mbetet jashtë

Elementet e organizatave pa leje nuk shfaqen në lista. Nëse kërkoni drejtpërdrejt njërin prej tyre, merrni 404, sikur të mos ekzistonte.
Në një listë luajtjeje, një skedar që përdoruesi nuk mund ta shohë vjen me file të barabartë me null. Televizorët e një liste luajtjeje dhe listat e luajtjes së një skedari tregojnë vetëm atë që përdoruesi mund të shohë.
Elementet e fshira dhe televizorët që ende nuk janë aktivizuar nuk shfaqen.

Për të ditur se çfarë mund të lexojë një çelës, thirrni /organizations: çdo organizatë vjen me admin dhe permissions.

Nëse sistemi juaj ka nevojë vetëm për një pjesë të të dhënave, krijoni në panelin e kontrollit një përdorues vetëm për të, me lejet e nevojshme, dhe krijoni çelësin në llogarinë e atij përdoruesi.

KërkesacURLPHPJavaScript

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

Përgjigjja200

{
  "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 i një organizate tjetër404

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