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

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

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

एपीआई प्रॉडक्ट की खास जानकारी के लिए, एपीआई प्रॉडक्ट क्या होता है? लेख पढ़ें.

एपीआई प्रॉडक्ट के पेज पर जाएं

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

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

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

Edge UI का इस्तेमाल करके एपीआई प्रॉडक्ट जोड़ने के लिए:

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

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

4. एपीआई प्रॉडक्ट में उपलब्ध एपीआई संसाधन जोड़ें. इनमें एपीआई प्रॉक्सी और संसाधन पाथ शामिल हैं.

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

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

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

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

      

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

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

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

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

      

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Apigee Edge for Public Cloud के साथ, Edge इन इकाइयों को कम से कम 180 सेकंड के लिए कैश मेमोरी में सेव रखता है. ऐसा तब होता है, जब इन इकाइयों को ऐक्सेस किया जाता है.

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

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

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

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

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