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

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

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

शुरुआती जानकारी

ऐप्लिकेशन रजिस्ट्रेशन से यह कंट्रोल करने का मुख्य तरीका मिलता है कि आपके एपीआई को कौन ऐक्सेस कर सकता है.

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

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

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

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

'ऐप्लिकेशन' पेज एक्सप्लोर करना

जैसा कि नीचे बताया गया है, ऐप्लिकेशन पेज को ऐक्सेस करें और उसे एक्सप्लोर करें.

Edge

Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके 'ऐप्लिकेशन' पेज ऐक्सेस करने के लिए:

  1. apigee.com/edge में साइन इन करें.
  2. बाएं नेविगेशन बार में, पब्लिश करें > ऐप्लिकेशन चुनें.

ऐसा करने पर, 'ऐप्लिकेशन' पेज दिखेगा.

जैसा कि ऊपर दिखाए गए डायग्राम में बताया गया है, ऐप्लिकेशन पेज से ये काम किए जा सकते हैं:

क्लासिक एज (प्राइवेट क्लाउड)

क्लासिक Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके 'ऐप्लिकेशन' पेज ऐक्सेस करने के लिए:

  1. http://ms-ip:9000 में साइन इन करें. यहां ms-ip, मैनेजमेंट सर्वर नोड का आईपी पता या डीएनएस नाम है.
  2. सबसे ऊपर मौजूद नेविगेशन बार में, पब्लिश करें > डेवलपर ऐप्लिकेशन चुनें.

आपको डेवलपर ऐप्लिकेशन पेज दिखेगा.

ऐप्लिकेशन को रजिस्टर करना

ऐप्लिकेशन को इनमें से किसी एक तरीके का इस्तेमाल करके रजिस्टर किया जा सकता है:

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

रजिस्टर किए गए ऐप्लिकेशन इसमें जोड़ दिए जाते हैं:

Edge में किसी ऐप्लिकेशन को रजिस्टर करने के लिए:

  1. ऐप्लिकेशन पेज ऐक्सेस करें.
  2. + ऐप्लिकेशन पर क्लिक करें.
  3. ऐप्लिकेशन के बारे में जानकारी दें:
    फ़ील्ड ब्यौरा ज़रूरी है?
    नाम ऐप्लिकेशन का नाम. ऐप्लिकेशन बनाने के बाद, उसका नाम नहीं बदला जा सकता. इस नाम का इस्तेमाल मैनेजमेंट एपीआई कॉल में किया जाता है. हां
    डिसप्ले नाम उस ऐप्लिकेशन का डिसप्ले नेम जो Edge मैनेजमेंट यूज़र इंटरफ़ेस और डेवलपर पोर्टल में दिखता है. नहीं
    कंपनी/डेवलपर

    ध्यान दें: Apigee हाइब्रिड, कंपनी के ऐप्लिकेशन के साथ काम नहीं करता. यह फ़ील्ड लागू नहीं होता.

    कंपनी या डेवलपर चुनें और ड्रॉप-डाउन से कंपनी या डेवलपर का नाम चुनें.
    ध्यान दें: परफ़ॉर्मेंस की वजहों से, सभी कंपनियों या डेवलपर को ड्रॉप-डाउन में नहीं दिखाया जाता. खोज बॉक्स में कंपनी का नाम, डेवलपर का नाम या ईमेल टाइप करें. ऐप्लिकेशन डेवलपर रजिस्टर करें भी देखें.

    		 हां
    कॉलबैक यूआरएल आम तौर पर, इससे ऐसे ऐप्लिकेशन का यूआरएल तय होता है जिसे क्लाइंट ऐप्लिकेशन की ओर से अनुमति कोड पाने के लिए तय किया जाता है. यह वैल्यू, एपीआई वाले सभी प्रॉडक्ट के लिए ज़रूरी नहीं है. नहीं
    ज़रूरी जानकारी ऐप्लिकेशन की जानकारी देने वाले नोट. नहीं
  4. क्रेडेंशियल की जानकारी दें. इसमें, एपीआई पासकोड के खत्म होने की तारीख और स्टेटस और उससे जुड़े एपीआई प्रॉडक्ट की जानकारी शामिल करें.
    क्रेडेंशियल सेक्शन में जाकर, पर क्लिक करें और यह जानकारी डालें:
    फ़ील्ड ब्यौरा
    निश्वासन ऐक्सेस खत्म होने की अवधि या तारीख को कॉन्फ़िगर करें या एपीआई पासकोड को कभी खत्म न होने के लिए सेट करें. इसके बाद, ठीक है पर क्लिक करें.
    प्रॉडक्ट एपीआई पासकोड के साथ एक या एक से ज़्यादा एपीआई प्रॉडक्ट जोड़ें:
    1. प्रॉडक्ट जोड़ें पर क्लिक करें.
    2. सूची से एक या उससे ज़्यादा एपीआई प्रॉडक्ट चुनें.
    3. जोड़ें पर क्लिक करें.
    4. हर एपीआई प्रॉडक्ट के लिए, स्थिति को 'स्वीकार किया गया' या 'रद्द किया गया' पर सेट करें.
    5. एपीआई वाले ज़्यादा प्रॉडक्ट जोड़ने के लिए, यह तरीका दोहराएं.
  5. कस्टम एट्रिब्यूट तय करें:
    1. कस्टम एट्रिब्यूट सेक्शन में, पर क्लिक करें.
    2. नाम और वैल्यू डालें.
    3. जोड़ें या एक और जोड़ें और शुरू करें पर क्लिक करें.
      ज़्यादा से ज़्यादा 18 कस्टम एट्रिब्यूट जोड़े जा सकते हैं.
  6. बनाएं पर क्लिक करें.

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

डेवलपर के लिए रजिस्टर किए गए ऐप्लिकेशन देखना

किसी खास डेवलपर के लिए रजिस्टर किए गए ऐप्लिकेशन देखने के लिए, नीचे दिए गए तरीकों में से किसी एक का इस्तेमाल करें:

कोई ऐप्लिकेशन देखना और उसमें बदलाव करना

कोई ऐप्लिकेशन देखने और उसमें बदलाव करने के लिए:

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

क्रेडेंशियल मैनेज करना

किसी ऐप्लिकेशन में बदलाव करते समय, क्रेडेंशियल सेक्शन में जाकर, उसके क्रेडेंशियल मैनेज किए जा सकते हैं. इसका उदाहरण नीचे दिया गया है:

जैसा कि पिछले चित्र में हाइलाइट किया गया है, क्रेडेंशियल सेक्शन में आप यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके नीचे दिए गए काम कर सकते हैं:

एपीआई का इस्तेमाल करके क्रेडेंशियल मैनेज करने के लिए, नीचे दिए गए सेक्शन देखें:

एपीआई पासकोड और सीक्रेट देखना

एपीआई पासकोड और सीक्रेट देखने के लिए:

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

एपीआई पासकोड को स्वीकार या रद्द करना

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

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

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

किसी API कुंजी को स्वीकार या रद्द करने के लिए:

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

किसी ऐप्लिकेशन में एपीआई प्रॉडक्ट मैनेज करना

ये काम करके, अपने ऐप्लिकेशन में एपीआई प्रॉडक्ट को मैनेज करें:

किसी ऐप्लिकेशन में एपीआई प्रॉडक्ट जोड़ना

किसी ऐप्लिकेशन में एपीआई प्रॉडक्ट जोड़ने के लिए:

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

किसी ऐप्लिकेशन से एपीआई प्रॉडक्ट हटाना

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

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

हटाए गए प्रॉडक्ट को फिर से जोड़ा जा सकता है.

नए क्रेडेंशियल जनरेट किए जा रहे हैं

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

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

  1. ऐप्लिकेशन पेज ऐक्सेस करें.
  2. ऐप्लिकेशन की उस पंक्ति पर क्लिक करें जिसे आपको देखना है और उसमें बदलाव करना है.
  3. बदलाव करें पर क्लिक करें.
  4. क्रेडेंशियल सेक्शन में, पर क्लिक करें.
  5. खत्म होने की तारीख की जानकारी दें, एपीआई प्रॉडक्ट जोड़ें, और उनकी स्थिति सेट करें.
  6. इसके अलावा, ज़रूरत के हिसाब से किसी भी दूसरी एपीआई कुंजी को revoke.
  7. सेव करें पर क्लिक करें.

ऐप्लिकेशन को स्वीकार या रद्द करना

में बताए गए तरीके से, किसी खास उपयोगकर्ता से जुड़े ऐप्लिकेशन को मंज़ूरी दी जा सकती है या उन्हें वापस लिया जा सकता है

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

अगर ऐप्लिकेशन किसी दूसरे संगठन में रजिस्टर है, तो आपको हर संगठन के लिए इसे रद्द करना होगा. सभी मैसेज प्रोसेस करने वाली कंपनियों को बदलावों की पहचान करने में कुछ मिनट लग सकते हैं.

किसी ऐप्लिकेशन को स्वीकार या रद्द करने के लिए:

  1. ऐप्लिकेशन पेज ऐक्सेस करें.
  2. ऐप्लिकेशन की उस पंक्ति पर क्लिक करें जिसे आपको देखना है और उसमें बदलाव करना है.
  3. बदलाव करें पर क्लिक करें.
  4. ऐप्लिकेशन को मंज़ूरी देने या रद्द करने के लिए, ऐप्लिकेशन की स्थिति फ़ील्ड में मंज़ूरी दें या रद्द करें में से किसी एक को चुनें.
  5. सेव करें पर क्लिक करें.

किसी ऐप्लिकेशन को मिटाना

जब किसी ऐप्लिकेशन को मिटाया जाता है, तो ऐप्लिकेशन से जुड़ी सभी क्लाइंट कुंजियां अमान्य हो जाती हैं. किसी अनुरोध पर अमान्य कुंजी का इस्तेमाल करने से, अनुरोध पूरा नहीं हो पाता.

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

किसी ऐप्लिकेशन को मिटाने के लिए:

  1. ऐप्लिकेशन पेज ऐक्सेस करें.
  2. कर्सर को ऐप्लिकेशन की उस पंक्ति में रखें जिसे मिटाना है.
  3. कार्रवाइयां कॉलम में पर क्लिक करें.

ध्यान दें: Apigee Edge for Public Cloud का इस्तेमाल करने पर, डेवलपर ऐप्लिकेशन और उससे जुड़े आर्टफ़ैक्ट को एसिंक्रोनस तरीके से मिटाया जाता है. डेवलपर ऐप्लिकेशन तुरंत मिटा दिया जाता है. हालांकि, उस डेवलपर ऐप्लिकेशन से जुड़े संसाधन, जैसे कि ऐप्लिकेशन कुंजियां या ऐक्सेस टोकन को अपने-आप मिटने में कुछ सेकंड से लेकर कुछ मिनट भी लग सकते हैं.

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

एपीआई का इस्तेमाल करके ऐप्लिकेशन रजिस्टर और मैनेज करने के लिए, डेवलपर ऐप्लिकेशन रजिस्टर करना देखें. एपीआई रेफ़रंस दस्तावेज़ में ये सेक्शन भी देखें:

मौजूदा उपभोक्ता कुंजियां और सीक्रेट इंपोर्ट करें भी देखें.