Dechrau arni

Beth all pob defnyddiwr ei weld

Mae allwedd yn gweld yn union yr hyn y mae ei defnyddiwr yn ei weld yn y Panel Rheoli. Does dim i'w ffurfweddu yn yr API: daw'r rheolau o sefydliadau a chaniatâd y defnyddiwr.

Sefydliadau'r defnyddiwr yn unig

Dim ond y sefydliadau sy'n gysylltiedig â'r defnyddiwr y mae'r API yn eu hystyried, sef yr un rhai y gall eu dewis yn y Panel Rheoli.

Gweinyddwyr yn gweld popeth yn y sefydliad

Mae gweinyddwr y sefydliad, neu'r prif sefydliad, yn gweld ei holl setiau teledu, ffeiliau a rhestrau chwarae.

Mae pawb arall yn dibynnu ar ganiatâd

I ddefnyddwyr eraill, mae caniatâd pob sefydliad i weld setiau teledu, ffeiliau a rhestrau chwarae yn berthnasol: yr un caniatâd sy'n datgloi'r tudalennau hynny yn y Panel Rheoli.

Newidiadau'n berthnasol ar unwaith

Mae caniatâd a dynnwyd yn ôl, sefydliad a dynnwyd neu ddefnyddiwr a ddadactifadwyd yn y Panel Rheoli yn berthnasol o'r cais nesaf ymlaen.

Beth sy'n cael ei adael allan

Dydy eitemau o sefydliadau heb ganiatâd ddim yn ymddangos yn y rhestrau. Mae gofyn am un ohonynt yn uniongyrchol yn dychwelyd 404, fel pe na bai'n bodoli.
Mewn rhestr chwarae, mae ffeil na all y defnyddiwr ei gweld yn dod gyda file wedi'i osod i null. Mae setiau teledu rhestr chwarae a rhestrau chwarae ffeil yn dangos dim ond yr hyn y gall y defnyddiwr ei weld.
Dydy eitemau sydd wedi'u dileu a setiau teledu sydd heb eu hactifadu eto ddim yn ymddangos.

I weld beth all allwedd ei ddarllen, galwch /organizations: daw pob sefydliad gydag admin a permissions.

Os mai dim ond rhan o'r data sydd ei hangen ar eich system, crëwch ddefnyddiwr ar ei chyfer yn y Panel Rheoli, gyda dim ond y caniatâd sydd ei angen arni, a chynhyrchwch yr allwedd yng nghyfrif y defnyddiwr hwnnw.

CaiscURLPHPJavaScript

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

Ymateb200

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

Eitem o sefydliad arall404

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