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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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