Πρώτα βήματα

Τι βλέπει κάθε χρήστης

Το κλειδί βλέπει ακριβώς ό,τι βλέπει ο χρήστης του στον πίνακα ελέγχου. Δεν χρειάζεται να ρυθμίσετε τίποτα στο API: οι κανόνες προκύπτουν από τους οργανισμούς και τα δικαιώματα του χρήστη.

Μόνο οι οργανισμοί του χρήστη

Το API λαμβάνει υπόψη μόνο τους οργανισμούς που συνδέονται με τον χρήστη, τους ίδιους που μπορεί να επιλέξει στον πίνακα ελέγχου.

Ο διαχειριστής βλέπει τα πάντα στον οργανισμό

Όποιος είναι διαχειριστής του οργανισμού ή του κύριου οργανισμού βλέπει όλες τις τηλεοράσεις, τα αρχεία και τις λίστες αναπαραγωγής του.

Για τους υπόλοιπους μετρούν τα δικαιώματα

Για τους άλλους χρήστες ισχύουν, σε κάθε οργανισμό, τα δικαιώματα προβολής τηλεοράσεων, αρχείων και λιστών αναπαραγωγής — τα ίδια που ξεκλειδώνουν αυτές τις σελίδες στον πίνακα ελέγχου.

Οι αλλαγές ισχύουν αμέσως

Ένα δικαίωμα που αφαιρέθηκε, ένας οργανισμός που αφαιρέθηκε ή ένας χρήστης που απενεργοποιήθηκε στον πίνακα ελέγχου ισχύουν ήδη από το επόμενο αίτημα.

Τι δεν εμφανίζεται

Τα στοιχεία οργανισμών χωρίς δικαίωμα δεν εμφανίζονται στις λίστες. Αν ζητήσετε κάποιο από αυτά απευθείας, επιστρέφεται 404, σαν να μην υπήρχε.
Σε μια λίστα αναπαραγωγής, ένα αρχείο που ο χρήστης δεν μπορεί να δει επιστρέφεται με file ίσο με null. Οι τηλεοράσεις μιας λίστας και οι λίστες ενός αρχείου δείχνουν μόνο ό,τι μπορεί να δει ο χρήστης.
Τα διαγραμμένα στοιχεία και οι τηλεοράσεις που δεν έχουν ενεργοποιηθεί ακόμη δεν εμφανίζονται.

Για να μάθετε τι μπορεί να ανακτήσει ένα κλειδί, καλέστε το /organizations: κάθε οργανισμός επιστρέφεται με admin και permissions.

Αν το σύστημά σας χρειάζεται μόνο μέρος των δεδομένων, δημιουργήστε στον πίνακα ελέγχου έναν χρήστη ειδικά για αυτό, με μόνο τα απαραίτητα δικαιώματα, και δημιουργήστε το κλειδί στον λογαριασμό αυτού του χρήστη.

ΑίτημαcURLPHPJavaScript

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

Απόκριση200

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

Στοιχείο άλλου οργανισμού404

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