एपीआई प्रॉडक्ट को मैनेज करें

Apigee Edge दस्तावेज़ देखा जा रहा है.
Apigee X दस्तावेज़ पर जाएं. जानकारी

इस सेक्शन में बताए गए तरीके से, Apigee Edge मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, एपीआई प्रॉडक्ट मैनेज करें. एपीआई का इस्तेमाल करके एपीआई प्रॉडक्ट मैनेज करने के लिए, एपीआई पब्लिश करने के लिए Edge मैनेजमेंट एपीआई का इस्तेमाल करना देखें.

एपीआई प्रॉडक्ट के बारे में खास जानकारी के लिए, एपीआई प्रॉडक्ट क्या है? देखें.

एपीआई प्रॉडक्ट पेज एक्सप्लोर करें

नीचे बताए गए तरीके का इस्तेमाल करके, एपीआई प्रॉडक्ट के पेज को ऐक्सेस करें.

एपीआई प्रॉडक्ट जोड़ना

नीचे बताए गए तरीके का इस्तेमाल करके, यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके एपीआई प्रॉडक्ट जोड़ें. Edge API का इस्तेमाल करने के लिए, एपीआई का इस्तेमाल करके एपीआई प्रॉडक्ट कॉन्फ़िगर करना देखें.

Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके एपीआई प्रॉडक्ट जोड़ने के लिए:

1. इस सेक्शन में पहले बताए गए तरीके से एपीआई प्रॉडक्ट के पेज को ऐक्सेस करें.
2. +एपीआई प्रॉडक्ट पर क्लिक करें.
3. अपने एपीआई प्रॉडक्ट के लिए प्रॉडक्ट की जानकारी डालें.
   

   फ़ील्ड	ब्यौरा
   नाम	एपीआई प्रॉडक्ट का इंटरनल नाम. एपीआई प्रॉडक्ट बनाने के बाद, नाम में बदलाव नहीं किया जा सकता. नाम में खास वर्ण न डालें.
   डिसप्ले नेम	एपीआई प्रॉडक्ट के लिए डिसप्ले नेम. डिसप्ले नेम का इस्तेमाल यूज़र इंटरफ़ेस (यूआई) में किया गया है. इसमें किसी भी समय बदलाव किया जा सकता है. अगर यह जानकारी नहीं दी गई है, तो Name की वैल्यू का इस्तेमाल किया जाएगा. इस फ़ील्ड में नाम की वैल्यू अपने-आप भर जाती है. आपके पास इसके कॉन्टेंट में बदलाव करने या इसे मिटाने का विकल्प होता है. डिसप्ले नेम में खास वर्ण शामिल हो सकते हैं.
   ब्यौरा	एपीआई प्रॉडक्ट के बारे में जानकारी.
   एनवायरमेंट	ऐसे एनवायरमेंट जिन्हें एपीआई प्रॉडक्ट ऐक्सेस करने की अनुमति देगा. उदाहरण के लिए, test या prod.
   ऐक्सेस	ऐक्सेस लेवल. ज़्यादा जानकारी के लिए, ऐक्सेस लेवल देखें.
   ऐक्सेस के अनुरोध अपने-आप स्वीकार करें	इस एपीआई प्रॉडक्ट के मुख्य अनुरोधों के लिए, किसी भी ऐप्लिकेशन से अपने-आप अनुमति लेने की सुविधा चालू करती है. कुंजी को मैन्युअल तौर पर मंज़ूरी देने के लिए, इस विकल्प को बंद करें. ऐप्लिकेशन रजिस्टर करना और एपीआई पासकोड मैनेज करना (यूज़र इंटरफ़ेस) और डेवलपर ऐप्लिकेशन पासकोड (एपीआई) देखें.
   अनुरोध भेजने की तय सीमा (कोटा)	कोटा की वह सीमा जिसका रेफ़रंस आपको कोटा की नीतियों से देना है. कोटा वैल्यू डालने से, प्रॉडक्ट से किए जाने वाले कॉल की संख्या पर अपने-आप पाबंदियां लागू नहीं होती. प्रॉडक्ट के बारे में दी गई एपीआई प्रॉक्सी में कोटा लागू करने के लिए, कोटा नीति शामिल होनी चाहिए. ज़्यादा जानकारी के लिए, कोटा देखें.
   अनुमति वाले OAuth स्कोप	अगर एपीआई प्रॉडक्ट के साथ OAuth का इस्तेमाल किया जा रहा है, तो आपको अनुमति वाले OAuth स्कोप की अनुमति देनी होगी. उदाहरण के लिए, पढ़ें या ऐसे अन्य स्कोप जिन्हें ऐप्लिकेशन, एपीआई कॉल के साथ भेजेंगे. एक से ज़्यादा दायरे को कॉमा लगाकर अलग की गई सूची के तौर पर बताएं. OAuth के दायरे देखें.

4. एपीआई प्रॉडक्ट में मौजूद एपीआई रिसॉर्स जोड़ें. इसमें एपीआई प्रॉक्सी और रिसॉर्स पाथ भी शामिल हैं.

   उदाहरण के लिए, अगर आपने /music के बेस पाथ वाले प्रॉडक्ट में "music" एपीआई प्रॉक्सी जोड़ा है, तो एपीआई प्रॉडक्ट /music पर कॉल करने की अनुमति देता है. हालांकि, अगर आपको एपीआई प्रॉडक्ट सिर्फ़ venues रिसॉर्स पाथ का ऐक्सेस देना है, जिसमें /music/venues यूआरआई है, तो प्रॉडक्ट में /venues रिसॉर्स पाथ जोड़ें. इस मामले में, /music/venues?name=paramount पर किए जाने वाले कॉल की अनुमति है, लेकिन /music/artists?name=Jack%Johnson पर किए जाने वाले कॉल ब्लॉक कर दिए जाएंगे.

   रिसॉर्स पाथ को / के तौर पर सेट करके, किसी खास रिसॉर्स पाथ को सेट करें या बेस पाथ और सभी संभावित सबपाथ सेट करें. रिसॉर्स पाथ में, वाइल्डकार्ड /** और /* शामिल हो सकते हैं. दो तारों वाला वाइल्डकार्ड बताता है कि बेस पाथ के सभी सबपाथ काम करते हैं, लेकिन बेस पाथ के साथ नहीं. तारे के निशान से पता चलता है कि बेस पाथ से सिर्फ़ एक लेवल नीचे वाले यूआरआई को इस्तेमाल किया जा सकता है. इस सेक्शन में, '/', '/*', और '/**' के रिसॉर्स पाथ के व्यवहार को कॉन्फ़िगर करने का तरीका देखें.

   एपीआई संसाधन जोड़ने के लिए:

   1. एपीआई रिसॉर्स सेक्शन में, प्रॉक्सी जोड़ें या पाथ जोड़ें पर क्लिक करें.
   2. चुनें कि आपको एपीआई प्रॉक्सी, पाथ या एपीआई प्रॉक्सी और पाथ, दोनों जोड़ने हैं.

      

   3. एक या उससे ज़्यादा एपीआई प्रॉक्सी और संसाधन पाथ जोड़ें.

      निम्न पर ध्यान दें:

      • आपके तय किए गए रिसॉर्स पाथ, एपीआई प्रॉडक्ट में जोड़े गए सभी एपीआई प्रॉक्सी पर लागू होते हैं.
      • ऐसे रिसॉर्स पाथ जिन पर ज़्यादा जानकारी इकट्ठा की जाती है और जिनके बारे में कम शब्दों में बताया जाता है, दोनों को ज़्यादा सटीक माना जाता है. उदाहरण के लिए, / और /** जोड़ने पर, / रिसॉर्स पाथ को प्राथमिकता दी जाएगी. /** रिसॉर्स पाथ को अनदेखा कर दिया जाएगा.

      उदाहरण के लिए:

      

   4. एपीआई के अन्य संसाधनों के बारे में बताने के लिए, जोड़ें या अन्य जोड़ें और शुरू करें पर क्लिक करें.
5. (ज़रूरी नहीं) प्रॉडक्ट को एक या उससे ज़्यादा रिमोट सेवा के टारगेट से जोड़ने के लिए, Apigee रिमोट सेवा के टारगेट सेक्शन का इस्तेमाल करें. जब तक Apigee Envoy अडैप्टर का इस्तेमाल नहीं किया जा रहा है, इस सेटिंग को अनदेखा किया जा सकता है. ज़्यादा जानकारी के लिए, Apigee Envoy Adapter की ऑपरेशन गाइड देखें.

6. (ज़रूरी नहीं) एपीआई प्रॉडक्ट में ज़्यादा से ज़्यादा 18 कस्टम एट्रिब्यूट जोड़ने के लिए, कस्टम एट्रिब्यूट सेक्शन का इस्तेमाल करें.

   कस्टम एट्रिब्यूट ऐसे कुंजी/वैल्यू पेयर होते हैं जिन्हें कई तरीकों से इस्तेमाल किया जा सकता है. इनमें, एपीआई प्रॉक्सी के एक्ज़ीक्यूशन को कंट्रोल करने में मदद करना शामिल है. उदाहरण के लिए, सही या गलत वैल्यू के साथ, deprecated नाम का एक कस्टम एट्रिब्यूट बनाया जा सकता है. एपीआई प्रॉक्सी फ़्लो में, एपीआई प्रॉडक्ट के deprecated एट्रिब्यूट की वैल्यू देखी जा सकती है. उदाहरण के लिए, verifyapikey.{policy_name}.apiproduct.deprecated वैरिएबल का इस्तेमाल किया जा सकता है, जो कस्टम एट्रिब्यूट बनाने के बाद अपने-आप उपलब्ध हो जाता है. अगर इसकी वैल्यू 'सही' पर सेट है (अब सेवा में नहीं है), तो गड़बड़ी बढ़ाने की नीति की मदद से गड़बड़ी का पता लगाया जा सकता है.

7. सेव करें पर क्लिक करें.

'/', '/*', और '/**' के रिसॉर्स पाथ के व्यवहार को कॉन्फ़िगर करना

नीचे दी गई टेबल में, अलग-अलग रिसॉर्स पाथ के लिए, एपीआई प्रॉडक्ट के डिफ़ॉल्ट व्यवहार के बारे में जानकारी दी गई है. इस उदाहरण में, एपीआई प्रॉक्सी का बेस पाथ /v1/weatherapikey है. एपीआई प्रॉडक्ट रिसॉर्स पाथ, बेस पाथ के बाद पाथ के सफ़िक्स पर लागू होता है.

अनुरोध URI	/ के लिए अनुमति है	/* के लिए अनुमति है	/** के लिए अनुमति है	/*/2/** के लिए अनुमति है	/*/2/* के लिए अनुमति है
/v1/weatherapikey	Y	नहीं	नहीं	नहीं	N
/v1/weatherapikey/	Y	नहीं	नहीं	नहीं	N
/v1/weatherapikey/1	Y	Y	हां	नहीं	N
/v1/weatherapikey/1/	Y	Y	हां	नहीं	N
/v1/weatherapikey/1/2	Y	नहीं	हां	नहीं	N
/v1/weatherapikey/1/2/	Y	नहीं	Y	हां	N
/v1/weatherapikey/1/2/3/	Y	नहीं	Y	Y	Y
/v1/weatherapikey/1/a/2/3/	Y	नहीं	हां	नहीं	N

एपीआई प्रॉडक्ट में, / का रिसॉर्स पाथ डिफ़ॉल्ट रूप से, बेस पाथ और सभी सबपाथ के साथ काम करता है. उदाहरण के लिए, अगर एपीआई प्रॉक्सी का बेस पाथ /v1/weatherapikey है, तो एपीआई प्रॉडक्ट, /v1/weatherapikey और किसी भी सबपाथ जैसे /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA वगैरह के अनुरोधों के साथ काम करता है.

इसे डिफ़ॉल्ट रूप से बदला जा सकता है, ताकि / का रिसॉर्स पाथ सिर्फ़ एपीआई प्रॉक्सी के बेस पाथ से मेल खाए. इसका मतलब है कि एपीआई प्रॉडक्ट, उस यूआरआई को ऐक्सेस करने की अनुमति नहीं देगा जिसमें / के बाद कुछ भी हो. अगर यह बदलाव किया जाता है, तो ऊपर दी गई टेबल में, "/ के लिए अनुमति है" के तहत सिर्फ़ पहली दो पंक्तियों में "Y" होगा.

डिफ़ॉल्ट सेटिंग बदलने के लिए, सिस्टम एडमिन को आपके संगठन की features.isSingleForwardSlashBlockingEnabled प्रॉपर्टी की वैल्यू true पर सेट करनी होगी. Cloud का इस्तेमाल करने वाले ग्राहक, Apigee Edge Support से यह अनुरोध कर सकते हैं.

एपीआई प्रॉडक्ट में बदलाव करना

एपीआई प्रॉडक्ट में बदलाव करने के लिए:

1. इस सेक्शन में पहले बताए गए तरीके से एपीआई प्रॉडक्ट के पेज को ऐक्सेस करें.
2. एपीआई प्रॉडक्ट की उस लाइन पर क्लिक करें जिसमें आपको बदलाव करना है.
3. एपीआई प्रॉडक्ट पेज पर, बदलाव करें पर क्लिक करें.
4. ज़रूरत के हिसाब से फ़ील्ड में बदलाव करें.

   आपके पास उन संसाधनों को मिटाने का विकल्प होता है जिन्हें आपने एपीआई प्रॉडक्ट में जोड़ा है. ऐसा तब किया जा सकता है, जब कोई संसाधन ठीक से काम न कर रहा हो या उसे बेहतर बनाने की ज़रूरत हो. इसे मिटाने के बाद, वह संसाधन एपीआई प्रॉडक्ट का हिस्सा नहीं रहता. एपीआई प्रॉडक्ट का इस्तेमाल करने वाला कोई भी ऐप्लिकेशन, मिटाए गए संसाधन को ऐक्सेस नहीं कर पाएगा. मिटाए गए संसाधन प्रॉडक्ट से हटा दिए जाते हैं, लेकिन सिस्टम से नहीं मिटाए जाते. इसलिए, उन्हें दूसरे प्रॉडक्ट अब भी इस्तेमाल कर सकते हैं.

5. सेव करें पर क्लिक करें.

Apigee Edge for Public Cloud की मदद से, इकाइयों के ऐक्सेस होने के बाद, Edge नीचे दी गई इकाइयों को कम से कम 180 सेकंड तक कैश मेमोरी में रखता है.

• OAuth ऐक्सेस टोकन. इसका मतलब है कि रद्द किया गया टोकन, कैश मेमोरी की समयसीमा खत्म होने तक तीन मिनट तक काम कर सकता है.
• कुंजी मैनेज करने वाली सेवा (केएमएस) की इकाइयां (ऐप्लिकेशन, डेवलपर, एपीआई प्रॉडक्ट).
• OAuth टोकन और केएमएस इकाइयों पर कस्टम एट्रिब्यूट.

किसी एपीआई प्रॉडक्ट को मिटाना

एपीआई प्रॉडक्ट को मिटाने से पहले, आपको उस प्रॉडक्ट से जुड़े डेवलपर ऐप्लिकेशन का रजिस्ट्रेशन रद्द या अनलिंक करना होगा. ऐसा करने के लिए, या तो ऐप्लिकेशन को मिटाएं या ऐप्लिकेशन एपीआई पासकोड को वापस लें.

एपीआई के किसी प्रॉडक्ट को मिटाने के लिए:

1. इस सेक्शन में पहले बताए गए तरीके से एपीआई प्रॉडक्ट के पेज को ऐक्सेस करें.
2. सूची में कर्सर को एपीआई प्रॉडक्ट पर रखें.
3. पर क्लिक करें.
4. मिटाने की कार्रवाई की पुष्टि करने के लिए, मिटाएं पर क्लिक करें.