ऐक्सेस कंट्रोल

Powerduck में पाठकों का डॉक्यूमेंटेशन ऐक्सेस और क्लाइंट का MCP एंडपॉइंट ऐक्सेस अलग हैं, क्योंकि दोनों का इस्तेमाल अलग तरह से होता है। MCP सर्वर अपस्ट्रीम API में कैसे प्रमाणित होगा, यह भी अलग से सेट किया जाता है।

जाँच का क्रम

सार्वजनिक सेवा खुलेगी या नहीं, यह कई शर्तों पर निर्भर है। सभी शर्तें जानने से यह समझना आसान होता है कि दस्तावेज़ क्यों नहीं खुल रहा।

1. दस्तावेज़ की स्थिति — ACTIVE होनी चाहिए; रोका गया, संग्रहित या हटाया गया दस्तावेज़ नहीं खुलेगा;
2. सेवा सक्षम हो — डॉक्यूमेंटेशन के लिए documentationEnabled, MCP के लिए mcpEnabled;
3. ऐक्सेस क्रेडेंशियल — सेट होने पर डॉक्यूमेंटेशन का व्यू पासवर्ड या MCP की ऐक्सेस कुंजी;
4. समय-सीमा — डॉक्यूमेंटेशन का ऐक्सेस किसी तय समय पर समाप्त किया जा सकता है।

नया संस्करण जोड़ने या उपलब्ध कराए गए ऑपरेशन बदलने पर प्रकाशित सामग्री अपने-आप बनती है। इसलिए आम तौर पर अलग से मैनुअल प्रकाशन की ज़रूरत नहीं होती।

दोनों सेवाएँ स्वतंत्र हैं: MCP बंद करने से डॉक्यूमेंटेशन प्रभावित नहीं होता और डॉक्यूमेंटेशन का पासवर्ड MCP को नहीं रोकता।

डॉक्यूमेंटेशन का व्यू पासवर्ड

पासवर्ड रेंडर किए गए डॉक्यूमेंटेशन और उपलब्ध कराए गए स्पेसिफ़िकेशन डेटा, दोनों की रक्षा करता है:

• हर पासवर्ड के लिए अलग रैंडम सॉल्ट के साथ scrypt हैश बनाया जाता है; मूल पासवर्ड सहेजा नहीं जाता;
• पासवर्ड सेट होने पर दस्तावेज़ मिलने से पहले पाठक को वह देना होता है;
• पासवर्ड केवल डॉक्यूमेंटेशन पर लागू है; MCP एंडपॉइंट अपनी ऐक्सेस कुंजी इस्तेमाल करता है और व्यू पासवर्ड नहीं जाँचता।

आप देखने की समय-सीमा भी तय कर सकते हैं। उसके बाद सही पासवर्ड देने पर भी ऐक्सेस नहीं मिलता। संबंधित प्रतिबंध हटाने के लिए पासवर्ड या समय-सीमा साफ़ करें।

MCP एंडपॉइंट की ऐक्सेस कुंजी

MCP एंडपॉइंट की अपनी ऐक्सेस कुंजी होती है:

• कुंजी बनाएँ या बदलें: पूरी कुंजी सिर्फ़ एक बार लौटाई जाती है; बाद में केवल आख़िरी चार अक्षर दिखते हैं;
• कुंजी सेट होने पर हर MCP अनुरोध में उसे Bearer टोकन के रूप में देना होता है;
• कुंजी की तुलना स्थिर समय में की जाती है। कुंजी न होने या गलत होने पर 401 मिलता है।

कुंजी हटाने पर MCP एंडपॉइंट बिना कुंजी के खुल जाता है, बशर्ते दस्तावेज़ सक्रिय हो और MCP सक्षम हो।

MCP का अपस्ट्रीम ऑथेंटिकेशन

एंडपॉइंट की सुरक्षा से अलग, आप सेट कर सकते हैं कि MCP सर्वर स्पेसिफ़िकेशन में बताए गए अपस्ट्रीम API में कैसे प्रमाणित होगा। ये प्रकार उपलब्ध हैं:

authType	कॉन्फ़िगरेशन
NONE	अपस्ट्रीम ऑथेंटिकेशन नहीं
BEARER	Bearer टोकन
BASIC	बेसिक ऑथेंटिकेशन का उपयोगकर्ता नाम और पासवर्ड
APIKEY	हेडर या क्वेरी में API कुंजी का नाम और मान

Bearer टोकन, पासवर्ड और API कुंजी जैसे गोपनीय मान लिखे जा सकते हैं, लेकिन वापस पढ़े नहीं जा सकते। कॉन्फ़िगरेशन केवल यह बताता है कि वे सेट हैं या नहीं।

MCP की दूसरी सेटिंग:

• बेस URL बदलना — स्पेसिफ़िकेशन में दिए गए अपस्ट्रीम बेस URL की जगह दूसरा URL इस्तेमाल करें;
• अनुरोध टाइमआउट — अपस्ट्रीम API कॉल करते समय MCP सर्वर कितनी देर प्रतीक्षा करेगा।

सुझाया गया सेटअप

• सार्वजनिक डॉक्यूमेंटेशन: खुले API के लिए बिना पासवर्ड सक्षम करें; सीमित साझाकरण के लिए पासवर्ड और समय-सीमा रखें;
• अपने एजेंट के लिए MCP: MCP सक्षम करके ऐक्सेस कुंजी बनाएँ, ताकि केवल आपके क्लाइंट उसे कॉल कर सकें;
• अपस्ट्रीम ऑथेंटिकेशन: असली API की ज़रूरत के अनुसार MCP सर्वर का ऑथेंटिकेशन सेट करें। यह इस नियम से अलग है कि MCP एंडपॉइंट को कौन कॉल कर सकता है।

संबंधित: उपलब्ध कराए गए ऑपरेशन, दस्तावेज़ और संस्करण, कस्टम डोमेन।