आपको Apigee Edge दस्तावेज़ दिख रहा है.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है
इस पेज पर जाएं
Apigee X दस्तावेज़. जानकारी
इन सेक्शन में, आपको एपीआई प्रॉडक्ट और इससे जुड़े मुख्य सिद्धांतों के बारे में जानकारी मिलती है.
एपीआई प्रॉडक्ट क्या होता है?
एपीआई सेवा देने वाली कंपनी के तौर पर, अपने एपीआई को बंडल करने और उन्हें उपलब्ध कराने के लिए, एपीआई प्रॉडक्ट बनाए जाते हैं इस्तेमाल करने के लिए ऐप्लिकेशन डेवलपर को उपलब्ध कराया. एपीआई प्रॉडक्ट को अपना प्रॉडक्ट लाइन माना जा सकता है.
खास तौर पर, एपीआई प्रॉडक्ट को इन्हें एक साथ बंडल किया जाता है:
- एपीआई संसाधनों (यूआरआई) का कलेक्शन
- सेवा प्लान
- निगरानी या विश्लेषण के लिए आपके कारोबार से जुड़ा मेटाडेटा (ज़रूरी नहीं)
किसी एपीआई प्रॉडक्ट में बंडल किए गए एपीआई रिसॉर्स, एक या उससे ज़्यादा एपीआई से आ सकते हैं, ताकि आप आपस में नीचे दिए गए डायग्राम में बताए गए संसाधनों के आधार पर, खास सुविधाओं के सेट बनाए जा सकते हैं.
अलग-अलग ज़रूरतों को पूरा करने वाले इस्तेमाल के उदाहरण हल करने के लिए, एक से ज़्यादा एपीआई प्रॉडक्ट बनाए जा सकते हैं. उदाहरण के लिए, ऐसा एपीआई प्रॉडक्ट बनाया जा सकता है जो मैपिंग के कई संसाधनों को बंडल करता है, डेवलपर को अपने ऐप्लिकेशन में आसानी से मैप जोड़ने की सुविधा देता है. साथ ही, एपीआई वाले हर प्रॉडक्ट के लिए अलग-अलग प्रॉपर्टी सेट की जा सकती हैं, जैसे कि अलग-अलग कीमत लेवल. उदाहरण के लिए, नीचे दिए गए एपीआई प्रॉडक्ट के कॉम्बिनेशन ऑफ़र किए जा सकते हैं:
- ऐसा एपीआई प्रॉडक्ट जो कम कीमत पर ऐक्सेस की सुविधा देता है. जैसे, बहुत कम कीमत पर एक दिन में 1, 000 अनुरोध. इन संसाधनों को ऐक्सेस करने के लिए, दूसरा एपीआई प्रॉडक्ट उपलब्ध है. हालांकि, यह ऐक्सेस सीमित है और कीमत ज़्यादा है.
- यह एपीआई प्रॉडक्ट के लिए कोई शुल्क नहीं है. इसमें संसाधनों का रीड ओनली ऐक्सेस होता है. एक दूसरा एपीआई प्रॉडक्ट, जो मामूली शुल्क में समान संसाधनों को पढ़ने/लिखने का ऐक्सेस देता है.
इसके अलावा, आपके पास किसी एपीआई प्रॉडक्ट में, एपीआई संसाधनों के ऐक्सेस को कंट्रोल करने का विकल्प भी है. उदाहरण के लिए, आप बंडल के रूप में ऐसे संसाधन जिन्हें सिर्फ़ इंटरनल डेवलपर या पैसे चुकाकर सेवाएं इस्तेमाल करने वाले ग्राहक ऐक्सेस कर सकते हैं.
एपीआई प्रॉडक्ट, आपके एपीआई की अनुमति देने और ऐक्सेस कंट्रोल करने का मुख्य तरीका है. Apigee में, एपीआई पासकोड का प्रावधान किया जाता है, न कि एपीआई के लिए, बल्कि एपीआई प्रॉडक्ट के लिए. दूसरे शब्दों में, एपीआई कुंजियों का प्रावधान, अटैच किए गए सर्विस प्लान के साथ संसाधनों के बंडल के लिए किया जाता है.
ऐप्लिकेशन डेवलपर, अपने ऐप्लिकेशन रजिस्टर करके, आपके एपीआई प्रॉडक्ट ऐक्सेस करते हैं. इस बारे में, ऐप्लिकेशन रजिस्टर करने की प्रोसेस में बताया गया है. जब कोई ऐप्लिकेशन किसी एपीआई प्रॉडक्ट को ऐक्सेस करने की कोशिश करता है, तो रनटाइम के दौरान Apigee अनुमति लागू करता है, ताकि यह पक्का किया जा सके कि:
- अनुरोध करने वाले ऐप्लिकेशन को किसी खास एपीआई रिसॉर्स को ऐक्सेस करने की अनुमति है.
- अनुरोध करने वाले ऐप्लिकेशन ने तय कोटा पार नहीं किया है.
- अगर तय किया गया हो, तो एपीआई प्रॉडक्ट में बताए गए OAuth के दायरे, ऐक्सेस से जुड़े दायरे से मेल खाते हैं ऐप्लिकेशन से मिला टोकन.
मुख्य कॉन्सेप्ट को समझना
अपने एपीआई प्रॉडक्ट बनाने से पहले, इन मुख्य कॉन्सेप्ट को देखें.
एपीआई पासकोड
जब आप अपने संगठन में किसी डेवलपर के ऐप्लिकेशन को रजिस्टर करते हैं, तो ऐप्लिकेशन को कम से कम एक एपीआई प्रॉडक्ट से जुड़ा होना चाहिए. किसी ऐप्लिकेशन को एक या उससे ज़्यादा एपीआई प्रॉडक्ट के साथ जोड़ने पर, Edge ऐप्लिकेशन को एक खास ग्राहक कुंजी असाइन करता है.
उपभोक्ता कुंजी या ऐक्सेस टोकन, अनुरोध करने के लिए क्रेडेंशियल के तौर पर काम करते हैं. ऐप्लिकेशन डेवलपर, उपभोक्ता कुंजी को ऐप्लिकेशन में जोड़ देता है, ताकि जब ऐप्लिकेशन कोई अनुरोध करे, तो उपयोगकर्ता कुंजी को जोड़ दिया जाए का इस्तेमाल करता है, तो ऐप्लिकेशन इनमें से किसी एक तरीके से अनुरोध में उपभोक्ता कुंजी पास करता है:
- अगर एपीआई पासकोड की पुष्टि करने की सुविधा का इस्तेमाल करता है, तो ऐप्लिकेशन को सीधे उपभोक्ता कुंजी पास करनी होगी.
- जब एपीआई OAuth टोकन की पुष्टि करने की सुविधा का इस्तेमाल करता है, तब ऐप्लिकेशन को एक टोकन पास करना ज़रूरी है जो उपभोक्ता कुंजी से लिया गया हो.
एपीआई पासकोड अपने-आप लागू नहीं होता. उपयोगकर्ता कुंजी या OAuth टोकन का इस्तेमाल किया जा रहा है या नहीं अनुरोध क्रेडेंशियल के रूप में, एपीआई प्रॉक्सी आपके VerifyAPIKey नीति या OAuth/VerifyAccessToken नीति को शामिल करके, एपीआई प्रॉक्सी को शामिल किया जाता है, का इस्तेमाल करें. अगर आप अपने दस्तावेज़ में, एपीआई प्रॉक्सी, कोई भी कॉलर आपके API को शुरू कर सकता है. ज़्यादा जानकारी के लिए, एपीआई पासकोड की नीति की पुष्टि करें देखें.
अनुरोध में पास किए गए क्रेडेंशियल की पुष्टि करने के लिए, Edge यह तरीका अपनाता है:
- अनुरोध के साथ पास किए गए क्रेडेंशियल पाएं. OAuth के मामले में टोकन की पुष्टि करने के बाद एजुकेटर इस बात की पुष्टि करता है कि टोकन की समयसीमा खत्म तो नहीं हो गई है. इसके बाद, वह उपभोक्ता से संपर्क करता है कुंजी है, जिसका इस्तेमाल टोकन जनरेट करने के लिए किया गया था.
- ऐसे एपीआई प्रॉडक्ट की सूची फिर से पाएं जिनसे उपभोक्ता कुंजी जुड़ी हुई है.
- पुष्टि करें कि एपीआई प्रॉडक्ट में मौजूदा एपीआई प्रॉक्सी शामिल किया गया है और अगर मौजूदा एपीआई प्रॉडक्ट पर संसाधन पाथ (यूआरएल पाथ) चालू किया गया है.
- पुष्टि करें कि उपभोक्ता कुंजी की समयसीमा खत्म न हुई हो या उसे निरस्त न किया गया हो, देखें कि ऐप्लिकेशन को रद्द तो नहीं किया गया है, और देखें कि ऐप्लिकेशन डेवलपर ऐक्टिव है या नहीं.
अगर ऊपर बताई गई सभी जांच पूरी हो जाती हैं, तो क्रेडेंशियल की पुष्टि हो जाएगी.
सबसे नीचे, Edge अपने-आप उपभोक्ता कुंजियां जनरेट करता है, लेकिन एपीआई पब्लिशर को सही नीतियों का इस्तेमाल करके, एपीआई प्रॉक्सी में कुंजी की जांच लागू करें.
ऑटोमैटिक बनाम मैन्युअल मंज़ूरी
डिफ़ॉल्ट रूप से, किसी ऐप्लिकेशन से एपीआई प्रॉडक्ट ऐक्सेस करने के लिए पासकोड पाने के सभी अनुरोध अपने-आप स्वीकार हो जाते हैं. इसके अलावा, आपके पास ये विकल्प हैं कुंजियों को मैन्युअल रूप से अनुमति देने के लिए, एपीआई प्रॉडक्ट को कॉन्फ़िगर करें. इस स्थिति में, आपको उन सभी ऐप्लिकेशन के मुख्य अनुरोधों को मंज़ूरी देनी होगी जो को ट्रैक किया जा सकता है. ज़्यादा जानकारी के लिए, ऐप्लिकेशन रजिस्टर करें और एपीआई मैनेज करें देखें कुंजियां.
कोटा
कोटा से आपके बैकएंड सर्वर की सुरक्षा, बेहतर ट्रैफ़िक के लिए की जा सकती है. साथ ही, आपकी प्रॉडक्ट लाइन को अलग से दिखाया जा सकता है. उदाहरण के लिए, हो सकता है कि आप प्रीमियम प्रॉडक्ट के तौर पर, संसाधनों को ज़्यादा कोटा वाले बंडल के साथ इस्तेमाल करना चाहें बेसिक प्रॉडक्ट वाले बंडल के लिए कम कोटे वाला हो. कोटा आपके सर्वर की सुरक्षा कर सकता है, अगर कोई प्रॉडक्ट लोकप्रिय है और बड़ी संख्या में अनुरोध मिल रहे हैं, तो परेशानी हो सकती है.
कोटा कॉन्फ़िगर करने के बारे में जानकारी पाने के लिए, कोटा की नीति देखें. इस पर जानकारी के लिए कोटा नीतियों में प्रॉडक्ट कोटा सेटिंग का इस्तेमाल करने के बारे में जानने के लिए, यह समुदाय लेख पढ़ें किसी एपीआई प्रॉडक्ट की कोटा सेटिंग, एपीआई प्रॉक्सी में कोटा की नीतियों के साथ कैसे इंटरैक्ट करती है?.
OAuth के दायरे
सुरक्षा के अतिरिक्त लेवल के तौर पर, किसी भी OAuth दायरे को कॉमा लगाकर अलग की गई सूची के तौर पर, जो प्रॉडक्ट के ज़रिए भेजे गए ऐक्सेस टोकन में मौजूद होना चाहिए. प्रॉडक्ट बनाते समय, आपको अपने संगठन के सभी दायरों की जानकारी होनी चाहिए. वे स्कोप जिन्हें आपने किसी प्रॉडक्ट में जोड़ा है को मौजूदा स्कोप से मैच करना चाहिए. ऐसा न करने पर, प्रॉडक्ट सुरक्षित नहीं है.
Edge OAuth नीतियों के साथ स्कोप का इस्तेमाल करने के बारे में ज़्यादा जानकारी के लिए, OAuth2 स्कोप के साथ काम करना लेख पढ़ें.
ऐक्सेस लेवल
किसी एपीआई प्रॉडक्ट को परिभाषित करते समय, ये ऐक्सेस लेवल सेट किए जा सकते हैं.
| पहुंच स्तर | ब्यौरा |
|---|---|
| सार्वजनिक | ऐसे एपीआई प्रॉडक्ट जो सभी डेवलपर के लिए उपलब्ध हैं. इन्हें इंटिग्रेट किए गए या Drupal पर आधारित डेवलपर पोर्टल में जोड़ा जा सकता है. |
| निजी या सिर्फ़ अंदरूनी | निजी या आंतरिक उपयोग के लिए डिज़ाइन किए गए API प्रॉडक्ट. ध्यान दें: निजी और सिर्फ़ संगठन के इस्तेमाल के लिए ऐक्सेस लेवल में कोई अंतर नहीं है. वह लेबल चुनें जो एपीआई प्रॉडक्ट की टारगेट ऑडियंस के बारे में सबसे सही जानकारी देता हो. इंटिग्रेट किए गए पोर्टल के लिए, निजी या सिर्फ़ इंटरनल एपीआई प्रॉडक्ट जोड़े जा सकते हैं. साथ ही, ज़रूरत के मुताबिक उन्हें ऐप्लिकेशन डेवलपर को उपलब्ध कराया जा सकता है. Drupal पर आधारित डेवलपर पोर्टल के लिए, अपने डेवलपर पोर्टल पर निजी या सिर्फ़ इंटरनल एपीआई वाले प्रॉडक्ट का ऐक्सेस मैनेज किया जा सकता है. इसका तरीका नीचे बताया गया है:
|