नोट
इस पेज तक पहुँच के लिए प्रमाणन की आवश्यकता होती है. आप साइन इन करने या निर्देशिकाओं को बदलने का प्रयास कर सकते हैं.
इस पेज तक पहुँच के लिए प्रमाणन की आवश्यकता होती है. आप निर्देशिकाओं को बदलने का प्रयास कर सकते हैं.
यह आलेख Microsoft Learn प्लेटफ़ॉर्म API का उपयोग प्रारंभ करने में आपकी सहायता करता है. अगर आप API के विवरण या उसके उपयोग के मामलों से परिचित नहीं हैं, तो हम अनुशंसा करते हैं कि आप पहले Microsoft Learn Platform API अवलोकन लेख की समीक्षा करें.
प्लेटफ़ॉर्म API प्रमाणीकरण सीखें
लर्न प्लेटफ़ॉर्म REST API प्रमाणीकरण के लिए Microsoft Entra ID का उपयोग करते हैं। एपीआई कॉल करने से पहले, आपको एक एक्सेस विधि चुननी होगी, और आपके क्लाइंट एप्लिकेशन को वैध क्रेडेंशियल्स के साथ प्रमाणित करना होगा।
केवल-ऐप एक्सेस
जब आपका ऐप सीधे लर्न तक पहुंचता है, तो इसका एक्सेस किसी एक उपयोगकर्ता से बंधा नहीं होता है। ऐप एपीआई को सीधे अपनी पहचान का उपयोग करके कॉल करता है, यह परिदृश्य केवल ऐप एक्सेस है। Microsoft पहचान प्लेटफ़ॉर्म पर अधिक जानें.
आरंभ करने के लिए, आपको Microsoft पहचान प्लेटफ़ॉर्म पर एक वैध पहचान की आवश्यकता होती है, जो एक ऐप पंजीकरण या प्रबंधित पहचान हो सकती है। आदर्श रूप से, कोटा और भागीदार प्रबंधन को सरल बनाने के लिए प्रत्येक भागीदार की एक ही पहचान होनी चाहिए। उपयोगकर्ता द्वारा असाइन की गई प्रबंधित पहचान का उपयोग करने से विभिन्न सेवाओं में प्रबंधित पहचान को एकीकृत करने में मदद मिल सकती है.
एक बार जब आपकी Entra ID पहचान सेट हो जाती है, तो प्रमाणीकरण के प्रमाण के रूप में सेट स्कोप के साथ Entra ID से एक प्राप्त करें। सीखने के लिए REST API अनुरोध करते समय HTTP प्राधिकरण हेडर में एक्सेस टोकन शामिल करें।
प्रत्यायोजित पहुँच
जब कोई उपयोगकर्ता आपके ऐप में साइन इन करता है और लर्न तक पहुंचने के लिए इसका उपयोग करता है, तो ऐप को पहले उपयोगकर्ता की ओर से इस संसाधन तक पहुंचने की अनुमति मांगनी होगी। इस परिदृश्य को प्रत्यायोजित पहुँच कहा जाता है। Microsoft पहचान प्लेटफ़ॉर्म पर अधिक जानें.
आरंभ करने के लिए, आपको एक ऐप पंजीकरण पंजीकृत करना होगा। एक बार जब आपका ऐप्लिकेशन पंजीकरण सेट हो जाता है, तो आपके ऐप्लिकेशन को उपयोगकर्ता से उपयोगकर्ता की ओर से Learn एक्सेस करने के लिए एक विशिष्ट कार्यक्षेत्र या कार्यक्षेत्र का सेट देने के लिए कहना होगा. Learn बेहतर संसाधन पहुंच के लिए क्षेत्रों की एक सूची प्रदान करता है। स्कोप की सूची में शामिल हैं:
- : यह दायरा उपयोगकर्ताओं को साइन-इन उपयोगकर्ता के रूप में प्रतिरूपण किए गए Learn पर सार्वजनिक सामग्री तक पहुंचने की अनुमति देता है।
Microsoft Learn Platform API वर्जनिंग को समझना
जब एपीआई में बदलाव किए जाते हैं, तो हम एक नया, दिनांकित संस्करण जारी करते हैं। परिवर्तनों को तोड़ना ऐसे परिवर्तन हैं जो संभावित रूप से एकीकरण को तोड़ सकते हैं। कोई भी गैर-ब्रेकिंग (योजक) परिवर्तन सभी समर्थित एपीआई संस्करणों में उपलब्ध होंगे।
एपीआई संस्करण को एपीआई-संस्करण क्वेरी पैरामीटर के रूप में निर्दिष्ट किया गया है और स्थिर संस्करणों के लिए yyyy-MM-dd और पूर्वावलोकन संस्करणों के लिए yyyy-MM-dd-पूर्वावलोकन का उपयोग करता है। एपीआई-संस्करण क्वेरी पैरामीटर प्रत्येक एपीआई अनुरोध के लिए आवश्यक है।
जब एक नया स्थिर एपीआई संस्करण जारी किया जाता है, तो नया एपीआई संस्करण जारी होने के बाद पिछले स्थिर एपीआई संस्करण को कम से कम 24 और महीनों के लिए समर्थित किया जाता है। नए पूर्वावलोकन एपीआई के जारी होने के बाद पूर्वावलोकन एपीआई का समर्थन चक्र तीन और महीनों का छोटा होता है।
वर्तमान संस्करण 2023-11-01-पूर्वावलोकन है।
प्रत्येक एपीआई से पहले /v1/यूआरएल सेगमेंट बेस यूआरएल का हिस्सा है, एपीआई संस्करण का नहीं। यह भविष्य में पर्याप्त एपीआई प्रोटोकॉल और पैटर्न परिवर्तनों के लिए आरक्षित है।
प्लेटफ़ॉर्म API दर सीमित करना सीखें
Learn उन REST API अनुरोधों की संख्या को सीमित करता है जिन्हें आप एक विशिष्ट समय के भीतर कर सकते हैं। यह सीमा दुरुपयोग और सेवा से इनकार करने वाले हमलों को रोकने में मदद करती है, और यह सुनिश्चित करती है कि एपीआई सभी उपयोगकर्ताओं के लिए उपलब्ध रहे।
Learn एक्सेस टोकन में Oid दावे के आधार पर दर सीमाएं लागू करता है. केवल-ऐप एक्सेस के लिए, सीमा ऐप पर ही लागू होती है, जबकि प्रत्यायोजित एक्सेस के लिए, सीमा ऐप में साइन इन किए गए उपयोगकर्ता पर लागू होती है।
डिफ़ॉल्ट रूप से, दर सीमा प्रति मिनट 100 एपीआई कॉल है, जिसकी गणना 5 मिनट की विंडो में की जाती है। यदि आपको उत्पादन के लिए उच्च सीमा की आवश्यकता है, तो आप वृद्धि का अनुरोध करने के लिए एकीकरण सहायता सीखें से संपर्क कर सकते हैं।
कुछ एपीआई, जैसे ज्ञान खोज एपीआई, टोकन-आधारित दर सीमा को भी लागू करते हैं। यह उपभोग किए गए Microsoft Azure OpenAI टोकन की संख्या पर आधारित है, जिसकी डिफ़ॉल्ट सीमा 10,000 टोकन प्रति मिनट है। उत्पादन के लिए इस सीमा को बढ़ाने के लिए, जानें एकीकरण समर्थन से संपर्क करें.
प्लेटफ़ॉर्म API पेजिनेशन सीखें
सभी शीर्ष-स्तरीय एपीआई संसाधन 'सूची' एपीआई विधियों के माध्यम से थोक पुनर्प्राप्ति का समर्थन करते हैं। उदाहरण के लिए, आप मॉड्यूल या परीक्षाओं की सूची पुनः प्राप्त कर सकते हैं। ये विधियां एक मानकीकृत दृष्टिकोण के बाद पृष्ठांकित प्रतिक्रियाएं लौटाती हैं।
सूची एपीआई विधियां कर्सर-आधारित पेजिनेशन का उपयोग करती हैं, जो प्रतिक्रिया निकाय में nextLink फ़ील्ड द्वारा इंगित की जाती है। इस फ़ील्ड में एक अपारदर्शी URL होता है जिसमें परिणामों का अगला पृष्ठ लाने के लिए आवश्यक जानकारी होती है. डिफ़ॉल्ट रूप से, सूची एपीआई प्रति अनुरोध 30 आइटम लौटाते हैं, लेकिन आप अधिकतम पृष्ठआकार पैरामीटर का उपयोग करके पृष्ठ आकार समायोजित कर सकते हैं।
हमारे क्लाइंट एसडीके लाइब्रेरी एक सूची के सभी पृष्ठों को पार करने के लिए ऑटोपेजिनेशन सहायकों की पेशकश करते हैं।
संबंधित सामग्री
- क्विकस्टार्ट: Microsoft Learn प्लेटफ़ॉर्म API कैटलॉग डेटा सेट करें और उसका उपयोग करें
- प्लेटफ़ॉर्म API कैटलॉग डेटा डेवलपर संदर्भ जानें
- प्लेटफ़ॉर्म API सीखें अक्सर पूछे जाने वाले प्रश्न