इंटिग्रेटेड पोर्टल बनाएं

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

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

Apigee Edge के सभी उपयोगकर्ताओं के पास, इंटिग्रेट किए गए पोर्टल डेवलपमेंट टूल का ऐक्सेस होता है. इससे वे अपने डेवलपर पोर्टल को तेज़ी से बना सकते हैं. साथ ही, Drupal पर आधारित पोर्टल डेवलपमेंट के विकल्प के तौर पर भी इसका इस्तेमाल किया जा सकता है. सुविधाओं की तुलना करने के लिए, डेवलपर पोर्टल की सुविधाओं की तुलना देखें.

इंटिग्रेट किया गया पोर्टल बनाने और पब्लिश करने के बारे में जानने के लिए, यह छोटा वीडियो देखें.

मुख्य सुविधाएं और फ़ायदे

इंटिग्रेट किए गए पोर्टल से आपको ये मुख्य सुविधाएं और फ़ायदे मिलते हैं:
सुविधा फ़ायदे
पोर्टल का कॉन्टेंट डेवलप करना अपने पोर्टल का कॉन्टेंट जल्दी और आसानी से बनाएं.
  • इस्तेमाल करने में आसान पेज एडिटर का इस्तेमाल करके पेज बनाना
  • कॉन्टेंट लिखने के लिए, मार्कडाउन और एचटीएमएल का इस्तेमाल करना
  • अपने पोर्टल पर नेविगेट करने के लिए मेन्यू जोड़ना
पोर्टल का लुक-एंड-फ़ील SCSS स्टाइल शीट और अपनी पसंद के मुताबिक ब्रैंडिंग का इस्तेमाल करके, अपने पोर्टल के लुक-एंड-फ़ील को पूरी तरह से पसंद के मुताबिक बनाएं.
API दस्तावेज़ीकरण OpenAPI स्पेसिफ़िकेशन के आधार पर, एपीआई का रेफ़रंस दस्तावेज़ अपने-आप जनरेट होता है.
खुद से रजिस्ट्रेशन करने की सुविधा डेवलपर को अपने-आप रजिस्टर करने की सुविधा दें, ताकि वे आपके एपीआई का इस्तेमाल करके ऐप्लिकेशन बना सकें.
ऑडियंस मैनेजमेंट यह कंट्रोल करना कि पोर्टल के कॉन्टेंट और एपीआई को कौन ऐक्सेस कर सकता है
Analytics Google Analytics और कस्टम आंकड़ों की ट्रैकिंग कॉन्फ़िगर करें.
बेहतर कस्टमाइज़ेशन पोर्टल को बेहतर तरीके से कस्टमाइज़ करें. इसमें ये काम शामिल हैं:
  • अपने डोमेन को पसंद के मुताबिक बनाना
  • कस्टम रजिस्ट्रेशन फ़ील्ड जोड़ना
  • स्क्रिप्ट का इस्तेमाल करके अपने पोर्टल को बेहतर बनाना
  • अपना ईमेल कॉन्फ़िगर करना

अपना पोर्टल बनाना शुरू करना

इंटिग्रेट किए गए पोर्टल में Apigee, सुरक्षा से जुड़ी समस्याओं को कैसे हल करता है

नीचे दी गई टेबल में बताया गया है कि इंटिग्रेट किए गए पोर्टल में पहले से मौजूद सुविधाओं की मदद से, Apigee सुरक्षा से जुड़ी समस्याओं को कैसे हल करता है.

सुविधा पते
एचटीटीपीएस और ट्रांसपोर्ट लेयर सिक्योरिटी (टीएलएस) की ज़रूरत है एन्क्रिप्ट (सुरक्षित) किए गए डेटा का इस्तेमाल करने की ज़रूरी शर्तें लागू करना
इसमें सार्वजनिक सफ़िक्स सूची के साथ apigee.io डोमेन रजिस्ट्रेशन शामिल है apigee.io के सबडोमेन पर "सुपर कुकी" सेट करने की अनुमति नहीं देता
कॉन्टेंट की सुरक्षा के बारे में नीति (सीएसपी) कॉन्फ़िगरेशन के साथ काम करता है क्रॉस-साइट स्क्रिप्टिंग (XSS) और कोड इंजेक्शन से जुड़े अन्य हमलों से बचाता है
इसके लिए ज़रूरी है:
  • फ़ॉर्म इनपुट को सैनिटाइज़ करना
  • साइट-वाइड JavaScript इंजेक्शन की सुविधा, सिर्फ़ एडमिन के लिए उपलब्ध है
एचटीएमएल, एसक्यूएल या बैकएंड इंजेक्शन हमलों से सुरक्षा देता है
इसमें x-content-type-options: nosniff XSS हेडर शामिल है ब्राउज़र को MIME टाइप का अनुमान लगाने से रोकता है
इसमें x-frame-options: deny XSS हेडर शामिल है पोर्टल के कॉन्टेंट को iFrame में एम्बेड करने की अनुमति नहीं देता
इसमें x-xss-protection: 1 XSS हेडर शामिल है रिफ़्लेक्टेड क्रॉस-साइट स्क्रिप्टिंग (XSS) के हमलों का पता चलने पर, पेजों को लोड होने से रोकता है
सीएसआरएफ़ टोकन का इस्तेमाल करता है किसी दूसरी साइट से किए जाने वाले फ़र्ज़ी अनुरोध से सुरक्षा
फ़ायदे: ग्राहक के डेटा की सुरक्षा

इंटिग्रेट किया गया पोर्टल, Edge के साथ कैसे काम करता है

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

इस बारे में ज़्यादा जानकारी यहां दी गई है.

ऐप्लिकेशन रजिस्ट्रेशन और एपीआई पासकोड कहां सेव किए जाते हैं

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

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

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

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

  • डेवलपर ऐप्लिकेशन जोड़ना, हटाना या उसमें बदलाव करना
  • डेवलपर ऐप्लिकेशन के लिए एपीआई पासकोड को स्वीकार या रद्द करना

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

ऐप्लिकेशन डेवलपर खाते की जानकारी कहां सेव की जाती है

डेवलपर खाते की जानकारी, Edge पर इस तरह से सेव की जाती है:

Edge पर उपयोगकर्ता खाते की यह जानकारी सेव की जाती है:

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

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

ज़्यादा जानकारी के लिए, ऐप्लिकेशन डेवलपर रजिस्टर करना लेख पढ़ें.

डेवलपर टीम की जानकारी कहां सेव की जाती है (बीटा वर्शन)

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

  • डेवलपर टीम का नाम और जानकारी
  • डेवलपर टीम के सदस्य और उनकी भूमिकाएं
  • वे ऐप्लिकेशन जिनके लिए डेवलपर टीम को असाइन किया गया है
  • डेवलपर टीम को असाइन की गई ऑडियंस
  • डेवलपर टीम बनाने का समय

डेवलपर टीम के लिए, अपने-आप जनरेट होने वाला एक यूनीक ईमेल पता जनरेट किया जाता है. यह ईमेल पता, Edge की मुख्य कुंजी के तौर पर काम करता है. Edge, इस कुंजी का इस्तेमाल डेवलपर टीम की पहचान करने के लिए करता है.

ज़्यादा जानकारी के लिए, डेवलपर टीमों (बीटा वर्शन) का इस्तेमाल करके, ऐप्लिकेशन की ज़िम्मेदारी शेयर करना और डेवलपर टीमों को मैनेज करना लेख पढ़ें.

सैंपल पोर्टल के बारे में जानकारी

नया पोर्टल बनाते समय, आपको स्टार्टर पेजों का एक सेट दिया जाता है. इनका इस्तेमाल, पोर्टल पर जाने के लिए किया जा सकता है. स्टार्टर पेजों में डेमो कॉन्टेंट होता है. इससे आपको अपने पोर्टल को डेवलप करने में मदद मिलती है. इसके लिए, आपको टेक्स्ट और इमेज को अपने यूनीक कॉन्टेंट से बदलना होगा. सैंपल पोर्टल थीम में, मटीरियल डिज़ाइन थीम और एससीएस का इस्तेमाल किया गया है.

यहां सैंपल पोर्टल का होम पेज दिखाया गया है.

सैंपल पोर्टल के साथ दिए गए स्टार्टर पेजों में ये शामिल हैं:

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

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

ध्यान दें: इस पेज का कॉन्टेंट, रजिस्टर किए गए उपयोगकर्ता ऐप्लिकेशन के आधार पर अपने-आप जनरेट होता है. पेज के कॉन्टेंट में सीधे तौर पर बदलाव नहीं किया जा सकता. यह पेजों की सूची में नहीं दिखता. थीम एडिटर का इस्तेमाल करके, पेज की स्टाइल में बदलाव किया जा सकता है.
साइन इन करें रजिस्टर किए गए उपयोगकर्ताओं के लिए साइन इन पेज. नए उपयोगकर्ता, इस पेज पर साइन इन करें पर क्लिक करके रजिस्टर कर सकते हैं. देखें कि पोर्टल के उपयोगकर्ता आपके पोर्टल से कैसे इंटरैक्ट करते हैं.

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

ब्राउज़र समर्थन

Apigee के इंटिग्रेट किए गए पोर्टल, Apigee Edge के साथ काम करने वाले ब्राउज़र वर्शन के साथ काम करते हैं.