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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• अपनी मौजूदा वेबसाइट में रजिस्टर करने की सुविधा इंटिग्रेट करने के लिए, Apigee Edge के मैनेजमेंट एपीआई का इस्तेमाल करें. Edge का मैनेजमेंट एपीआई, एक 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 के मैनेजमेंट एपीआई के लिए इंटरैक्टिव दस्तावेज़ तैयार करने के लिए, SmartDocs का इस्तेमाल करता है. एपीआई का दस्तावेज़ यहां देखें.

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