Darba sākšana

Ko katrs lietotājs var redzēt

Atslēga redz tieši to pašu, ko tās lietotājs redz vadības panelī. API nekas nav jākonfigurē: noteikumi izriet no lietotāja organizācijām un atļaujām.

Tikai lietotāja organizācijas

API ņem vērā tikai ar lietotāju saistītās organizācijas — tās pašas, kuras viņš var izvēlēties vadības panelī.

Administrators redz visu organizācijā

Organizācijas vai galvenās organizācijas administrators redz visus tās TV, failus un atskaņošanas sarakstus.

Pārējiem viss atkarīgs no atļaujām

Pārējiem lietotājiem katrā organizācijā ir spēkā atļaujas skatīt TV, failus un atskaņošanas sarakstus — tās pašas, kas atver šīs lapas vadības panelī.

Izmaiņas stājas spēkā uzreiz

Vadības panelī atņemta atļauja, noņemta organizācija vai deaktivizēts lietotājs ir spēkā jau nākamajā pieprasījumā.

Kas netiek rādīts

To organizāciju vienumi, kurām nav atļaujas, sarakstos neparādās. Pieprasot kādu no tiem tieši, tiek atgriezts 404, it kā tas neeksistētu.
Atskaņošanas sarakstā failam, kuru lietotājs nevar redzēt, file vērtība ir null. Atskaņošanas saraksta TV un faila atskaņošanas saraksti rāda tikai to, ko lietotājs var redzēt.
Dzēsti vienumi un vēl neaktivizēti TV netiek rādīti.

Lai uzzinātu, ko atslēga var skatīt, izsauciet /organizations: katrai organizācijai ir lauki admin un permissions.

Ja jūsu sistēmai vajadzīga tikai daļa datu, vadības panelī izveidojiet tai atsevišķu lietotāju tikai ar nepieciešamajām atļaujām un izveidojiet atslēgu šī lietotāja kontā.

PieprasījumscURLPHPJavaScript

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

Atbilde200

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

Citas organizācijas vienums404

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