Pradžia

Ką gali matyti kiekvienas naudotojas

Raktas mato lygiai tą patį, ką jo naudotojas mato valdymo skydelyje. API nieko konfigūruoti nereikia: taisyklės nustatomos pagal naudotojo organizacijas ir teises.

Tik naudotojo organizacijos

API atsižvelgia tik į su naudotoju susietas organizacijas – tas pačias, kurias jis gali pasirinkti valdymo skydelyje.

Administratorius mato viską organizacijoje

Organizacijos arba pagrindinės organizacijos administratorius mato visus jos televizorius, failus ir grojaraščius.

Kitiems viskas priklauso nuo teisių

Kitiems naudotojams kiekvienoje organizacijoje galioja teisės matyti televizorius, failus ir grojaraščius – tos pačios, kurios atveria šiuos puslapius valdymo skydelyje.

Pakeitimai įsigalioja iš karto

Valdymo skydelyje atimta teisė, pašalinta organizacija ar deaktyvuotas naudotojas įsigalioja jau nuo kitos užklausos.

Kas nerodoma

Organizacijų, kuriose nėra teisių, elementai sąrašuose nerodomi. Tiesiogiai paprašius vieno iš jų, grąžinamas 404, tarsi jo nebūtų.
Grojaraštyje elemento, kurio failo naudotojas negali matyti, file reikšmė yra null. Grojaraščio televizoriai ir failo grojaraščiai rodo tik tai, ką naudotojas gali matyti.
Ištrinti elementai ir dar nesuaktyvinti televizoriai nerodomi.

Norėdami sužinoti, ką raktas gali matyti, iškvieskite /organizations: kiekviena organizacija pateikiama su admin ir permissions.

Jei jūsų sistemai reikia tik dalies duomenų, valdymo skydelyje sukurkite jai atskirą naudotoją tik su būtinomis teisėmis ir sukurkite raktą šio naudotojo paskyroje.

UžklausacURLPHPJavaScript

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

Atsakymas200

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

Kitos organizacijos elementas404

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