Pagsisimula

Ano ang nakikita ng bawat user

Nakikita ng key ang eksaktong nakikita ng user nito sa control panel. Walang kailangang i-configure sa API: nagmumula ang mga patakaran sa mga organisasyon at pahintulot ng user.

Mga organisasyon lang ng user

Isinasaalang-alang lang ng API ang mga organisasyong naka-link sa user, ang parehong mga mapipili niya sa control panel.

Nakikita ng administrator ang lahat sa organisasyon

Nakikita ng administrator ng organisasyon, o ng pangunahing organisasyon, ang lahat ng TV, file at playlist nito.

Nakadepende sa mga pahintulot ang iba

Para sa ibang user, umiiral sa bawat organisasyon ang mga pahintulot na tingnan ang mga TV, file at playlist, ang parehong mga pahintulot na nagbubukas ng mga pahinang iyon sa control panel.

Agad na umiiral ang mga pagbabago

Ang pahintulot na tinanggal, organisasyong inalis o user na na-deactivate sa control panel ay umiiral na sa susunod na request.

Ang hindi kasama

Hindi lumalabas sa mga listahan ang mga item ng mga organisasyong walang pahintulot. Kapag direktang hiniling ang isa sa mga ito, 404 ang makukuha, na parang hindi ito umiiral.
Sa isang playlist, ang file na hindi nakikita ng user ay dumarating na null ang file. Ang mga TV ng isang playlist at ang mga playlist ng isang file ay nagpapakita lang ng nakikita ng user.
Hindi lumalabas ang mga binurang item at ang mga TV na hindi pa na-activate.

Para malaman kung ano ang mababasa ng isang key, tawagin ang /organizations: bawat organisasyon ay may kasamang admin at permissions.

Kung bahagi lang ng data ang kailangan ng iyong system, gumawa sa control panel ng user na para lang dito, na may mga kinakailangang pahintulot lang, at gawin ang key sa account ng user na iyon.

RequestcURLPHPJavaScript

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

Response200

{
  "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 ng ibang organisasyon404

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