Առաջին քայլեր

Ինչ կարող է տեսնել յուրաքանչյուր օգտատեր

Բանալին տեսնում է ճիշտ այն, ինչ տեսնում է դրա օգտատերը կառավարման վահանակում։ API-ում ոչինչ կարգավորել պետք չէ. կանոնները գալիս են օգտատիրոջ կազմակերպություններից և թույլտվություններից։

Ինչ չի ներառվում

• Առանց թույլտվության կազմակերպությունների տարրերը ցանկերում չեն երևում։ Դրանցից որևէ մեկն ուղղակիորեն պահանջելու դեպքում ստացվում է 404, կարծես այն գոյություն չունի։
• Փլեյլիստում այն ֆայլը, որը օգտատերը չի կարող տեսնել, գալիս է file դաշտով, որի արժեքը null է։ Փլեյլիստի հեռուստացույցները և ֆայլի փլեյլիստները ցույց են տալիս միայն այն, ինչ օգտատերը կարող է տեսնել։
• Ջնջված տարրերը և դեռ չակտիվացված հեռուստացույցները չեն երևում։

Իմանալու համար, թե ինչ կարող է կարդալ բանալին, կանչեք /organizations. յուրաքանչյուր կազմակերպություն գալիս է admin և permissions դաշտերով։

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

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

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