प्रकाशित करने की खास जानकारी

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

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

पब्लिश करने के एपीआई में ये टास्क शामिल हैं: इस विषय में इनके बारे में बताया गया है:

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

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

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

इस डायग्राम में, एपीआई में दो प्रॉडक्ट दिखाए गए हैं. हर प्रॉडक्ट में तीन एपीआई रिसॉर्स हैं.

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

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

यह याद रखना ज़रूरी है कि Edge आपको ऐसे एपीआई प्रॉडक्ट बनाने की सुविधा देता है जो आपके एपीआई की कारोबार से जुड़ी ज़रूरतों को पूरा करते हों.

एपीआई प्रॉडक्ट बनाने के बारे में ज़्यादा जानने के लिए, एपीआई प्रॉडक्ट बनाना लेख पढ़ें.

टास्क 2: Edge पर ऐप्लिकेशन डेवलपर को रजिस्टर करें

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

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

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

Apigee, ऐसे टूल भी उपलब्ध कराता है जिनका इस्तेमाल करके, डेवलपर रजिस्ट्रेशन की प्रोसेस को ऑटोमेट किया जा सकता है. उदाहरण के लिए:

• अपनी मौजूदा वेबसाइट में रजिस्ट्रेशन की सुविधा जोड़ने के लिए, Apigee Edge management API का इस्तेमाल करें. Edge मैनेजमेंट एपीआई एक REST API है, जिसका इस्तेमाल डेवलपर रजिस्ट्रेशन की प्रोसेस के सभी पहलुओं को पूरा करने के लिए किया जा सकता है. ज़्यादा जानकारी के लिए, एपीआई पब्लिश करने के लिए, Edge मैनेजमेंट एपीआई का इस्तेमाल करना देखें.
• डेवलपर रजिस्टर करने के लिए, Apigee डेवलपर सेवाएं पोर्टल का इस्तेमाल करें. पोर्टल में, डेवलपर रजिस्ट्रेशन की सुविधा पहले से मौजूद होती है. हालांकि, एपीआई के साथ काम करने के लिए, इसमें कई अन्य सुविधाएं भी मौजूद हैं. ज़्यादा जानकारी के लिए, डेवलपर पोर्टल क्या है? देखें.

तीसरा टास्क: Edge पर डेवलपर ऐप्लिकेशन रजिस्टर करना

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

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

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

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

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

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

टास्क 4: अपने एपीआई का दस्तावेज़ बनाएं

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

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

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

• इस एपीआई के बारे में पढ़ें
• एपीआई को लाइव अनुरोध भेजें
• एपीआई से मिला लाइव रिस्पॉन्स देखें

उदाहरण के लिए, नीचे दिए गए डायग्राम में SmartDocs का इस्तेमाल करके पोर्टल पर दर्ज किया गया एक एपीआई दिखाया गया है. यह API किसी खास जगह के मौसम की जानकारी देता है:

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

Edge मैनेजमेंट एपीआई एक REST API है, जो आपको किसी भी एचटीटीपी क्लाइंट का इस्तेमाल करके, एपीआई सेवाओं को ऐक्सेस करने की सुविधा देता है. Apigee, Edge management API के लिए इंटरैक्टिव दस्तावेज़ बनाने के लिए, SmartDocs का इस्तेमाल करता है. एपीआई से जुड़े दस्तावेज़ यहां देखें.

ज़्यादा जानकारी के लिए, एपीआई का दस्तावेज़ बनाने के लिए SmartDocs का इस्तेमाल करना देखें.