Memulai

Apa yang dapat dilihat setiap pengguna

Kunci melihat persis apa yang dilihat penggunanya di panel kontrol. Tidak ada yang perlu dikonfigurasi di API: aturannya berasal dari organisasi dan izin pengguna.

Hanya organisasi milik pengguna

API hanya memperhitungkan organisasi yang terhubung dengan pengguna, yaitu organisasi yang dapat ia pilih di panel kontrol.

Administrator melihat semua isi organisasi

Administrator organisasi, atau organisasi utama, dapat melihat semua TV, file, dan playlist di organisasi tersebut.

Pengguna lain bergantung pada izin

Untuk pengguna lain, yang berlaku adalah izin melihat TV, file, dan playlist di setiap organisasi, yaitu izin yang sama yang membuka halaman-halaman tersebut di panel kontrol.

Perubahan langsung berlaku

Izin yang dicabut, organisasi yang dihapus, atau pengguna yang dinonaktifkan di panel kontrol sudah berlaku pada permintaan berikutnya.

Apa yang tidak ditampilkan

Item dari organisasi tanpa izin tidak muncul di daftar. Meminta salah satunya secara langsung menghasilkan 404, seolah-olah item itu tidak ada.
Dalam playlist, file yang tidak dapat dilihat pengguna dikirim dengan file bernilai null. TV dari sebuah playlist dan playlist dari sebuah file hanya menampilkan yang dapat dilihat pengguna.
Item yang dihapus dan TV yang belum diaktifkan tidak muncul.

Untuk mengetahui apa yang dapat dibaca sebuah kunci, panggil /organizations: setiap organisasi disertai admin dan permissions.

Jika sistem Anda hanya memerlukan sebagian data, buat pengguna khusus untuk sistem itu di panel kontrol, hanya dengan izin yang diperlukan, lalu buat kunci di akun pengguna tersebut.

PermintaancURLPHPJavaScript

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

Respons200

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

Item dari organisasi lain404

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