Başlarken

Her kullanıcı neleri görebilir

Anahtar, kullanıcısının kontrol panelinde gördüklerinin tam olarak aynısını görür. API'de herhangi bir ayar yapmanız gerekmez; kurallar kullanıcının kuruluşlarından ve izinlerinden gelir.

Yalnızca kullanıcının kuruluşları

API yalnızca kullanıcıya bağlı kuruluşları, yani kullanıcının kontrol panelinde seçebildiği kuruluşları dikkate alır.

Yönetici, kuruluştaki her şeyi görür

Kuruluşun veya ana kuruluşun yöneticisi olan kullanıcı, o kuruluşun tüm TV'lerini, dosyalarını ve oynatma listelerini görür.

Diğer kullanıcılar izinlere bağlıdır

Diğer kullanıcılar için her kuruluştaki TV'leri, dosyaları ve oynatma listelerini görüntüleme izinleri geçerlidir; bunlar, kontrol panelinde bu sayfalara erişim sağlayan izinlerle aynıdır.

Değişiklikler anında geçerli olur

Kontrol panelinde kaldırılan bir izin, kaldırılan bir kuruluş veya devre dışı bırakılan bir kullanıcı bir sonraki istekte geçerli olur.

Neler görünmez

İzin olmayan kuruluşların öğeleri listelerde görünmez. Bu öğelerden birini doğrudan istemek, öğe hiç yokmuş gibi 404 döndürür.
Bir oynatma listesinde, kullanıcının göremediği bir dosya için file değeri null olarak gelir. Bir oynatma listesinin TV'leri ve bir dosyanın oynatma listeleri yalnızca kullanıcının görebildiklerini gösterir.
Silinmiş öğeler ve henüz etkinleştirilmemiş TV'ler görünmez.

Bir anahtarın neleri sorgulayabildiğini öğrenmek için /organizations uç noktasını çağırın. Her kuruluş admin ve permissions alanlarıyla gelir.

Sisteminiz verilerin yalnızca bir kısmına ihtiyaç duyuyorsa kontrol panelinde yalnızca bu sistem için, gereken izinlere sahip bir kullanıcı oluşturun ve anahtarı bu kullanıcının hesabında oluşturun.

İstekcURLPHPJavaScript

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

Yanıt200

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

Başka bir kuruluşa ait öğe404

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