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

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

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

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

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

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

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

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

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

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

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

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

   उदाहरण के लिए, अगर आपने "संगीत" जोड़ा है, /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 अडैप्टर के लिए ऑपरेशन गाइड देखें.

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

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

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 पर सेट करें. Cloud के ग्राहक यह अनुरोध कर सकते हैं Apigee Edge की सहायता टीम से संपर्क करें.

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

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

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

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

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

Public Cloud के लिए Apigee Edge की मदद से, Edge हर उपयोगकर्ता के लिए ऐक्सेस करने के बाद, कम से कम 180 सेकंड तक कैश मेमोरी में मौजूद इन इकाइयों को चुनें.

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

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

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

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

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