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

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

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

परिचय

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

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

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

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

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

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

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

Edge

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

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

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

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

क्लासिक Edge (निजी क्लाउड)

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, कॉल की अनुमति सिर्फ़ तब देता है, जब एपीआई पासकोड को मंज़ूरी मिली हो, वह मान्य हो, और एपीआई वाले एपीआई प्रॉडक्ट की तय की गई शर्तों को पूरा करता हो.

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

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

किसी एपीआई पासकोड को मंज़ूरी देने या रद्द करने के लिए:

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

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

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

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

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

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

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

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

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

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

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

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

नई एपीआई कुंजी जनरेट करने के लिए:

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

किसी ऐप्लिकेशन को अनुमति देना या अनुमति रद्द करना

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

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

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

किसी ऐप्लिकेशन को अनुमति देने या उससे अनुमति वापस लेने के लिए:

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

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

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

अगर आपको आने वाले समय में किसी डेवलपर के ऐप्लिकेशन को फिर से उपलब्ध कराना है, तो उसे रद्द करने का विकल्प चुनें.

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

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

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

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

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

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