दूसरा भाग: एपीआई पासकोड जनरेट करना और उसकी जांच करना

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

रीफ़ैक्टर किया गया और एपीआई पासकोड को ज़रूरी बनाकर, एपीआई को सुरक्षित करें पर रीडायरेक्ट किया गया.

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

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

1. Apigee Edge पर, ऐसे एपीआई प्रॉडक्ट बनाएं जो आपके एपीआई को बंडल करते हैं.
2. Edge पर ऐप्लिकेशन डेवलपर को रजिस्टर करें. सिर्फ़ रजिस्टर किया गया ऐप्लिकेशन डेवलपर ही ऐप्लिकेशन को रजिस्टर कर सकता है.
3. एपीआई प्रॉडक्ट ऐक्सेस करने के लिए, डेवलपर Edge पर ऐप्लिकेशन रजिस्टर करते हैं. इसके जवाब में, डेवलपर को एक एपीआई पासकोड मिलता है. अब डेवलपर के पास एपीआई पासकोड हो गया है, इसलिए वह आपके एपीआई को अनुरोध भेज सकता है.

ज़्यादा जानकारी के लिए, पब्लिश करने के बारे में जानकारी देखें.

इस टेबल में, ऐप्लिकेशन रजिस्टर करने और पासकोड जनरेट करने में इस्तेमाल होने वाले कुछ शब्दों के बारे में बताया गया है:

शब्द	परिभाषा
एपीआई प्रॉडक्ट	सेवा प्लान के साथ एपीआई प्रॉक्सी का बंडल, जो उन एपीआई के ऐक्सेस की सीमाएं सेट करता है. एपीआई प्रॉडक्ट वह मुख्य तरीका है जिसका इस्तेमाल Apigee Edge, आपके एपीआई को ऐक्सेस करने और अनुमति देने के लिए करता है.
डेवलपर	API (एपीआई) उपभोक्ता. डेवलपर ऐसे ऐप्लिकेशन लिखते हैं जो आपके एपीआई के लिए अनुरोध करते हैं.
ऐप्लिकेशन	ऐसा क्लाइंट-साइड ऐप्लिकेशन जिसे डेवलपर, एपीआई प्रॉडक्ट को ऐक्सेस करने के लिए रजिस्टर करता है. ऐप्लिकेशन को एपीआई प्रॉडक्ट के साथ रजिस्टर करने से, उस प्रॉडक्ट में एपीआई को ऐक्सेस करने के लिए, एपीआई पासकोड जनरेट होता है.
एपीआई पासकोड	अनुमति से जुड़ी जानकारी वाली इस स्ट्रिंग का इस्तेमाल करके, क्लाइंट-साइड ऐप्लिकेशन उन संसाधनों को ऐक्सेस करता है जिन्हें एपीआई प्रॉडक्ट ने दिखाया है. एपीआई पासकोड तब जनरेट होता है, जब रजिस्टर किया गया कोई ऐप्लिकेशन, किसी एपीआई प्रॉडक्ट से जुड़ा होता है.

इस ट्यूटोरियल के लिए ज़रूरी शर्तें

इस ट्यूटोरियल में यह माना गया है कि आपने पहला ट्यूटोरियल पूरा कर लिया है. इसमें, Yahoo मौसम API को ऐक्सेस करने के लिए, एपीआई प्रॉक्सी बनाई जाती है. अगर आपने अभी तक पहला ट्यूटोरियल पूरा नहीं किया है, तो एपीआई पासकोड ज़रूरी करके, एपीआई को सुरक्षित करना देखें.

पहला चरण: एपीआई प्रॉडक्ट बनाना

1. मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) में, पब्लिश करें टैब पर क्लिक करें. इसके बाद, प्रॉडक्ट पर क्लिक करें.
2. (+) प्रॉडक्ट पर क्लिक करें.
3. 'प्रॉडक्ट जोड़ें' डायलॉग फ़ील्ड में इन्हें डालें या चुनें:

   फ़ील्ड	वैल्यू
   नाम	मुफ़्त API प्रॉडक्ट
   डिसप्ले नाम	मुफ़्त API प्रॉडक्ट
   ब्यौरा	मुफ़्त API प्रॉडक्ट
   एनवायरमेंट	जांच
   ऐक्सेस	सिर्फ़ संगठन में काम करने वालों के लिए है
   कुंजी की अनुमति का टाइप	अपने-आप (एपीआई पासकोड जनरेट होने के बाद, उसे अपने-आप मंज़ूरी मिल जाती है)
   अनुरोध भेजने की तय सीमा (कोटा)	हर 1 घंटे में 10 अनुरोध (अनुरोधों की संख्या को 10 प्रति घंटे पर सीमित करता है)
   अनुमति वाले OAuth स्कोप	खाली छोड़ें

   भरा हुआ डायलॉग इस तरह दिखना चाहिए:

   

4. संसाधन सेक्शन में, चुनें:
   • एपीआई प्रॉक्सी: weatherapikey
   • बदलाव: 1
   • संसाधन पाथ: /forecastrss**
     
     संसाधन पाथ, संसाधन के उस यूआरआई के बारे में बताता है जिसे प्रॉडक्ट किसी ऐप्लिकेशन को ऐक्सेस करने की अनुमति देता है. इस उदाहरण में, कोई ऐप्लिकेशन इस एपीआई प्रॉडक्ट से, weatherapikey प्रॉक्सी पर सिर्फ़ /forecastrss संसाधन ऐक्सेस कर सकता है. इस एपीआई प्रॉडक्ट को इस्तेमाल करके, Weatherapi कुकी प्रॉक्सी पर या किसी अन्य प्रॉक्सी पर मौजूद किसी अन्य रिसॉर्स को ऐक्सेस करने की अनुमति नहीं है.
     
     रिसॉर्स पाथ के लिए, वाइल्डकार्ड वर्ण इस्तेमाल किए जा सकते हैं. वाइल्डकार्ड "/**" से पता चलता है कि सभी सब-यूआरआई शामिल किए गए हैं, जिसका मतलब है /forecastrss/foo/bar के रूप में संसाधन. वाइल्डकार्ड "/" से पता चलता है कि सिर्फ़ एक लेवल डाउन वाले यूआरआई शामिल किए गए हैं. ज़्यादा जानकारी के लिए, एपीआई प्रॉडक्ट बनाना देखें.
     
     ध्यान दें कि संसाधन पाथ की ड्रॉपडाउन सूची में, एपीआई प्रॉक्सी पर तय किए गए सभी कंडिशनल फ़्लो दिखते हैं. एपीआई प्रॉक्सी का कंडिशनल फ़्लो, संसाधन पाथ से जुड़े लॉजिक या प्रोसेसिंग के चरणों के बारे में बताता है. एपीआई प्रॉडक्ट, उन रिसॉर्स पाथ के ऐक्सेस को कंट्रोल करता है.
     
5. संसाधन इंपोर्ट करें पर क्लिक करें. रिसॉर्स पाथ जोड़ा जाता है और Weatherapikey एपीआई प्रॉक्सी अपने-आप प्रॉडक्ट के लिए एपीआई प्रॉक्सी सेक्शन में जुड़ जाता है.
6. सेव करें पर क्लिक करें. आपके नए प्रॉडक्ट की जानकारी, प्रॉडक्ट पेज पर दी गई है.

ज़्यादा जानें:

• एपीआई प्रॉडक्ट बनाएं

दूसरा चरण: डेवलपर को रजिस्टर करना

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

1. मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) में, पब्लिश करें टैब पर क्लिक करें. इसके बाद, डेवलपर पर क्लिक करें.
2. (+) डेवलपर पर क्लिक करें.
3. नए डेवलपर डायलॉग में, ये वैल्यू डालें:
   • नाम: जेन
   • सरनेम: ट्यूटोरियल
   • ईमेल पता: janetutorial@example.com
   • उपयोगकर्ता नाम: jtutorial
4. सेव करें पर क्लिक करें. नया डेवलपर, डेवलपर पेज पर मौजूद डेवलपर की सूची में दिखता है.

ज़्यादा जानें:

• ऐप्लिकेशन डेवलपर को मैनेज करना

तीसरा चरण: ऐप्लिकेशन को रजिस्टर करना

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

1. एपीआई प्लैटफ़ॉर्म के यूज़र इंटरफ़ेस (यूआई) में, पब्लिश करें टैब पर क्लिक करें. इसके बाद, डेवलपर ऐप्लिकेशन पर क्लिक करें.
2. (+) डेवलपर ऐप्लिकेशन पर क्लिक करें.
3. 'ऐप्लिकेशन जोड़ें' डायलॉग में, ये वैल्यू डालें:
   • डिसप्ले नेम: Weather API Key ऐप्लिकेशन
   • डेवलपर: जेन ट्यूटोरियल (janetutorial@example.com)
   • कॉलबैक यूआरएल: खाली छोड़ें
4. ऐप्लिकेशन को किसी प्रॉडक्ट से जोड़ें:
   1. प्रॉडक्ट सेक्शन में, + प्रॉडक्ट पर क्लिक करें.
   2. मुफ़्त एपीआई प्रॉडक्ट चुनें.
   3. बदलावों को स्वीकार करने के लिए, सही का निशान आइकॉन पर क्लिक करें.
5. सेव करें पर क्लिक करें. नया ऐप्लिकेशन, डेवलपर ऐप्लिकेशन पेज पर मौजूद ऐप्लिकेशन की सूची में दिखता है.
6. ऐप्लिकेशन की सूची में, Weather API Key ऐप्लिकेशन चुनें. इससे ऐप्लिकेशन की ज़्यादा जानकारी वाला पेज खुलेगा.
7. एपीआई प्रॉडक्ट बनाते समय आपने मुख्य अनुमति का टाइप: अपने-आप चुना था, इसलिए एपीआई पासकोड को अपने-आप मंज़ूरी मिल जाती है और उसे तुरंत देखा जा सकता है. (अगर आपने मंज़ूरी का टाइप: मैन्युअल चुना था, तो एपीआई पासकोड को मंज़ूरी देने के लिए, आपको Free API प्रॉडक्ट के कार्रवाइयां कॉलम में स्वीकार करें पर क्लिक करना होगा.)
8. प्रॉडक्ट सेक्शन में, Free API Product की एंट्री के बगल में, जनरेट की गई कुंजियां देखने के लिए, उपभोक्ता कुंजी और उपभोक्ता सीक्रेट कॉलम में, दिखाएं पर क्लिक करें.
   

   उपभोक्ता कुंजी, API (एपीआई) कुंजी का दूसरा नाम है और यही एक कुंजी है, जो किसी ऐप्लिकेशन को आपके एपीआई प्रॉक्सी के ज़रिए पूर्वानुमान के संसाधन को ऐक्सेस करने की ज़रूरत होती है . OAuth 2.0 के ज़रिए एपीआई को सुरक्षित करने के लिए, उपभोक्ता कुंजी के साथ-साथ उपभोक्ता सीक्रेट की भी ज़रूरत होती है. उदाहरण के लिए, OAuth 2.0: नया एपीआई प्रॉक्सी कॉन्फ़िगर करना देखें.

ज़्यादा जानें:

• ऐप्लिकेशन रजिस्टर करें और एपीआई कुंजियां मैनेज करें.

चौथा चरण: अनुरोध में एपीआई पासकोड का इस्तेमाल करना

यह पक्का करने के लिए कि AdvertiserAPIKey नीति सही तरीके से काम कर रही है, आपको इसकी जांच करनी होगी. इसके लिए, आपको मान्य एपीआई पासकोड की मदद से, एपीआई प्रॉक्सी को कॉल करना होगा. एपीआई प्रॉक्सी का अनुरोध किसी ब्राउज़र में, एपीआई प्रॉक्सी के ट्रेस पेज से, Apigee कंसोल से या cURL का इस्तेमाल करके किया जा सकता है. अनुरोध करने के लिए यूआरएल इस फ़ॉर्म में होता है:

http://{org-name}-test.apigee.net/v1/weatherapikey/forecastrss?w=12797282&apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVls

अपने Apigee संगठन के नाम की जगह, {org-name} और apikey की सही वैल्यू डालें.

जवाब में यह कॉन्टेंट देखें:

<rss xmlns:yweather="http://xml.weather.yahoo.com/ns/rss/1.0" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" version="2.0"> 
<channel> <title>Yahoo! Weather - Palo Alto, CA</title> 
<link>http://us.rd.yahoo.com/dailynews/rss/weather/Palo_Alto__CA/*http://weather.yahoo.com/forecast/USCA1093_f.html</link> 
<description>Yahoo! Weather for Palo Alto, CA</description> <language>en-us</language>

अगर एपीआई पासकोड को अनुरोध से हटा दिया जाता है या अमान्य वैल्यू दी जाती है, तो आपको इस फ़ॉर्म में गड़बड़ी का मैसेज मिलेगा:

{"fault":{"faultstring":"Failed to resolve API Key variable null","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

पांचवां चरण: आगे कहां जाना है?

अब आपने एपीआई पासकोड को पास करने के लिए क्वेरी पैरामीटर का इस्तेमाल करके, एपीआई को अनुरोध किया है. इसलिए, पासकोड को हेडर के तौर पर पास करने के लिए, एपीआई में बदलाव करें.

एपीआई पासकोड की मदद से, एपीआई को सुरक्षित करना पर जाएं.