शुरुआत करें
हर उपयोगकर्ता क्या देख सकता है
कुंजी ठीक वही देखती है जो उसका उपयोगकर्ता कंट्रोल पैनल में देखता है। API में कुछ भी कॉन्फ़िगर करने की ज़रूरत नहीं है: नियम उपयोगकर्ता के संगठनों और अनुमतियों से तय होते हैं।
केवल उपयोगकर्ता के संगठन
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."
}
}