यहां Apigee Edge के दस्तावेज़ देखे जा रहे हैं.
पर जाएं
Apigee X दस्तावेज़. info
कोई संगठन, Apigee Edge में टॉप-लेवल का कंटेनर होता है. इसमें आपकी सभी एपीआई प्रॉक्सी और उनसे जुड़े संसाधन शामिल होते हैं. इस विषय में संगठनों के बारे में ज़्यादा जानकारी दी गई है. हालांकि, यहां कुछ काम की बातें बताई गई हैं:
- डिफ़ॉल्ट रूप से, आपके संगठन का नाम उस यूआरएल में शामिल होता है जिसका इस्तेमाल, आपकी एपीआई प्रॉक्सी को कॉल करने के लिए किया जाता है.
इसके बारे में, वर्चुअल होस्ट के बारे में लेख में बताया गया है.
उदाहरण के लिए:
http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
- आपके संगठन का नाम, Edge के मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) के यूआरएल में शामिल होता है. उदाहरण के लिए, यहां दिए गए यूआरएल में
docsसंगठन के लिए एपीआई प्रॉक्सी दिखती हैं:
- हो सकता है कि आपने सिर्फ़ एक संगठन बनाया हो. हालांकि, आपके पास खास अनुमतियों के साथ, उपयोगकर्ता या एडमिन के तौर पर दूसरे संगठनों में शामिल होने का विकल्प होता है. Edge के मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) में, अगर आपका नाम एक से ज़्यादा संगठनों के लिए दर्ज है, तो अपने संगठनों के बीच स्विच करना में बताए गए तरीके से, किसी दूसरे संगठन पर स्विच किया जा सकता है.
- संगठन के एडमिन की भूमिका में, मैनेजमेंट एपीआई का इस्तेमाल करके कॉल करने पर, संगठन को ज़्यादातर कॉल में पाथ के ज़रूरी हिस्से के तौर पर शामिल किया जाता है. उदाहरण के लिए, मैनेजमेंट एपीआई के लिए यहां दिए गए
cURL अनुरोध से, किसी संगठन में मौजूद सभी एपीआई प्रॉक्सी की सूची मिलती है:
curl https://api.enterprise.apigee.com/v1/organizations/your_org_name/apis -u org_admin_email_address
वीडियो: एपीआई मैनेजमेंट के लिए, मल्टी-टेनेंसी आर्किटेक्चर में संगठन कैसे मदद करते हैं, यह जानने के लिए एक छोटा वीडियो देखें.
संगठन के कॉम्पोनेंट
Edge खाता बनाने पर, Edge आपके लिए एक संगठन अपने-आप बना देता है. संगठन बनने के बाद, उसमें उपयोगकर्ताओं को जोड़ा जा सकता है. साथ ही, एपीआई प्रॉक्सी और एपीआई प्रॉडक्ट बनाए जा सकते हैं. इसके अलावा, डेवलपर और ऐप्लिकेशन रजिस्टर किए जा सकते हैं.
यहां दी गई इमेज में, Edge के संगठन मॉडल के मुख्य कॉम्पोनेंट दिखाए गए हैं. इस मॉडल से यह तय होता है कि Edge में आपके एपीआई, एपीआई प्रॉडक्ट, ऐप्लिकेशन, और ऐप्लिकेशन डेवलपर आपस में कैसे जुड़े हैं.
इस मॉडल में, Apigee Edge की सभी सुविधाएं नहीं दिखाई गई हैं. अगर कमाई करने की सुविधा का इस्तेमाल किया जाता है, तो मॉडल में अतिरिक्त कॉम्पोनेंट शामिल होंगे. ज़्यादा जानकारी के लिए, कमाई करने की सुविधा की खास जानकारी देखें. कमाई करने की सुविधा की मदद से, कंपनियों और डेवलपर को मैनेज करने के बारे में जानने के लिए, कंपनियां और डेवलपर मैनेज करना लेख पढ़ें.
संगठनों के नाम
संगठन का नाम यह है:
- इवैल्युएशन ऑर्गनाइज़ेशन:
username-eval - पेड ऑर्गनाइज़ेशन: शुरुआती तौर पर सेवा देने के समय, उपयोगकर्ता की ओर से तय किया गया नाम
संगठन बनने के बाद, उसका नाम नहीं बदला जा सकता.
संगठन का नाम, आपकी एपीआई प्रॉक्सी के यूआरएल का हिस्सा बन जाता है. साथ ही, Edge के मैनेजमेंट एपीआई को अनुरोध करते समय, यह यूआरएल का हिस्सा भी होता है. उदाहरण के लिए, एपीआई प्रॉक्सी को ऐक्सेस करने के लिए इस्तेमाल किए जाने वाले सामान्य यूआरएल का फ़ॉर्मैट यह होता है:
http://org-name-env.apigee.net/v1/weather/forecastrss
कहां:
- org-name, आपके संगठन का नाम है.
- env एपीआई प्रॉक्सी का डिप्लॉयमेंट एनवायरमेंट है. यह test या prod हो सकता है.
उदाहरण के लिए:
http://myorg-test.apigee.net/v1/weather/forecastrss
संगठन के कॉम्पोनेंट
यहां दी गई टेबल में, संगठन मॉडल के कॉम्पोनेंट के बारे में ज़्यादा जानकारी दी गई है:
| कॉम्पोनेंट | ब्यौरा |
|---|---|
|
संगठन |
हर Apigee खाता, Apigee Edge पर एक या उससे ज़्यादा संगठनों से मैप होता है. संगठन में, सभी कॉम्पोनेंट की जानकारी शामिल होती है. जैसे, एपीआई प्रॉक्सी, एपीआई प्रॉडक्ट, एपीआई पैकेज, ऐप्लिकेशन, और डेवलपर. खाताधारकों के पास, सिर्फ़ एक संगठन का ऐक्सेस नहीं होता. कुछ खाताधारक, एक से ज़्यादा संगठन तय कर सकते हैं या उनके सदस्य हो सकते हैं. ये संगठन, अलग-अलग ऐप्लिकेशन डेवलपर कम्यूनिटी को सपोर्ट करते हैं. |
| परिवेश | किसी संगठन में, एपीआई प्रॉक्सी के लिए रनटाइम एक्ज़ीक्यूशन कॉन्टेक्स्ट. एनवायरमेंट के बारे में ज़्यादा जानने के लिए, नीचे दिया गया सेक्शन देखें. |
|
उपयोगकर्ता |
किसी संगठन में, खाता बनाने वाला व्यक्ति अपने-आप एडमिन बन जाता है. इसके अलावा, अन्य उपयोगकर्ताओं को भी जोड़ा जा सकता है. उपयोगकर्ता, संगठन की एपीआई टीम बनाते हैं, इसमें एडमिन, एपीआई प्रॉक्सी और एपीआई प्रॉडक्ट बनाने वाले लोग, आंकड़ों और अन्य आंकड़ों की निगरानी करने वाले उपयोगकर्ता, और अन्य लोग शामिल हो सकते हैं. अलग-अलग उपयोगकर्ताओं की अलग-अलग भूमिकाएं और ऐक्सेस के अधिकार हो सकते हैं. उदाहरण के लिए, कुछ उपयोगकर्ताओं को संगठन के एडमिन और ऑपरेशन एडमिन के तौर पर तय करें. इनके पास संगठन और उसके कॉम्पोनेंट में बदलाव करने के अधिकार होते हैं. अन्य उपयोगकर्ताओं को एपीआई प्रॉक्सी और एपीआई प्रॉडक्ट बनाने की अनुमति दें, लेकिन उनके पास अन्य उपयोगकर्ताओं में बदलाव करने के अधिकार न हों. उपयोगकर्ता, एक से ज़्यादा संगठनों के सदस्य हो सकते हैं. उदाहरण के लिए, आपकी कंपनी, अलग-अलग डेवलपर कम्यूनिटी को सपोर्ट करने के लिए, Apigee Edge पर एक से ज़्यादा संगठन तय कर सकती है. हालांकि, अंदरूनी तौर पर, एक ही टीम सभी एपीआई प्रॉक्सी और एपीआई प्रॉडक्ट बनाती है. इसलिए, यह टीम आपके सभी संगठनों की सदस्य होती है. उपयोगकर्ता बनने के लिए, Apigee खाता बनाने की ज़रूरत नहीं होती. इसका मतलब है कि Apigee संगठन बनाने की ज़रूरत नहीं होती. कोई एडमिन, आपको किसी मौजूदा संगठन में जोड़ सकता है. सभी उपयोगकर्ता, Apigee Edge में यहां लॉग इन करते हैं: https://enterprise.apigee.com. |
|
एपीआई प्रॉक्सी |
किसी संगठन में मौजूद उपयोगकर्ता, एक या उससे ज़्यादा एपीआई प्रॉक्सी बनाते हैं. एपीआई प्रॉक्सी, सार्वजनिक तौर पर उपलब्ध एचटीटीपी एंडपॉइंट को बैकएंड सेवा से मैप करती है. एपीआई प्रॉक्सी को सुरक्षा (जैसे, OAuth) शामिल करने, मैसेज ट्रांसफ़ॉर्मेशन (जैसे, एक्सएमएल से JSON) करने, बैकएंड सेवाओं के लिए ट्रैफ़िक सीमित करने, और अनुरोध, जवाब, और सेवा कॉलआउट पर अन्य ज़रूरी कार्रवाइयां करने के लिए भी कॉन्फ़िगर किया जा सकता है. Edge, एपीआई प्रॉक्सी पर आंकड़ों के लिए डेटा इकट्ठा करता है. |
|
एपीआई प्रॉडक्ट |
किसी संगठन में मौजूद उपयोगकर्ता, एक या उससे ज़्यादा एपीआई प्रॉडक्ट बनाते हैं. एपीआई प्रॉडक्ट, एपीआई प्रॉक्सी का बंडल होता है. इसमें सेवा प्लान भी शामिल होता है. सेवा प्लान, एपीआई प्रॉक्सी पर ऐक्सेस की सीमाएं सेट कर सकता है, सुरक्षा दे सकता है, निगरानी और आंकड़ों की अनुमति दे सकता है, और अतिरिक्त सुविधाएं दे सकता है. Edge, एपीआई प्रॉडक्ट पर आंकड़ों के लिए डेटा इकट्ठा करता है. |
|
डेवलपर |
किसी संगठन में एक या उससे ज़्यादा डेवलपर शामिल होते हैं. ये डेवलपर, ऐसे ऐप्लिकेशन बनाते हैं जो आपके संगठन की ओर से तय किए गए एपीआई (एपीआई प्रॉडक्ट में असेंबल किए गए) का इस्तेमाल करते हैं. डेवलपर, एपीआई का इस्तेमाल कर सकते हैं लेकिन वे एपीआई नहीं बना सकते या संगठन में कोई अन्य कार्रवाई नहीं कर सकते. डेवलपर, आपकी कंपनी के अंदर के हो सकते हैं. वे पार्टनर हो सकते हैं या बाहरी डेवलपर हो सकते हैं. बाहरी डेवलपर, आपके एपीआई को ऐक्सेस करने के लिए शुल्क चुकाते हैं. डेवलपर को आपके एपीआई को ऐक्सेस करने के लिए, ऐप्लिकेशन रजिस्टर करने और एपीआई पासकोड पाने से पहले, आपके संगठन में रजिस्टर करना होगा. एपीआई की सेवा देने वाली कंपनी के तौर पर, यह तय करना आपके ऊपर है कि अपने संगठन में डेवलपर को कैसे जोड़ा जाए, अपडेट किया जाए या हटाया जाए. उन्हें Edge के मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) के ज़रिए मैन्युअल तरीके से जोड़ा जा सकता है. साथ ही, वेबसाइट के ज़रिए रजिस्टर करने के लिए, डेवलपर पोर्टल बनाया जा सकता है. इसके अलावा, Edge के मैनेजमेंट एपीआई का इस्तेमाल करके, अपना रजिस्ट्रेशन मैकेनिज़्म तय किया जा सकता है. डेवलपर के पास Edge पर खाता होना ज़रूरी नहीं है. साथ ही, ज़्यादातर डेवलपर को Edge के बारे में कुछ भी जानने की ज़रूरत नहीं होगी. अगर डेवलपर के पास Edge पर खाता है, तो आम तौर पर वह किसी दूसरे संगठन में उपयोगकर्ता के तौर पर या Edge की एपीआई सेवाओं का इस्तेमाल करने के लिए होता है. |
|
ऐप्लिकेशन |
डेवलपर, एक या उससे ज़्यादा क्लाइंट ऐप्लिकेशन बनाते हैं. ये ऐप्लिकेशन, आपके एपीआई का इस्तेमाल करते हैं. डेवलपर को अपने ऐप्लिकेशन, आपके संगठन के साथ रजिस्टर करने होंगे. Edge में कोई ऐप्लिकेशन, डेवलपर के असली ऐप्लिकेशन को दिखाता है. इससे डेवलपर को आपके एपीआई के हर अनुरोध के साथ, एपीआई पासकोड मिलता है. सभी ऐप्लिकेशन आपके संगठन में रजिस्टर होते हैं. इसलिए, Edge का इस्तेमाल करके, ऐप्लिकेशन और आपके एपीआई के इस्तेमाल की निगरानी की जा सकती है. साथ ही, आंकड़ों की जानकारी इकट्ठा की जा सकती है. |
|
एपीआई पासकोड/OAuth टोकन |
आपके एपीआई के लिए तय किए गए अनुमति देने के मैकेनिज़्म के आधार पर, ऐप्लिकेशन आपके एपीआई के हर अनुरोध के साथ, एक एपीआई पासकोड भेजता है. अगर वह पासकोड मान्य है, तो अनुरोध स्वीकार किया जाता है. Edge, अलग-अलग तरह के ऑथेंटिकेशन को सपोर्ट करता है. जैसे, सामान्य एपीआई पासकोड, दो-लेग वाला OAuth, तीन-लेग वाला OAuth वगैरह. एपीआई की सेवा देने वाली कंपनी के तौर पर, आपको डेवलपर के लिए अपने ऐप्लिकेशन रजिस्टर करने का तरीका तय करना होगा. ऐप्लिकेशन रजिस्टर करने पर, डेवलपर को आपके एपीआई को ऐक्सेस करने के लिए ज़रूरी पासकोड मिलता है. ऐप्लिकेशन रजिस्टर करते समय, डेवलपर के पास एक या एक से ज़्यादा एपीआई प्रॉडक्ट को ऐक्सेस करने का विकल्प होता है. डेवलपर का असली ऐप्लिकेशन, ऐप्लिकेशन से जुड़े सभी एपीआई प्रॉडक्ट को ऐक्सेस करने के लिए, उसी पासकोड का इस्तेमाल करता है. यह पासकोड, Edge में डेवलपर के ऐप्लिकेशन के रजिस्टर किए गए वर्शन के लिए होता है. आपके पास किसी भी समय पासकोड रद्द करने का विकल्प होता है. ऐसा करने पर, डेवलपर के ऐप्लिकेशन के पास आपके एपीआई का ऐक्सेस नहीं रहता भले ही, डेवलपर के ऐप्लिकेशन का रजिस्टर किया गया वर्शन अब भी आपके संगठन में मौजूद हो. इसके अलावा, पासकोड के लिए समयसीमा तय की जा सकती है. इससे डेवलपर को एक तय समय के बाद, पासकोड को रीफ़्रेश करना होगा. |
एनवायरमेंट के बारे में जानकारी
एनवायरमेंट, किसी संगठन में एपीआई प्रॉक्सी के लिए रनटाइम एक्ज़ीक्यूशन कॉन्टेक्स्ट होता है. किसी एपीआई प्रॉक्सी को ऐक्सेस करने से पहले, उसे किसी एनवायरमेंट में डिप्लॉय करना ज़रूरी है. किसी एपीआई प्रॉक्सी को एक या एक से ज़्यादा एनवायरमेंट में डिप्लॉय किया जा सकता है.
किसी संगठन में एक से ज़्यादा एनवायरमेंट हो सकते हैं. उदाहरण के लिए, किसी संगठन में dev,
test, और prod एनवायरमेंट तय किए जा सकते हैं.
संगठन, Apigee की कुछ क्षमताओं के लिए स्कोप उपलब्ध कराता है. उदाहरण के लिए, कुंजी-वैल्यू-मैप (केवीएम) डेटा को संगठन के लेवल पर उपलब्ध कराया जा सकता है. इसका मतलब है कि किसी भी एनवायरमेंट में डिप्लॉय की गई एपीआई प्रॉक्सी को, केवीएम से एक जैसा डेटा मिलेगा. कुछ क्षमताओं, जैसे कि कैश मेमोरी में सेव करने की सुविधा को संगठन या संगठन में मौजूद किसी खास एनवायरमेंट के लिए स्कोप किया जा सकता है. Apigee के आंकड़ों का डेटा, संगठन और एनवायरमेंट के कॉम्बिनेशन के हिसाब से बांटा जाता है.
यहां उन मुख्य एंटिटी के बारे में बताया गया है जिन्हें किसी संगठन में मैनेज किया जाता है. इनमें वे एंटिटी भी शामिल हैं जिन्हें संगठन में ग्लोबल तौर पर तय किया गया है. साथ ही, वे एंटिटी भी शामिल हैं जिन्हें खास तौर पर किसी एनवायरमेंट के लिए तय किया गया है:
