आपको Apigee Edge का दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी
Apigee Edge, इस्तेमाल करने में आसान और इंटिग्रेट किया गया पोर्टल उपलब्ध कराता है. इसकी मदद से, अपने एपीआई के ऐक्सेस को मैनेज किया जा सकता है और उनके बारे में जानकारी दी जा सकती है. साथ ही, ऐप्लिकेशन डेवलपर कम्यूनिटी को बढ़ावा दिया जा सकता है.
Apigee Edge के सभी उपयोगकर्ताओं के पास, इंटिग्रेट किए गए पोर्टल डेवलपमेंट टूल का ऐक्सेस होता है. इससे वे अपना डेवलपर पोर्टल तुरंत बना सकते हैं. यह Drupal पर आधारित पोर्टल डेवलपमेंट का विकल्प देता है. सुविधाओं की तुलना करने के लिए, डेवलपर पोर्टल की सुविधाओं की तुलना लेख पढ़ें.
इंटिग्रेट किए गए पोर्टल को बनाने और पब्लिश करने के बारे में जानने के लिए, यह छोटा वीडियो देखें.
मुख्य सुविधाएं और फ़ायदे
इंटिग्रेट किए गए पोर्टल से आपको ये मुख्य सुविधाएं और फ़ायदे मिलते हैं:| सुविधा | फ़ायदे |
|---|---|
| पोर्टल के लिए कॉन्टेंट डेवलपमेंट | अपने पोर्टल का कॉन्टेंट आसानी से और जल्दी तैयार करें.
|
| पोर्टल का रंग-रूप | SCSS स्टाइल शीट और पसंद के मुताबिक ब्रैंडिंग का इस्तेमाल करके, अपने पोर्टल के लुक-एंड-फ़ील को पूरी तरह से पसंद के मुताबिक बनाएं. |
| API दस्तावेज़ीकरण | अपने OpenAPI स्पेसिफ़िकेशन के आधार पर, एपीआई का संदर्भ दस्तावेज़ अपने-आप जनरेट करें. |
| खुद से रजिस्टर करने की सुविधा | डेवलपर को, आपके एपीआई का इस्तेमाल करके ऐप्लिकेशन बनाने के लिए, खुद से रजिस्टर करने की सुविधा दें. |
| ऑडियंस मैनेजमेंट | यह कंट्रोल करना कि पोर्टल के कॉन्टेंट और एपीआई को कौन ऐक्सेस कर सकता है |
| Analytics | Google Analytics और कस्टम Analytics ट्रैकिंग को कॉन्फ़िगर करें. |
| ऐडवांस कस्टमाइज़ेशन | पोर्टल को बेहतर तरीके से कस्टमाइज़ करें. इनमें ये शामिल हैं:
|
अपना पोर्टल बनाना शुरू करें
Apigee, इंटिग्रेटेड पोर्टल में सुरक्षा से जुड़ी समस्याओं को कैसे हल करता है
नीचे दी गई टेबल में बताया गया है कि Apigee, इंटिग्रेट किए गए पोर्टल में पहले से मौजूद सुविधाओं के ज़रिए सुरक्षा से जुड़ी समस्याओं को कैसे हल करता है.
| सुविधा | पते |
|---|---|
| इसके लिए, एचटीटीपीएस और ट्रांसपोर्ट लेयर सिक्योरिटी (टीएलएस) ज़रूरी है | एन्क्रिप्ट (सुरक्षित) किए गए कम्यूनिकेशन को लागू करता है |
इसमें सार्वजनिक सफ़िक्स सूची के साथ apigee.io डोमेन का रजिस्ट्रेशन शामिल है
|
यह कुकी, apigee.io के सबडोमेन पर "सुपरकुकी" सेट होने से रोकती है
|
| कॉन्टेंट की सुरक्षा के बारे में नीति (सीएसपी) के कॉन्फ़िगरेशन के साथ काम करता है | यह क्रॉस-साइट स्क्रिप्टिंग (XSS) और कोड इंजेक्ट करने से जुड़े अन्य हमलों से बचाता है |
इसके लिए ज़रूरी है:
|
यह एचटीएमएल, एसक्यूएल या बैकएंड इंजेक्शन के हमलों से बचाता है |
इसमें 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 को जानकारी भेजने के लिए, एचटीटीपी या एचटीटीपीएस REST अनुरोध भेजता है. उदाहरण के लिए, जब पोर्टल का कोई उपयोगकर्ता पोर्टल पर नया ऐप्लिकेशन रजिस्टर करता है, तो पोर्टल, Edge को ऐप्लिकेशन के बारे में जानकारी सेव करने का अनुरोध भेजता है.

यहां दिए गए सेक्शन में ज़्यादा जानकारी दी गई है.
ऐप्लिकेशन रजिस्ट्रेशन और एपीआई पासकोड कहां सेव किए जाते हैं
जब पोर्टल का कोई उपयोगकर्ता, इंटिग्रेट किए गए पोर्टल पर ऐप्लिकेशन रजिस्टर करने की प्रोसेस पूरी करता है, तो पोर्टल, Apigee Edge को ऐप्लिकेशन के बारे में जानकारी भेजता है. इसमें ऐप्लिकेशन का नाम और ऐप्लिकेशन से जुड़े एपीआई प्रॉडक्ट शामिल होते हैं. अगर Edge, ऐप्लिकेशन को रजिस्टर कर लेता है, तो Edge, पोर्टल को एक एपीआई पासकोड भेजता है. पोर्टल का उपयोगकर्ता, उस एपीआई कुंजी का इस्तेमाल करके ऐप्लिकेशन से जुड़े एपीआई प्रॉडक्ट को ऐक्सेस करता है.
ऐप्लिकेशन और एपीआई कुंजियों के बारे में जानकारी सिर्फ़ Edge पर सेव की जाती है. इसे पोर्टल पर सेव नहीं किया जाता. जब पोर्टल का कोई उपयोगकर्ता, पोर्टल का इस्तेमाल करके किसी ऐप्लिकेशन के बारे में जानकारी देखता है, तो पोर्टल, Edge से जानकारी को ऐक्सेस करने का अनुरोध करता है. इसके लिए, वह एपीआई कुंजी का इस्तेमाल करता है. उदाहरण के लिए, 'मेरे ऐप्लिकेशन' पेज के ज़रिए जानकारी देखना.
इसी तरह, जब कोई पोर्टल उपयोगकर्ता किसी ऐप्लिकेशन को जोड़ता है, हटाता है या उसमें बदलाव करता है, तो पोर्टल उन बदलावों को Edge को भेजता है, ताकि उन्हें सेव किया जा सके.
ऐप्लिकेशन और एपीआई कुंजियों से जुड़ी सभी जानकारी Edge पर सेव की जाती है. इसलिए, Edge एडमिन, Edge यूज़र इंटरफ़ेस (यूआई) या मैनेजमेंट एपीआई का इस्तेमाल करके जानकारी में बदलाव कर सकता है. उदाहरण के लिए, एडमिन ये काम कर सकता है:
- डेवलपर के ऐप्लिकेशन को जोड़ना, हटाना या उसमें बदलाव करना
- किसी डेवलपर ऐप्लिकेशन के लिए एपीआई पासकोड को स्वीकार करना या रद्द करना
ज़्यादा जानकारी के लिए, ऐप्लिकेशन रजिस्टर करना और एपीआई कुंजियां मैनेज करना लेख पढ़ें.
ऐप्लिकेशन डेवलपर खाते की जानकारी कहां सेव की जाती है
डेवलपर खाते की जानकारी को Edge पर इस तरह से सेव किया जाता है:
- पहले से मौजूद आइडेंटिटी प्रोवाइडर का इस्तेमाल करने पर, जब पोर्टल का कोई उपयोगकर्ता खाता बनाता है, तो उसकी जानकारी आइडेंटिटी प्रोवाइडर में सेव हो जाती है. साथ ही, यह उपयोगकर्ता पेज पर दिखती है.
- जब पोर्टल का कोई उपयोगकर्ता, एसएएमएल आइडेंटिटी प्रोवाइडर का इस्तेमाल करके पोर्टल में साइन इन करता है, तो उसकी जानकारी का शैडो रिकॉर्ड, आइडेंटिटी प्रोवाइडर में सेव हो जाता है. यह जानकारी, उपयोगकर्ता पेज पर दिखती है.
- पोर्टल उपयोगकर्ता के डेवलपर ऐप्लिकेशन रजिस्टर करने के बाद, उपयोगकर्ता खाते की जानकारी Edge पर Developers page पर सिंक हो जाती है और वहां उपलब्ध होती है.
Edge पर उपयोगकर्ता के खाते की यह जानकारी सेव की जाती है:
- प्रथम और उपनाम
- ईमेल पता
- उपयोगकर्ता नाम
- पोर्टल खाते की स्थिति (चालू है या बंद है)
- पोर्टल की भूमिका (पुष्टि किया गया उपयोगकर्ता, एडमिन, अन्य)
- भूमिका के आधार पर अनुमतियां
- वे टीमें जिनमें पोर्टल का उपयोगकर्ता सदस्य है. हालांकि, ऐसा सिर्फ़ तब होगा, जब आपने टीम की सुविधा की बीटा रिलीज़ के लिए रजिस्टर किया हो
ईमेल पता, Edge की ओर से डेवलपर की पहचान करने के लिए इस्तेमाल की जाने वाली प्राइमरी कुंजी है. साथ ही, हर ईमेल पता यूनीक होना चाहिए. प्राइमरी कुंजी से, Edge हर उस संगठन के लिए एक यूनीक डेवलपर आईडी जनरेट करता है जिससे डेवलपर जुड़ा है.
ज़्यादा जानकारी के लिए, ऐप्लिकेशन डेवलपर रजिस्टर करना लेख पढ़ें.
डेवलपर टीम की जानकारी कहां सेव की जाती है (बीटा वर्शन)
जब पोर्टल का कोई उपयोगकर्ता, पोर्टल पर डेवलपर टीम बनाता है, तो डेवलपर टीम की जानकारी Edge पर सेव की जाती है. इसमें यह जानकारी शामिल होती है:
- डेवलपर टीम का नाम और जानकारी
- डेवलपर टीम के सदस्य और उनकी भूमिकाएं
- ऐसे ऐप्लिकेशन जिनके लिए डेवलपर टीम को असाइन किया गया है
- डेवलपर टीम को असाइन की गई ऑडियंस
- डेवलपर टीम बनाए जाने का समय
डेवलपर टीम के लिए, अपने-आप जनरेट होने वाला एक यूनीक ईमेल पता जनरेट होता है. यह मुख्य कुंजी के तौर पर काम करता है. Edge इसका इस्तेमाल, डेवलपर टीम की पहचान करने के लिए करता है.
ज़्यादा जानकारी के लिए, डेवलपर टीम (बीटा वर्शन) का इस्तेमाल करके, किसी ऐप्लिकेशन की ज़िम्मेदारी शेयर करना और डेवलपर टीम मैनेज करना लेख पढ़ें.
सैंपल पोर्टल के बारे में जानकारी
नया पोर्टल बनाते समय, आपको स्टार्टर पेजों का एक सेट दिया जाता है. इनका इस्तेमाल करके, पोर्टल को शुरू किया जा सकता है. स्टार्टर पेजों में डेमो कॉन्टेंट होता है. इससे आपको अपना पोर्टल बनाने में मदद मिलती है. इसके लिए, आपको टेक्स्ट और इमेज को अपने यूनीक कॉन्टेंट से बदलना होगा. सैंपल पोर्टल थीम में, मटीरियल डिज़ाइन थीमिंग और SCSS का इस्तेमाल किया गया है.
यहां सैंपल पोर्टल का होम पेज दिखाया गया है.

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