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

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

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

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

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

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

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

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

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

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

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

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

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

    डेटा भरने के बाद डायलॉग बॉक्स ऐसा दिखना चाहिए:

  4. संसाधन सेक्शन में जाकर, इनमें से कोई विकल्प चुनें:
    • एपीआई प्रॉक्सी: weatherapikey
    • बदलाव: 1
    • संसाधन का पाथ: /forecastrss**

      संसाधन के पाथ से उन संसाधन यूआरआई के बारे में पता चलता है जिन्हें प्रॉडक्ट, किसी ऐप्लिकेशन को ऐक्सेस करने की अनुमति देता है. इस उदाहरण में, कोई ऐप्लिकेशन इस एपीआई प्रॉडक्ट के ज़रिए, weatherapikey प्रॉक्सी पर मौजूद /forecastrss रिसॉर्स को ही ऐक्सेस कर सकता है. weatherapiproxy प्रॉक्सी या किसी अन्य प्रॉक्सी पर मौजूद किसी अन्य संसाधन को ऐक्सेस करने के लिए, इस एपीआई प्रॉडक्ट का इस्तेमाल करने की कोशिश करना मना है.

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

      ध्यान दें कि संसाधन का पाथ ड्रॉपडाउन सूची में, तय की गई एपीआई प्रॉक्सी पर तय किए गए सभी शर्त वाले फ़्लो दिखते हैं. एपीआई प्रॉक्सी के कंडीशनल फ़्लो से, किसी संसाधन पाथ से जुड़े लॉजिक या प्रोसेसिंग के चरणों के बारे में पता चलता है. एपीआई प्रॉडक्ट, उन संसाधन पाथ के ऐक्सेस को कंट्रोल करता है.
  5. संसाधन इंपोर्ट करें पर क्लिक करें. संसाधन का पाथ जोड़ दिया जाता है. साथ ही, weatherapikey एपीआई प्रॉक्सी को प्रॉडक्ट के लिए एपीआई प्रॉक्सी सेक्शन में अपने-आप जोड़ दिया जाता है.
  6. सेव करें पर क्लिक करें. आपका नया प्रॉडक्ट, 'प्रॉडक्ट' पेज पर दिखता है.

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

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

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

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

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

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

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

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

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

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

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

यह पक्का करने के लिए कि VerifyAPIKey नीति सही तरीके से काम कर रही है, आपको इसकी जांच करनी होगी. इसके लिए, मान्य एपीआई पासकोड का इस्तेमाल करके एपीआई प्रॉक्सी को कॉल करें. एपीआई प्रॉक्सी का अनुरोध, ब्राउज़र में किया जा सकता है. इसके लिए, एपीआई प्रॉक्सी के Trace पेज, Apigee Console या 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"}}}

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

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

इसके बाद, एपीआई पासकोड की ज़रूरत होने पर, एपीआई को सुरक्षित करें पर जाएं.