आपको Apigee Edge दस्तावेज़ दिख रहा है.
Apigee X दस्तावेज़ देखें.
बॉक्स से बाहर के लेवल पर, डेवलपर पोर्टल आपके पोर्टल उपयोगकर्ताओं को उपयोगकर्ता खाता बनाने, साइन इन करने, और आपके एपीआई का इस्तेमाल करने वाले ऐप्लिकेशन मैनेज करने की सुविधा देता है.
नीचे दिए गए सेक्शन में बताया गया है कि पोर्टल उपयोगकर्ता आपके पोर्टल के साथ कैसे इंटरैक्ट करते हैं.
पोर्टल में साइन इन करें
यहां दिए गए सेक्शन में बताया गया है कि पोर्टल के उपयोगकर्ता अपने उपयोगकर्ता क्रेडेंशियल (पहले से मौजूद पहचान देने वाली सेवा देने वाली कंपनी) या एसएएमएल (बीटा वर्शन) का इस्तेमाल करके, इंटिग्रेट किए गए पोर्टल में कैसे साइन इन करते हैं.
अगर आप पहले से मौजूद और एसएएमएल आइडेंटिटी प्रोवाइडर, दोनों को चालू करते हैं, तो पोर्टल उपयोगकर्ता साइन इन करने के लिए, पसंदीदा तरीके को चुन पाएंगे.
उपयोगकर्ता के क्रेडेंशियल (पहले से मौजूद आइडेंटिटी प्रोवाइडर) का इस्तेमाल करके, पोर्टल में साइन इन करें
पहले से मौजूद पहचान देने वाली सेवा के चालू होने पर, पोर्टल उपयोगकर्ता अपने उपयोगकर्ता क्रेडेंशियल (उपयोगकर्ता नाम और पासवर्ड) का इस्तेमाल करके, इंटिग्रेट किए गए पोर्टल में साइन इन कर सकते हैं, जैसा कि नीचे दिए गए सेक्शन में बताया गया है:
- इंटिग्रेट किए गए पोर्टल पर उपयोगकर्ता खाता बनाना
- इंटिग्रेट किए गए पोर्टल में साइन इन करना
- पासवर्ड बदलना
इंटिग्रेट किए गए पोर्टल पर उपयोगकर्ता खाता बनाना
पहले से मौजूद आइडेंटिटी प्रोवाइडर की मदद से, पोर्टल के उपयोगकर्ता आपके एपीआई का इस्तेमाल कर पाएं, इससे पहले उन्हें इंटिग्रेट किए गए पोर्टल पर एक उपयोगकर्ता खाता बनाना होगा.
पोर्टल के उपयोगकर्ता इंटिग्रेटेड पोर्टल पर उपयोगकर्ता खाता इस तरह बनाते हैं:
- पोर्टल पर जाएं.
साइन इन करें पर क्लिक करें.
साइन इन करने वाला पेज दिखता है.
खाता बनाएं पर क्लिक करें.
आपको 'खाता बनाएं' पेज दिखेगा.
फ़ॉर्म भरें.
आपको सभी ज़रूरी फ़ील्ड के लिए वैल्यू डालनी होंगी. पासवर्ड कम से कम 8 वर्णों के होने चाहिए. साथ ही, इनमें से हर एक का इस्तेमाल होना चाहिए: संख्या, अंग्रेज़ी का छोटा अक्षर, अंग्रेज़ी के बड़े अक्षर, और विशेष वर्ण.
शर्तों को पढ़ें और उन्हें स्वीकार करें.
खाता बनाएं पर क्लिक करें.
कैप्चा फ़ॉर्म भरें और पुष्टि करें पर क्लिक करें.
उपयोगकर्ता खाता बन जाता है और पुष्टि करने वाला ईमेल भेजा जाता है.
रजिस्ट्रेशन की प्रोसेस पूरी करने के लिए, 10 मिनट के अंदर पुष्टि करने वाले ईमेल में दिए गए लिंक पर क्लिक करें.
अगर आपने 10 मिनट में लिंक पर क्लिक नहीं किया, तो आपको खाता बनाने और दोबारा निर्देश देने के लिए, इस प्रोसेस में दिए गए चरणों को दोहराना होगा.
इंटिग्रेट किए गए पोर्टल (नीचे बताया गया है) में साइन इन करें.
इंटिग्रेट किए गए पोर्टल में साइन इन करें
पहले से मौजूद आइडेंटिटी प्रोवाइडर की मदद से, पोर्टल उपयोगकर्ताओं के पोर्टल पर रजिस्टर होने और उन्हें मंज़ूरी मिलने के बाद, वे अपने क्रेडेंशियल (उपयोगकर्ता नाम और पासवर्ड) का इस्तेमाल करके साइन इन करते हैं.
पोर्टल उपयोगकर्ता इस तरह साइन इन करते हैं:
- पोर्टल पर जाएं.
- साइन इन करें पर क्लिक करें.
'साइन इन करें' पेज पर यह जानकारी दिखती है:
- ईमेल पता और पासवर्ड डालें.
- साइन इन करें पर क्लिक करें.
पासवर्ड बदलना
पहले से मौजूद आइडेंटिटी प्रोवाइडर की मदद से, पोर्टल के उपयोगकर्ता इस तरह से पासवर्ड बदलते हैं:
- पोर्टल पर जाएं.
- साइन इन करें पर क्लिक करें.
- पासवर्ड रीसेट करें पर क्लिक करें.
- खाते को रीसेट करने के लिए ईमेल पता डालें.
पासवर्ड रीसेट करने का लिंक भेजें पर क्लिक करें.
ईमेल पर रीसेट पासवर्ड का लिंक भेजा जाता है.
पुष्टि करने वाले ईमेल में दिए गए लिंक पर क्लिक करें.
नया पासवर्ड डालें और उसकी पुष्टि करें.
पासवर्ड कम से कम 8 वर्णों के होने चाहिए. साथ ही, इनमें से हर एक का इस्तेमाल होना चाहिए: संख्या, अंग्रेज़ी का छोटा अक्षर, अंग्रेज़ी के बड़े अक्षर, और विशेष वर्ण.
नया पासवर्ड बनाएं पर क्लिक करें.
एसएएमएल की पुष्टि करने के बीटा वर्शन का इस्तेमाल करके, पोर्टल में साइन इन करें
SAML आइडेंटिटी प्रोवाइडर के चालू होने पर, पोर्टल उपयोगकर्ता एसएएमएल पुष्टि करने की सुविधा का इस्तेमाल करके, इस पोर्टल में साइन इन करते हैं:
- पोर्टल पर जाएं.
- साइन इन करें पर क्लिक करें.
ValueTrack की मदद से लॉगिन करें पर क्लिक करें.
आपको एसएएमएल की सेवा देने वाली कंपनी पर रीडायरेक्ट किया गया है.
अगर कहा जाए, तो अपने एसएएमएल आइडेंटिटी प्रोवाइडर के लिए क्रेडेंशियल डालें.
एपीआई के संदर्भ वाला दस्तावेज़ देखें
पोर्टल के उपयोगकर्ता, आपके पोर्टल पर पब्लिश किए गए एपीआई के रेफ़रंस दस्तावेज़ को इस तरह देख सकते हैं:
- पोर्टल पर जाएं.
सबसे ऊपर मौजूद नेविगेशन बार में, एपीआई पर क्लिक करें.
आपको एपीआई पेज दिखेगा. उदाहरण के लिए:
अगर आपको विकल्प देखने हों, तो बाएं पैनल में मौजूद टूल का इस्तेमाल करके, एपीआई की सूची को कैटगरी, शीर्षक या जानकारी के हिसाब से फ़िल्टर करें.
एपीआई रेफ़रंस दस्तावेज़ देखने के लिए किसी एपीआई कार्ड पर क्लिक करें.
एपीआई के रेफ़रंस वाला दस्तावेज़ दिखेगा.
पोर्टल के उपयोगकर्ता, एपीआई के बारे में जान सकते हैं और उन्हें आज़मा सकते हैं या एपीआई के दस्तावेज़ को रेंडर करने के लिए इस्तेमाल किया जाने वाला दस्तावेज़ डाउनलोड कर सकते हैं. एपीआई के बारे में जानकारी देने वाले दस्तावेज़ को रेंडर करने के तरीके के बारे में ज़्यादा जानने के लिए, अपने एपीआई पब्लिश करें पर जाएं.
डेवलपर टीम (बीटा वर्शन) का इस्तेमाल करने वाले किसी ऐप्लिकेशन के लिए ज़िम्मेदारी शेयर करना
डेवलपर की टीमें, पोर्टल के उपयोगकर्ताओं को अन्य पोर्टल उपयोगकर्ताओं के साथ किसी ऐप्लिकेशन की ज़िम्मेदारी शेयर करने देती हैं. नीचे दिए गए सेक्शन में डेवलपर टीम बनाने और उन्हें मैनेज करने का तरीका बताया गया है.
डेवलपर टीम से जुड़ी भूमिकाओं के बारे में जानकारी
नीचे दी गई टेबल में उन भूमिकाओं के बारे में बताया गया है जो डेवलपर टीम के सदस्यों को असाइन की जा सकती हैं:
| भूमिका | जानकारी |
|---|---|
| ऐप्लिकेशन एडमिन |
|
| मालिक | डेवलपर टीम के सदस्यों, डेवलपर टीम के ब्यौरे, और ऐप्लिकेशन को पढ़ने और लिखने का खास अधिकार. |
| दर्शक | डेवलपर टीम के सदस्यों, डेवलपर टीम की जानकारी, और ऐप्लिकेशन के लिए रीड-ओनली ऐक्सेस. |
टीम पेज देखना
टीम पेज पर, उन डेवलपर टीमों की जानकारी दिखती है जिनके आप सदस्य हैं.
टीम पेज को ऐक्सेस करने के लिए:
- पोर्टल में साइन इन करें.
- पोर्टल में उपयोगकर्ता खाता ड्रॉप-डाउन से टीम चुनें.
टीम पेज आपको दिखाता है. इसकी मदद से आप:
- आप जिन डेवलपर टीमों के सदस्य हैं उन्हें देखें. जैसे: नाम, भूमिका, सदस्यों की सूची, और टीम बनाने की तारीख
- डेवलपर टीम जोड़ना
- डेवलपर टीम की सदस्यता और भूमिकाओं में बदलाव करना, डेवलपर टीम से खुद को हटाना या डेवलपर टीम लाइन पर क्लिक करके टीम मिटाना
डेवलपर टीमें जोड़ें
डेवलपर टीम जोड़ने के लिए:
- पोर्टल में साइन इन करें.
- पोर्टल में उपयोगकर्ता खाता ड्रॉप-डाउन से टीम चुनें.
- + नई टीम पर क्लिक करें.
- नाम और ब्यौरा डालें.
डेवलपर टीम में किसी सदस्य को जोड़ने के लिए, + दूसरा सदस्य जोड़ें पर क्लिक करें, पोर्टल उपयोगकर्ता का ईमेल पता डालें और डेवलपर टीम की भूमिका चुनें.
अन्य सदस्यों को जोड़ने के लिए, इसे दोहराएं.
डेवलपर टीम से किसी सदस्य को मिटाने के लिए, डेवलपर टीम के जिस सदस्य को मिटाना है उसके बगल में मौजूद
पर क्लिक करें.बनाएं पर क्लिक करें.
डेवलपर टीम की सदस्यता और भूमिकाओं में बदलाव करना
डेवलपर टीम की सदस्यता और भूमिकाओं में बदलाव करने के लिए:
- पोर्टल में साइन इन करें.
- पोर्टल में उपयोगकर्ता खाता ड्रॉप-डाउन से टीम चुनें.
- उस डेवलपर टीम की पंक्ति में क्लिक करें, जिसमें आप बदलाव करना चाहते हैं और जिसके आप मालिक हैं.
इनमें से एक या उससे ज़्यादा तरीका अपनाएं:
- नाम, जानकारी, और प्राइमरी कॉन्टैक्ट में बदलाव करें.
- डेवलपर टीम के सदस्यों को जोड़ें या हटाएं.
- डेवलपर टीम के सदस्य की भूमिकाएं अपडेट करें.
सेव करें पर क्लिक करें.
डेवलपर टीम से खुद को हटाना
डेवलपर टीम से खुद को हटाने के लिए:
- पोर्टल में साइन इन करें.
- पोर्टल में उपयोगकर्ता खाता ड्रॉप-डाउन से टीम चुनें.
- उस डेवलपर टीम की पंक्ति में क्लिक करें जिससे आप खुद को हटाना चाहते हैं.
- टीम छोड़ें पर क्लिक करें.
डेवलपर टीम को मिटाना
डेवलपर टीम को मिटाने के लिए:
- पोर्टल में साइन इन करें.
- पोर्टल में उपयोगकर्ता खाता ड्रॉप-डाउन से टीम चुनें.
- उस डेवलपर टीम की पंक्ति में क्लिक करें जिसे आप हटाना चाहते हैं.
पर क्लिक करें. - मिटाने की पुष्टि करने के लिए, पुष्टि करें पर क्लिक करें.
ऐप्लिकेशन रजिस्टर करना
नीचे दिए गए सेक्शन में बताए गए तरीके से, डेवलपर ऐप्लिकेशन और डेवलपर टीम ऐप्लिकेशन रजिस्टर करें.
डेवलपर ऐप्लिकेशन रजिस्टर करें
पोर्टल उपयोगकर्ता उन एपीआई का इस्तेमाल करने के लिए ऐप्लिकेशन रजिस्टर कर सकते हैं जिन्हें आपने पब्लिश किया है, इस तरह से:
- उपयोगकर्ता खाता ड्रॉप-डाउन से ऐप्लिकेशन चुनें.
- नया ऐप्लिकेशन बनाने के लिए, + नया ऐप्लिकेशन पर क्लिक करें.
- नए ऐप्लिकेशन डायलॉग में, ऐप्लिकेशन के लिए कोई नाम और जानकारी डालें.
मालिक ड्रॉप-डाउन सूची में ऐप्लिकेशन का मालिक चुनें.
डिफ़ॉल्ट रूप से, आपके पास ऐप्लिकेशन का मालिकाना हक होता है. अगर आप चाहें, तो ड्रॉप-डाउन मेन्यू से कोई डेवलपर टीम चुनें. इस टीम के सदस्यों के साथ ऐप्लिकेशन की ज़िम्मेदारी शेयर की जा सकती है. डेवलपर टीम (बीटा वर्शन) का इस्तेमाल करने वाले किसी ऐप्लिकेशन के लिए ज़िम्मेदारी शेयर करना देखें.
एपीआई कैटलॉग सेक्शन में, एक या उससे ज़्यादा एपीआई चुनें.
कैटलॉग में मौजूद एपीआई को पुष्टि किए गए एपीआई की कैटगरी में रखा जाता है. इसके लिए, कॉलबैक यूआरएल या सार्वजनिक एपीआई की ज़रूरत होती है. ऐप्लिकेशन बनाने के लिए, आपको कम से कम एक एपीआई चुनना होगा.
अगर आप 'पुष्टि किए गए एपीआई' सेक्शन में कोई एपीआई चुनते हैं, तो कॉलबैक का यूआरएल डालें.
ज़्यादा जानकारी के लिए, कॉलबैक यूआरएल के बारे में जानकारी देखें.
बनाएं पर क्लिक करें.
डेवलपर टीम के लिए ऐप्लिकेशन रजिस्टर करें
आपने जो एपीआई पब्लिश किए हैं उनका इस्तेमाल करने के लिए, डेवलपर टीम के सदस्य, डेवलपर टीम के लिए ऐप्लिकेशन रजिस्टर कर सकते हैं. इसका तरीका नीचे बताया गया है.
इस बारे में ज़्यादा जानने के लिए कि:
- पोर्टल के उपयोगकर्ता, टीमों को जोड़ते और मैनेज करते हैं, जैसा कि डेवलपर की टीम (बीटा वर्शन) का इस्तेमाल करने वाले किसी ऐप्लिकेशन के लिए ज़िम्मेदारी शेयर करना में बताया गया है.
- एपीआई सेवा देने वाली कंपनियां, डेवलपर टीमों को देखना और मैनेज करना. इसका तरीका, डेवलपर टीमें मैनेज करना में बताया गया है.
डेवलपर टीम के लिए ऐप्लिकेशन रजिस्टर करने के लिए:
- उपयोगकर्ता खाता ड्रॉप-डाउन से टीम चुनें.
- उस डेवलपर टीम की लाइन पर क्लिक करें जिसके लिए आपको ऐप्लिकेशन रजिस्टर करना है.
- नया ऐप्लिकेशन बनाने के लिए, + नया ऐप्लिकेशन पर क्लिक करें.
- नए ऐप्लिकेशन डायलॉग में, ऐप्लिकेशन के लिए कोई नाम और जानकारी डालें.
मालिक ड्रॉप-डाउन सूची में ऐप्लिकेशन का मालिक चुनें.
डिफ़ॉल्ट रूप से, डेवलपर टीम ऐप्लिकेशन का मालिक होती है. अगर आप चाहें, तो ड्रॉप-डाउन मेन्यू से कोई दूसरी डेवलपर टीम या खुद को मालिक चुनें.
एपीआई कैटलॉग सेक्शन में, एक या उससे ज़्यादा एपीआई चुनें.
कैटलॉग में मौजूद एपीआई को पुष्टि किए गए एपीआई की कैटगरी में रखा जाता है. इसके लिए, कॉलबैक यूआरएल या सार्वजनिक एपीआई की ज़रूरत होती है. ऐप्लिकेशन बनाने के लिए, आपको कम से कम एक एपीआई चुनना होगा.
अगर आप 'पुष्टि किए गए एपीआई' सेक्शन में कोई एपीआई चुनते हैं, तो कॉलबैक का यूआरएल डालें.
ज़्यादा जानकारी के लिए, कॉलबैक यूआरएल के बारे में जानकारी देखें.
बनाएं पर क्लिक करें.
किसी ऐप्लिकेशन में एपीआई मैनेज करना
एपीआई प्रोड्यूसर के तौर पर, आपके पास एपीआई पब्लिश करने की सुविधा होती है. इससे, पोर्टल उपयोगकर्ताओं को आपके एपीआई प्रॉडक्ट का इस्तेमाल करने में मदद मिलती है.
पोर्टल के उपयोगकर्ता यह मैनेज करते हैं कि उनके ऐप्लिकेशन किन एपीआई का इस्तेमाल करेंगे. एपीआई को ऐप्लिकेशन की ज़्यादा जानकारी वाले पेज पर जोड़ा जाता है. कुछ एपीआई के लिए, मंज़ूरी अपने-आप नहीं मिलती. मंज़ूरी मिलनी बाकी है की स्थिति, उस एपीआई को दिखाती है जिसके लिए ऐक्सेस का अनुरोध किया गया है, लेकिन उसे अब तक स्वीकार नहीं किया गया है.
पोर्टल के उपयोगकर्ता आपके पोर्टल से किसी ऐप्लिकेशन में एपीआई को इस तरह मैनेज कर सकते हैं:
- उपयोगकर्ता खाता ड्रॉप-डाउन से ऐप्लिकेशन चुनें.
- सूची में ऐप्लिकेशन पर क्लिक करें.
- एपीआई सेक्शन में, ऐप्लिकेशन के एपीआई का ऐक्सेस चालू या बंद करने के लिए
या 
पर क्लिक करें. - पुष्टि किए गए एपीआई के लिए, ज़रूरत के हिसाब से कॉलबैक यूआरएल जोड़ें या उसमें बदलाव करें.
किसी ऐप्लिकेशन की एपीआई कुंजी और सीक्रेट देखना
पोर्टल के उपयोगकर्ता आपके पोर्टल से किसी ऐप्लिकेशन के लिए, एपीआई कुंजी को इस तरह मैनेज कर सकते हैं:
- उपयोगकर्ता खाता ड्रॉप-डाउन से ऐप्लिकेशन चुनें.
- सूची में ऐप्लिकेशन पर क्लिक करें.
- एपीआई कुंजियां, एपीआई पासकोड सेक्शन में देखें.
- पुष्टि करें कि एपीआई कुंजी का स्टेटस ऐक्टिव है.
अगर आपकी एपीआई कुंजी को अनुमति की ज़रूरत है और उसे अभी तक मंज़ूरी नहीं मिली है, तो स्थिति मंज़ूरी बाकी है के तौर पर दिखेगी. - सीक्रेट देखने के लिए, सीक्रेट दिखाएं पर क्लिक करें.
- अपना कर्सर एपीआई कुंजी या सीक्रेट पर रखें और क्लिपबोर्ड पर उसे कॉपी करने के लिए
पर क्लिक करें.
किसी ऐप्लिकेशन के लिए एपीआई पासकोड को बदलना
पोर्टल का उपयोगकर्ता, किसी ऐप्लिकेशन के एपीआई पासकोड को समय-समय पर बदल सकता है. इसके अलावा, वह किसी संभावित लीक या छेड़छाड़ की वजह से भी ऐसा कर सकता है. जब पोर्टल उपयोगकर्ता किसी एपीआई कुंजी को घुमाता है, तो एक नई एपीआई कुंजी बन जाती है और उसकी एपीआई कुंजियां मूल कुंजी के बराबर ही होती हैं. ओरिजनल एपीआई कुंजी तब भी चालू रहती है, जब आप इसे इस्तेमाल करने के दौरान बदलते हैं. आपको पुरानी API (एपीआई) कुंजी को निरस्त करना होगा, ताकि उसके क्रेडेंशियल स्वीकार न किए जाएं, जैसा कि किसी ऐप्लिकेशन की एपीआई कुंजी को निरस्त करना है.
पोर्टल के उपयोगकर्ता आपके पोर्टल से किसी ऐप्लिकेशन के लिए, एपीआई कुंजी को इस तरह बदल सकते हैं:
- उपयोगकर्ता खाता ड्रॉप-डाउन से ऐप्लिकेशन चुनें.
- सूची में ऐप्लिकेशन पर क्लिक करें.
- एपीआई पासकोड सेक्शन में, कुंजी जोड़ें पर क्लिक करें.
- कार्रवाई की पुष्टि करने के लिए, डायलॉग बॉक्स में पुष्टि करें पर क्लिक करें.
- इसके अलावा, नीचे दिए गए तरीके से पुरानी एपीआई कुंजी को निरस्त करें.
किसी ऐप्लिकेशन के लिए एपीआई पासकोड निरस्त करना
जब पोर्टल उपयोगकर्ता, एपीआई कुंजी को घुमाता है, जैसा कि पिछले सेक्शन में बताया गया है, तो एपीआई कुंजी का इस्तेमाल बंद होने पर भी यह चालू रहती है. आपको एपीआई पासकोड को निरस्त करना होगा, ताकि उसके क्रेडेंशियल स्वीकार न किए जा सकें.
पोर्टल के उपयोगकर्ता आपके पोर्टल से किसी ऐप्लिकेशन के लिए, एपीआई कुंजी को इस तरह रद्द कर सकते हैं:
- उपयोगकर्ता खाता ड्रॉप-डाउन से ऐप्लिकेशन चुनें.
- ऐप्लिकेशन के नाम पर क्लिक करें.
- एपीआई कुंजियों के सेक्शन में, उस एपीआई कुंजी से जुड़े कार्रवाई कॉलम में पर क्लिक करें जिसे आप निरस्त करना चाहते हैं.
कार्रवाई की पुष्टि करने के लिए, पुष्टि करें पर क्लिक करें.
इस बटन की स्थिति को निरस्त कर दिया गया है.
ऐप्लिकेशन की जानकारी में बदलाव करें
पोर्टल के उपयोगकर्ता ऐप्लिकेशन की जानकारी में, नीचे बताए गए तरीके से बदलाव कर सकते हैं:
- उपयोगकर्ता खाता ड्रॉप-डाउन से ऐप्लिकेशन चुनें.
- सूची में ऐप्लिकेशन पर क्लिक करें.
- ऐप की जानकारी वाले टैब पर जाकर नाम या जानकारी वाले फ़ील्ड में बदलाव करें.
- ज़रूरत के मुताबिक, किसी ऐप्लिकेशन में एपीआई मैनेज करना.
- सेव करें पर क्लिक करें.
कोई ऐप्लिकेशन मिटाएँ
पोर्टल के उपयोगकर्ता आपके पोर्टल से किसी ऐप्लिकेशन को इस तरह मिटा सकते हैं:
- उपयोगकर्ता खाता ड्रॉप-डाउन से ऐप्लिकेशन चुनें.
- सूची में ऐप्लिकेशन पर क्लिक करें.
- मिटाएं पर क्लिक करें.
- कार्रवाई की पुष्टि करने के लिए, पुष्टि करें पर क्लिक करें.
ऐप्लिकेशन को मिटा दिया जाता है और ऐप्लिकेशन की सूची से हटा दिया जाता है.