API7 Enterprise v3.3.0 API Portal का समर्थन करता है

डेवलपर पोर्टल अवलोकन

डेवलपर पोर्टल एक समर्पित प्लेटफॉर्म है जो API उपभोक्ताओं (जैसे, तृतीय-पक्ष डेवलपर्स और आंतरिक टीमों) के लिए डिज़ाइन किया गया है, जो API दस्तावेज़ीकरण, परीक्षण उपकरण और संबंधित संसाधनों तक एकीकृत पहुंच प्रदान करता है। यह पोर्टल न केवल डेवलपर्स को API को जल्दी समझने और एकीकृत करने में सहायता करता है, बल्कि प्रबंधन और सुरक्षा स्तर पर विज़ुअलाइज़ेशन और नियंत्रण क्षमताओं को भी बढ़ाता है। एक API गेटवे प्लेटफॉर्म के लिए, डेवलपर पोर्टल प्रदान करने से निम्नलिखित लाभ होते हैं:

1. सरलीकृत API एक्सपोज़र: खंडित दस्तावेज़ीकरण, उदाहरण और इंटरफ़ेस विनिर्देशों को एकीकृत प्लेटफॉर्म पर समेकित करके, पोर्टल एकीकरण लागत को काफी कम करता है और उत्पाद को बाहरी सिस्टम के साथ जल्दी एकीकृत करता है।

2. R&D और संचालन दक्षता में सुधार: दस्तावेज़ीकरण खोज, परीक्षण और डिबगिंग जैसी स्व-सेवा सुविधाएं दोहरावपूर्ण संचार और दस्तावेज़ीकरण रखरखाव को कम करती हैं, जिससे समग्र दक्षता बढ़ती है।

3. केंद्रीकृत प्रबंधन और निगरानी: प्लेटफॉर्म API उपयोग, प्रतिक्रिया विश्लेषण और प्रमुख मेट्रिक्स निगरानी का बेहतर ट्रैकिंग प्रदान करता है, साथ ही संभावित समस्याओं का शीघ्र पता लगाने में मदद करता है।

API7 एंटरप्राइज़ 3.3.0 में, API7 गेटवे अब उपयोगकर्ता द्वारा प्रदान किए गए API दस्तावेज़ीकरण से सीधे डेवलपर पोर्टल का स्वचालित रूप से जनरेट करने का समर्थन करता है। यह क्षमता संगठनों को API संसाधनों को बाहरी पक्षों के लिए आसानी से एक्सपोज़ करने में सक्षम बनाती है, साथ ही डेवलपर्स के लिए एक सुसंगत और सुविधाजनक अनुभव प्रदान करती है।

API7 प्रोवाइडर पोर्टल और डेवलपर पोर्टल

API प्रबंधन प्लेटफॉर्म के रूप में, API7 प्रोवाइडर पोर्टल और डेवलपर पोर्टल पूरक भूमिकाएं निभाते हैं, लेकिन विभिन्न दर्शकों और कार्यक्षमताओं के लिए डिज़ाइन किए गए हैं।

API7 प्रोवाइडर पोर्टल

API7 प्रोवाइडर पोर्टल API प्रदाताओं के लिए एक प्रबंधन कंसोल है जो API जीवनचक्र प्रबंधन को आसान बनाता है।

• लक्षित दर्शक: API प्रदाता और प्रशासक
• मुख्य कार्य:
  • API उत्पादों को प्रकाशित और प्रबंधित करना।
  • डेवलपर्स का प्रबंधन।
  • डेवलपर पोर्टल पहुंच के लिए नीतियों को कॉन्फ़िगर करना, जैसे अनाम API देखने और लॉगिन विधियाँ।
  • API पहुंच सांख्यिकी को विज़ुअलाइज़ करना, विश्लेषण करना और लॉग ट्रैक करना।

API7 डेवलपर पोर्टल

API7 डेवलपर पोर्टल डेवलपर्स या भागीदारों के लिए एक एकीकृत, स्व-सेवा प्रवेश बिंदु प्रदान करता है, जो उन्हें API सेवाओं को जल्दी समझने, पहुंचने और उपयोग करने में सक्षम बनाता है।

• लक्षित दर्शक: API उपभोक्ता, जैसे तृतीय-पक्ष डेवलपर्स, भागीदार या आंतरिक विकास टीमें
• मुख्य कार्य:
  • API दस्तावेज़ीकरण, उपयोग गाइड और उदाहरण कोड प्रदान करना।
  • ऑनलाइन परीक्षण और डिबगिंग इंटरफ़ेस प्रदान करना।
  • एप्लिकेशन पंजीकरण प्रबंधन, API कुंजी प्राप्त करना और प्रमाणीकरण क्रेडेंशियल्स को संभालना।

API7 पोर्टल का उपयोग कैसे करें

API7 प्रोवाइडर पोर्टल तक पहुंचना

API7 एंटरप्राइज़ डैशबोर्ड में लॉग इन करने के बाद, उपयोगकर्ताओं को डिफ़ॉल्ट रूप से गेटवे प्रबंधन पृष्ठ पर निर्देशित किया जाता है। API7 प्रोवाइडर पोर्टल पर स्विच करने के लिए, ऊपरी-बाएं कोने में टॉगल बटन पर क्लिक करें। स्विच करने पर, पृष्ठ शीर्षक API7 प्रोवाइडर पोर्टल में अपडेट हो जाता है, और बाईं ओर का मेनू API उत्पादों के प्रबंधन के लिए प्रासंगिक विकल्पों को प्रदर्शित करता है।

API उत्पाद बनाना और प्रकाशित करना

API उत्पाद API7 प्रोवाइडर पोर्टल में एक मुख्य संसाधन हैं, जो संबंधित API के समूह का प्रतिनिधित्व करते हैं। डेवलपर्स आमतौर पर उत्पाद स्तर पर API की सदस्यता लेते हैं। API उत्पाद बनाने के दो तरीके हैं।

1. API7 गेटवे में प्रकाशित सेवाओं के आधार पर

• API7 गेटवे में मौजूदा प्रकाशित सेवाओं का चयन करें और उन्हें एक API उत्पाद में समूहित करें।
• API उत्पाद के भीतर, प्रत्येक सेवा के संबंधित रूट्स को स्वतंत्र API के रूप में माना जाता है।

2. OpenAPI फ़ाइलों को आयात करना

• मौजूदा OpenAPI फ़ाइलों को आयात करके तेजी से API उत्पाद जनरेट करें।
• ध्यान दें कि इस तरह बनाए गए उत्पाद सीधे गेटवे के कॉन्फ़िगरेशन से लिंक नहीं होते हैं।

उदाहरण: API7 गेटवे से API उत्पाद जोड़ना

API उत्पाद जोड़ने के लिए, "Add API Product" बटन पर क्लिक करें और "From API7 Gateway" मेनू आइटम का चयन करके API उत्पाद निर्माण फॉर्म तक पहुंचें।

फॉर्म पर, आपको निम्नलिखित जानकारी भरनी होगी:

1. मूल बातें: नाम, विवरण, लेबल, लोगो आदि शामिल हैं।

2. प्रमाणीकरण प्रकार: निर्दिष्ट करें कि अनुमोदन की आवश्यकता है या नहीं।

3. दृश्यता: API उत्पाद की दृश्यता सीमा सेट करें।

4. लिंक्ड गेटवे सेवाएं: एक प्रकाशित गेटवे सेवा का चयन करें जो निम्नलिखित दो शर्तों को पूरा करती हो:

   • एक होस्टनाम कॉन्फ़िगर किया गया हो।
   • एक OpenAPI दस्तावेज़ अपलोड किया गया हो।

नया API उत्पाद जोड़ना

यदि कोई सेवा आवश्यकताओं को पूरा नहीं करती है, तो आप नीचे दिए गए कॉन्फ़िगरेशन चरणों का पालन कर सकते हैं।

1. मौजूदा सेवाओं के लिए OpenAPI दस्तावेज़ अपलोड करना और होस्टनाम कॉन्फ़िगर करना

सेवा विवरण या सेवा टेम्पलेट पृष्ठ पर, बाईं नेविगेशन बार में OpenAPI विनिर्देश पर क्लिक करें। फिर, सेवा के लिए संबंधित OpenAPI दस्तावेज़ अपलोड करें। सुनिश्चित करें कि दस्तावेज़ में API परिभाषाएं सेवा के वास्तविक रूट्स से सटीक रूप से मेल खाती हैं। यह सुनिश्चित करता है कि डेवलपर्स को डिबगिंग के दौरान सटीक API दस्तावेज़ीकरण मिले और उन्हें सफलतापूर्वक अपस्ट्रीम पहुंच प्राप्त हो।

दस्तावेज़ अपलोड करने के बाद, आप इसे रीयल-टाइम में प्रीव्यू कर सकते हैं, जो डेवलपर्स को मिलने वाले अंतिम API दस्तावेज़ीकरण को दर्शाता है।

अगला, सेवा विवरण या टेम्पलेट विवरण पृष्ठ के रूट्स अनुभाग में, अनुरोध URL मॉड्यूल में hosts कॉन्फ़िगर करें। डिफ़ॉल्ट रूप से, hosts को "*" पर सेट किया जाता है, जिसका अर्थ है कि सेवा किसी भी होस्टनाम से आने वाले अनुरोधों को प्रोसेस करती है।

सेवा को API उत्पाद से लिंक करने के लिए, एक सटीक होस्ट निर्दिष्ट करना आवश्यक है। यह आवश्यकता सुनिश्चित करती है कि डेवलपर्स पूर्ण पथ प्रारूप का उपयोग करके API तक पहुंच सकें: होस्ट + पथ उपसर्ग + API।

2. API उत्पाद से लिंक करने के लिए एक नई सेवा बनाना

यदि कोई सेवा प्रकाशित नहीं की गई है, तो आप एक नई सेवा बना सकते हैं जिसमें OpenAPI दस्तावेज़ को सेवा टेम्पलेट के रूप में अपलोड करके प्रकाशित किया जाए, या सीधे गेटवे समूह में एक सेवा बनाई जाए। इस तरह बनाई गई सेवाएं स्वचालित रूप से OpenAPI-परिभाषित API को रूट्स में पार्स करती हैं, और दस्तावेज़ को पुनः अपलोड करने की आवश्यकता नहीं होती है। होस्ट को पहले बताए गए तरीके से कॉन्फ़िगर करें ताकि सेवा API उत्पाद लिंकेज के लिए योग्य हो।

एक बार गेटवे कॉन्फ़िगरेशन पूरा हो जाने के बाद, प्रोवाइडर पोर्टल पर वापस जाएं और लिंक्ड गेटवे सेवा जोड़ें पर क्लिक करें। आवश्यक प्रकाशित सेवा का चयन करके लिंकेज पूरा करें।

डिफ़ॉल्ट रूप से, नया बनाया गया API उत्पाद ड्राफ्ट स्थिति में होगा, जो डेवलपर्स के लिए अदृश्य होगा। प्रकाशित करने से पहले, API दस्तावेज़ीकरण, दृश्यता सेटिंग्स और प्रमाणीकरण सेटिंग्स की समीक्षा करें। API उत्पाद इवेंट नोटिफिकेशन (जैसे, सदस्यता अनुमोदन या रद्द करना) कॉन्फ़िगर करने की सिफारिश की जाती है ताकि महत्वपूर्ण अपडेट्स को याद न किया जाए।

API उत्पाद प्रकाशित करना

API उत्पाद को सत्यापित करने के बाद, ऊपरी-दाएं कोने में प्रकाशित बटन पर क्लिक करें और पुष्टि करें। दृश्यता सेटिंग्स से मेल खाने वाले डेवलपर्स तब डेवलपर पोर्टल के माध्यम से उत्पाद तक पहुंच सकते हैं।

API7 डेवलपर पोर्टल तक पहुंचना

आप API7 डेवलपर पोर्टल तक दो तरीकों से पहुंच सकते हैं:

1. डेवलपर पोर्टल के URL पर जाएं।
2. API7 पोर्टल डैशबोर्ड के बाईं मेनू में डेवलपर पोर्टल बटन पर क्लिक करें।

API7 डेवलपर पोर्टल के होमपेज पर, ऊपरी-दाएं कोने में लॉगिन बटन पर क्लिक करके लॉगिन करें।

डेवलपर बनाना

डेवलपर खाता बनाने के दो तरीके हैं:

• स्व-पंजीकरण: डेवलपर्स लॉगिन पृष्ठ पर स्वयं पंजीकरण करते हैं।
• प्रशासक आमंत्रण: प्रशासक API7 पोर्टल डैशबोर्ड के माध्यम से खाते बनाते हैं।

स्व-पंजीकरण

लॉगिन पृष्ठ पर साइन अप बटन पर क्लिक करें, और उपयोगकर्ता नाम और पासवर्ड के साथ फॉर्म पूरा करें।

प्रशासक-प्रारंभित पंजीकरण

API7 पोर्टल डैशबोर्ड में, डेवलपर्स अनुभाग पर नेविगेट करें और डेवलपर आमंत्रित करें पर क्लिक करें। उपयोगकर्ता नाम और एक-बार का पासवर्ड के साथ फॉर्म भरें, और वैकल्पिक रूप से पहचान के लिए एक प्रदर्शन नाम प्रदान करें।

डेवलपर जोड़ने के बाद, उपयोगकर्ता को उपयोगकर्ता नाम और पासवर्ड साझा करें। पहले लॉगिन पर, उन्हें अपना पासवर्ड रीसेट करना होगा।

API उत्पाद देखना

लॉगिन करने के बाद, डेवलपर्स API हब पर क्लिक करके सभी प्रकाशित API उत्पादों को देख सकते हैं।

API दस्तावेज़ीकरण देखने के अलावा, सिस्टम विवरण पृष्ठ पर प्रत्येक API के लिए बहु-भाषा कोड नमूने जनरेट करने का भी समर्थन करता है। डेवलपर्स इन नमूना कोड्स को अपने विकास वातावरण में कॉपी करके परीक्षण कर सकते हैं।

API उत्पाद डिबग करना

इसके अलावा, डेवलपर्स टेस्ट अनुरोध बटन पर क्लिक करके सीधे API का परीक्षण कर सकते हैं।

टेस्ट अनुरोध पर क्लिक करने के बाद, आप एक ऑनलाइन परीक्षण पैनल देख सकते हैं।

• अनुरोध URL API उत्पाद से जुड़ी सेवा कॉन्फ़िगरेशन के आधार पर स्वचालित रूप से जनरेट होता है।
• प्रमाणीकरण विधि डिफ़ॉल्ट रूप से की ऑथ होती है और वर्तमान डेवलपर खाते के लिए API कुंजी स्वचालित रूप से भरती है।

डेवलपर्स को केवल API इंटरफ़ेस परिभाषा के अनुसार आवश्यक अनुरोध पैरामीटर्स को पूरक करना होगा ताकि डिबगिंग आगे बढ़ सके।

API उत्पाद की सदस्यता लेना

यदि एक API उत्पाद विशिष्ट उपयोगकर्ताओं के लिए प्रतिबंधित है, तो प्रोवाइडर पोर्टल के प्रशासक उत्पाद की दृश्यता सेटिंग्स में असदस्य डेवलपर्स API विवरण देख सकते हैं विकल्प को अक्षम कर सकते हैं। यह सुनिश्चित करता है कि डेवलपर्स को उत्पाद की सदस्यता लेने के बाद ही इसके API तक पहुंच या आह्वान करने की अनुमति हो।

जब एक डेवलपर इस सेटिंग के तहत API उत्पाद विवरण पृष्ठ तक पहुंचता है, तो एक "सदस्यता लेकर अनलॉक करें" बटन प्रदर्शित होगा। बटन पर क्लिक करने से प्रोवाइडर प्रशासक को एक सदस्यता अनुरोध भेजा जाता है।

यदि API उत्पाद के लिए अनुमोदन प्रक्रिया सक्षम है, तो डेवलपर को विवरण देखने की पहुंच प्राप्त करने से पहले प्रशासक के अनुमोदन की प्रतीक्षा करनी होगी।

API7 प्रोवाइडर पोर्टल के संगठन मेनू में, यदि लंबित अनुमोदन हैं, तो अनुमोदन मेनू आइटम के बगल में एक लाल बिंदु प्रदर्शित होगा। इस मेनू आइटम पर क्लिक करने से अनुमोदन प्रबंधन पृष्ठ पर नेविगेट किया जाता है।

अनुमोदन पृष्ठ API संसाधनों तक पहुंचने के लिए डेवलपर अनुरोधों को प्रबंधित करने के लिए डिज़ाइन किया गया है। प्रशासक इस पृष्ठ पर निम्नलिखित अनुरोध जानकारी की समीक्षा कर सकते हैं: इवेंट प्रकार, संसाधन नाम, आवेदक और आवेदन समय। इंटरफ़ेस के माध्यम से, प्रशासक अनुरोध को अनुमोदित या अस्वीकार करने के लिए कार्रवाई कर सकते हैं।

अनुमोदन निर्णय सीधे डेवलपर की API पहुंच अनुमतियों को प्रभावित करता है:

• अनुमोदित करें: डेवलपर को API उत्पाद विवरण पृष्ठ देखने और API आह्वान करने की पहुंच मिलती है।
• अस्वीकार करें: डेवलपर को प्रशासक के साथ संवाद करना होगा, प्रतिक्रिया के आधार पर आवश्यक समायोजन करना होगा और अनुरोध को फिर से जमा करना होगा।

निष्कर्ष

API7 एंटरप्राइज़ API गेटवे प्लेटफॉर्म को डेवलपर पोर्टल के साथ एकीकृत करके API प्रदाताओं और डेवलपर्स दोनों के लिए एक कुशल API प्रबंधन समाधान बनाता है।

API7 प्रोवाइडर पोर्टल API प्रदाताओं को आसानी से API उत्पादों को प्रकाशित, प्रबंधित और निगरानी करने में सक्षम बनाता है, साथ ही डेवलपर संसाधनों को प्रभावी ढंग से समन्वयित करता है। इस बीच, डेवलपर्स API सेवाओं को जल्दी समझने, एकीकृत करने और कुशलता से उपयोग करने में सक्षम होते हैं, जिससे एप्लिकेशन विकास में तेजी आती है। ये दोनों पोर्टल API जीवनचक्र प्रबंधन प्रक्रिया को सुव्यवस्थित करने के लिए सहयोग करते हैं, जिससे प्रत्येक चरण—तैनाती से आह्वान तक—अधिक सहज और कुशल हो जाता है।