डेवलपर गाइड
स्कोप संदर्भिका
सूक्ष्म अनुमति स्कोप आपको यह सीमित करने देते हैं कि कोई API कुंजी या OAuth क्लाइंट वर्कस्पेस में किस तक पहुंच सकता है।
अवलोकन
स्कोप स्पेस से अलग की गई स्ट्रिंग हैं जो किसी API कुंजी या OAuth क्लाइंट से जुड़ी होती हैं। अनुरोध आने पर API टोकन के स्कोप की जांच उस ऑपरेशन के विरुद्ध करता है। यह GitHub और Stripe जैसा ही मॉडल है: परिचित, ऑडिट-योग्य और समझने में आसान।
स्कोप वैकल्पिक हैं। कोई स्कोप न देने पर क्रेडेंशियल को वर्कस्पेस तक पूरी पहुंच मिलती है (वर्कस्पेस admin के बराबर)। हम हर एकीकरण के लिए न्यूनतम आवश्यक स्कोप देने की सलाह देते हैं।
स्कोप
| स्कोप | क्या अनुमति देता है | मेथड | एंडपॉइंट |
|---|---|---|---|
polls:read | पोल, उनकी सामग्री और मेटाडेटा पढ़ना। | GET | /polls, /polls/{id} |
polls:write | पोल बनाना, अपडेट करना और हटाना। | POST, PATCH, DELETE | /polls, /polls/{id} |
results:read | प्रति-स्लाइड समेकित परिणाम और मतदाता सूची पढ़ना। | GET | /polls/{id}/results, /polls/{id}/responses, /polls/{id}/votes |
responses:write | पोल में उत्तर और वोट भेजना। | POST | /polls/{id}/responses, /polls/{id}/votes |
sessions:write | लाइव प्रस्तुतकर्ता सेशन बनाना और नियंत्रित करना। | POST | /sessions, /sessions/{id}/control |
sessions:read | लाइव सेशन की स्थिति पढ़ना (स्थिति, मौजूदा स्लाइड, प्रतिभागी संख्या)। | GET | /sessions/{id} |
media:write | प्रश्नों में उपयोग के लिए मीडिया (छवियां, YouTube) अपलोड और प्रॉक्सी करना। | POST | /media |
export:read | परिणाम CSV फ़ाइल या PDF रिपोर्ट के रूप में डाउनलोड करना। | GET | /polls/{id}/export |
ai:write | पोल सामग्री बनाने के लिए AI का उपयोग करें। | POST | /polls/{id}/branch |
API कुंजियों पर स्कोप
API कुंजी के स्कोप हर अनुरोध पर लागू होते हैं। गैर-रिक्त स्कोप सेट वाली कुंजी केवल उन्हीं एंडपॉइंट को कॉल कर सकती है। जिस अनुरोध को कुंजी में अनुपस्थित स्कोप चाहिए, उसे 403 insufficient_scope मिलता है। बिना स्कोप बनाई गई कुंजी को पूरी वर्कस्पेस पहुंच मिलती है (नीचे डिफ़ॉल्ट देखें)। कुंजी बनाते समय स्कोप डेवलपर पोर्टल में असाइन करें।
OAuth क्लाइंट पर स्कोप
OAuth क्लाइंट टोकन जारी करते समय स्कोप लागू करते हैं। जब आप scope पैरामीटर के साथ POST /api/oauth/token कॉल करते हैं, तो केवल वही स्कोप मिलते हैं जो क्लाइंट बनाते समय असाइन किए गए थे। असाइन न किया गया स्कोप मांगने पर वह चुपचाप टोकन से हटा दिया जाता है।
यदि टोकन अनुरोध में कोई scope नहीं भेजा गया, तो टोकन को क्लाइंट के सभी असाइन किए गए स्कोप मिलते हैं (या क्लाइंट के पास कोई न हो तो पूरी पहुंच)।
पूरी सेटअप प्रक्रिया के लिए OAuth 2.0 गाइड देखें।
डिफ़ॉल्ट (कोई स्कोप निर्दिष्ट नहीं)
बिना स्कोप वाली क्रेडेंशियल्स को पूरी वर्कस्पेस पहुंच मिलती है, वर्कस्पेस admin के बराबर। इसका उपयोग करें:
- व्यक्तिगत स्वचालन के लिए, जहां वर्कस्पेस आपका अपना हो
- प्रोटोटाइप और विकास के लिए
टीमों या तीसरे पक्षों के बीच साझा उत्पादन एकीकरण के लिए हमेशा न्यूनतम आवश्यक स्कोप निर्दिष्ट करें।
अभी भी कोई सवाल है?
हमारी टीम मदद करने में खुश होगी।