शब्दावली

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

Apigee में कई ऐसे कॉन्सेप्ट हैं जो आम तौर पर इस्तेमाल होने वाले आइडिया हैं, लेकिन उनका मतलब Apigee में अलग है.

शब्द परिभाषा
एपीआई एक प्रॉक्सी, जो आपके मौजूदा एपीआई के लिए फ़ेसेड के तौर पर काम करती है. डेवलपर, आपके मौजूदा एपीआई को कॉल करने के बजाय, Apigee से जनरेट किए गए नए एपीआई को कॉल करना शुरू कर देते हैं. यह फ़ेसेड, आपके सार्वजनिक इंटरफ़ेस को बैकएंड एपीआई से अलग करता है. इससे डेवलपर को बैकएंड में होने वाले बदलावों से बचाया जा सकता है. साथ ही, इससे आपको अपनी इंटरनल डेवलपमेंट टीमों पर असर डाले बिना, नए-नए आइडिया आज़माने में मदद मिलती है. बैकएंड में बदलाव करने पर, डेवलपर उसी एपीआई को बिना किसी रुकावट के कॉल करते रहते हैं. ज़्यादा बेहतर परिस्थितियों में, Apigee की मदद से एक ही एपीआई के लिए कई इंटरफ़ेस दिखाए जा सकते हैं. इससे, एक साथ कई डेवलपर के हिसाब से एपीआई के हस्ताक्षर को पसंद के मुताबिक बनाया जा सकता है.
एपीआई का बेस पाथ और संसाधन एपीआई, बेस पाथ और संसाधनों के एक सेट से बना होता है. इसे संसाधन पाथ भी कहा जाता है. हर एपीआई के लिए, एक रूट यूआरएल और कई संसाधन पाथ तय किए जाते हैं. एपीआई को यूआरआई के सेट के तौर पर देखा जा सकता है. इन सभी में एक ही बेस पाथ होता है. आपके एपीआई को आसानी से मैनेज करने के लिए, Apigee इन रॉ यूआरआई को डिसप्ले नेम और जानकारी के साथ बेहतर बनाता है.
एपीआई का इस्तेमाल करने वाला व्यक्ति या कंपनी "ऐप्लिकेशन डेवलपर" का दूसरा नाम. यह एपीआई उपलब्ध कराने वाली कंपनी के बनाए गए एपीआई का इस्तेमाल करता है.
एपीआई डेवलपर एपीआई उपलब्ध कराने वाले संगठन में काम करने वाला सॉफ़्टवेयर इंजीनियर, जो एपीआई बनाता है. ऐप्लिकेशन बनाने के लिए, ऐप्लिकेशन डेवलपर (एपीआई का इस्तेमाल करने वाले लोग) उन एपीआई का इस्तेमाल करते हैं.
एपीआई पैकेज API प्रॉडक्ट का एक कलेक्शन, जिसे डेवलपर को बंडल के तौर पर दिखाया जाता है और आम तौर पर यह किराये के प्लान से जुड़ा होता है.
एपीआई प्रॉडक्ट एपीआई संसाधनों (यूआरआई) का एक कलेक्शन, जिसे सेवा प्लान के साथ जोड़ा जाता है और डेवलपर को बंडल के तौर पर दिखाया जाता है. एपीआई प्रॉडक्ट में, निगरानी या आंकड़ों के लिए आपके कारोबार से जुड़ा कुछ मेटाडेटा भी शामिल हो सकता है. एक या एक से ज़्यादा संसाधनों से कमाई करने के लिए, उन्हें एपीआई प्रॉडक्ट में शामिल किया जा सकता है. इसके बाद, कमाई करने के लिए उन्हें एपीआई पैकेज में बंडल किया जा सकता है.
एपीआई की सेवा देने वाली कंपनी एपीआई उपलब्ध कराने वाली कंपनी, एपीआई का इस्तेमाल करने वाले लोगों (ऐप्लिकेशन डेवलपर) के लिए, Edge का इस्तेमाल करके एपीआई बनाती है.
ऐप्लिकेशन डेवलपर Edge में, ऐप्लिकेशन डेवलपर अपने ऐप्लिकेशन को एपीआई की सेवा देने वाली कंपनी के साथ रजिस्टर करते हैं. इससे, ऐप्लिकेशन डेवलपर को एपीआई पासकोड मिलते हैं. इन पासकोड की मदद से, वे एपीआई की सेवा देने वाली कंपनी के एपीआई प्रॉक्सी को कॉल कर पाते हैं.
ऐप्लिकेशन आपके डेवलपर, आपके एपीआई प्रॉडक्ट में मौजूद संसाधनों को ऐक्सेस करने के लिए ऐप्लिकेशन का इस्तेमाल करते हैं. ऐप्लिकेशन बनाते समय, आपको शामिल करने के लिए एपीआई प्रॉडक्ट चुनना होता है और Apigee एक कुंजी जनरेट करता है. हर ऐप्लिकेशन में एक ऐसी पासकोड होती है जो कई एपीआई प्रॉडक्ट का ऐक्सेस देती है. ऐप्लिकेशन की मदद से, यह कंट्रोल किया जा सकता है कि आपके संसाधनों को कौन ऐक्सेस कर सकता है. ऐप्लिकेशन की कुंजी को रद्द करके और उसे रीफ़्रेश करके, यह कंट्रोल किया जा सकता है कि आपके एपीआई प्रॉडक्ट का ऐक्सेस किसके पास है. साथ ही, किसी ऐप्लिकेशन में मौजूद प्रॉडक्ट का ऐक्सेस रद्द करके या मिटाकर, संसाधनों के बंडल का ऐक्सेस कंट्रोल किया जा सकता है.
बैलेंस की जानकारी प्री-पेड डेवलपर के लिए, डेवलपर खाते में मौजूद बैलेंस.
बंद किया गया अडजस्टमेंट पब्लिश किए गए बिलिंग दस्तावेज़ों में लागू किया गया बदलाव.
बिलिंग के लिए चुना गया महीना वह पूरा कैलेंडर महीना जिसके लिए बिलिंग दस्तावेज़ पब्लिश किए गए हैं.
पसंद के मुताबिक सीमा ऐसी सीमा जिसे कमाई करने की सुविधा का इस्तेमाल करके, साफ़ तौर पर सेट अप किया जा सकता है. जैसे, एपीआई प्रॉडक्ट पर लेन-देन की संख्या की सीमा. इसे साफ़ तौर पर तय की गई सीमा भी कहा जाता है.
डेवलपर कैटगरी के हिसाब से तय किया गया किराया किराया प्लान, जो किसी खास कैटगरी के सभी डेवलपर पर लागू होता है और उस कैटगरी के सभी डेवलपर के लिए खरीदारी के लिए उपलब्ध होता है.
डेवलपर के लिए तय किया गया किराया प्लान किराया प्लान, जो किसी खास डेवलपर पर लागू होता है और जिसे सिर्फ़ वह डेवलपर खरीद सकता है.
एजेंट की जानकारी ज़ाहिर की गई व्यावसायिक कानून के तहत, वह व्यक्ति जिसके पास किसी तीसरे पक्ष के साथ कानूनी संबंध बनाने के लिए, किसी दूसरे व्यक्ति (जिसे मुख्य व्यक्ति कहा जाता है) की ओर से कार्रवाई करने का अधिकार होता है. कमाई करने के लिए, आय के बंटवारे वाले प्लान के लिए टैक्स मॉडल सेट अप किया जा सकता है. इससे एपीआई की सेवा देने वाली कंपनी, डेवलपर की ओर से आय (और शायद बिक्री पर लगने वाला टैक्स) इकट्ठा करने के लिए, डेवलपर के एजेंट के तौर पर काम करती है.
टैक्स के लिए इस्तेमाल किया जाने वाला मॉडल टैक्स का ऐसा मॉडल जिसमें एपीआई उपलब्ध कराने वाली कंपनी, डेवलपर के एजेंट के तौर पर काम करती है.
environment एपीआई के लिए, रनटाइम एक्सीक्यूशन कॉन्टेक्स्ट. एपीआई को किसी एनवायरमेंट में डिप्लॉय करना ज़रूरी है, ताकि उसे रनटाइम के दौरान ऐक्सेस किया जा सके. डिफ़ॉल्ट रूप से, Apigee संगठनों के लिए दो एनवायरमेंट उपलब्ध होते हैं: 'टेस्ट' और 'प्रोडक्शन'. आम तौर पर, 'टेस्ट' एनवायरमेंट का इस्तेमाल, जांच के दौर में रहे एपीआई को डिप्लॉय करने के लिए किया जाता है. आम तौर पर, 'prod' एनवायरमेंट का इस्तेमाल, प्रोडक्शन में इस्तेमाल करने के लिए एपीआई को डिप्लॉय करने के लिए किया जाता है.
हाइब्रिड टैक्स मॉडल टैक्स का ऐसा मॉडल जिसमें एपीआई उपलब्ध कराने वाली कंपनी, डेवलपर के एजेंट के तौर पर काम करती है. हालांकि, एपीआई की सेवा देने वाली कंपनी, अपने सदस्यों से लिए गए सेल्स टैक्स को डेवलपर की ओर से, स्थानीय टैक्स विभाग को चुकाती है.
अप्रत्यक्ष सीमा कमाई करने की सुविधा से जुड़ी सीमा, जैसे कि डेवलपर के प्रीपेड बैलेंस की सीमा.
कमाई करना Apigee Edge डेवलपर सेवाओं का एक कॉम्पोनेंट, जो एपीआई प्रॉडक्ट से कमाई करने का आसान और सुविधाजनक तरीका उपलब्ध कराता है.
हर महीने इस्तेमाल की गई रकम किसी महीने के लिए, डेवलपर के कुल ट्रांज़ैक्शन की संख्या. इसमें सेटअप शुल्क + लेन-देन शुल्क + बार-बार लगने वाला शुल्क शामिल है.
हर महीने पैसे चुकाने का प्लान खरीदे गए प्लान के आधार पर, डेवलपर को बार-बार किए जाने वाले पेमेंट. किराये के प्लान के लिए, बार-बार पैसे चुकाने की सुविधा चालू की जा सकती है. इसका मतलब है कि डेवलपर से हर महीने पैसे लिए जाएंगे. भले ही, प्लान का इस्तेमाल किया गया हो या नहीं.
नेटवर्क स्टेटमेंट यह एक वित्तीय दस्तावेज़ है, जिसमें इनवॉइस और रेवेन्यू के बंटवारे के स्टेटमेंट के बीच का कुल बैलेंस दिखता है.
अडजस्टमेंट खोलना ऐसा बदलाव जिसे पब्लिश किए गए बिलिंग दस्तावेज़ों में अब तक लागू नहीं किया गया है.
ओपन बिलिंग का महीना पूरा कैलेंडर महीना, जिसके लिए “फ़ाइनल” बिलिंग दस्तावेज़ पब्लिश नहीं किए गए हैं.
संगठन आपके Apigee खाते के सभी ऑब्जेक्ट के लिए कंटेनर. इनमें एपीआई, एपीआई प्रॉडक्ट, एपीआई पैकेज, ऐप्लिकेशन, और डेवलपर शामिल हैं. हर उस संगठन के लिए उपयोगकर्ता खाता होना ज़रूरी है जिसके आप सदस्य हैं. (ज़्यादातर उपयोगकर्ताओं के पास सिर्फ़ एक संगठन में खाता होगा.) आपको सबमिट किए गए हर एपीआई अनुरोध के साथ, अपने क्रेडेंशियल (उपयोगकर्ता नाम और पासवर्ड) और अपने संगठन का नाम देना होगा.
पैकेज कैटलॉग एपीआई पैकेज की सूची. हर पैकेज को उसके एपीआई प्रॉडक्ट और किराये के प्लान के साथ लिस्ट किया जाता है.
प्रीपेड बैलेंस प्रीपेड डेवलपर के पास, एपीआई पैकेज के लिए पहले से पैसे चुकाने के लिए उपलब्ध रकम.
प्रीपेड डेवलपर ऐसा डेवलपर जो एपीआई प्रॉडक्ट के इस्तेमाल के लिए पहले से पेमेंट करता है. एपीआई प्रॉडक्ट का इस्तेमाल करने पर, पैसे डेवलपर के रिचार्ज किए गए बैलेंस से काट लिए जाते हैं. डेवलपर के पास एपीआई प्रॉडक्ट खरीदने के लिए, प्रीपेड बैलेंस होना चाहिए. एपीआई की सेवा देने वाली कंपनी, डेवलपर को प्रीपेड या पोस्टपेड स्टेटस असाइन करती है.
नीति प्रोसेसिंग का एक चरण, जो एपीआई फ़्लो में लॉजिक की एक ऐसी यूनिट के तौर पर काम करता है जिसे बार-बार इस्तेमाल किया जा सकता है. आम तौर पर, अनुरोधों को सही एंडपॉइंट पर भेजने, मैसेज के फ़ॉर्मैट में बदलाव करने, ऐक्सेस कंट्रोल लागू करने, ज़्यादा जानकारी के लिए रिमोट सेवाओं को कॉल करने, बाहरी उपयोगकर्ताओं से संवेदनशील डेटा को मास्क करने, संभावित खतरों के लिए मैसेज के कॉन्टेंट की जांच करने, परफ़ॉर्मेंस को बेहतर बनाने के लिए सामान्य जवाबों को कैश मेमोरी में सेव करने वगैरह जैसी नीतियां लागू की जाती हैं. अनुरोध या जवाब वाले मैसेज के कॉन्टेंट या संदर्भ के आधार पर, नीतियों को शर्तों के साथ लागू किया जा सकता है. उदाहरण के लिए, अगर अनुरोध मैसेज स्मार्टफ़ोन से भेजा गया था, तो जवाब के फ़ॉर्मैट को पसंद के मुताबिक बनाने के लिए, ट्रांसफ़ॉर्मेशन नीति लागू की जा सकती है.
पोस्टपेड डेवलपर ऐसा डेवलपर जिसे एपीआई प्रॉडक्ट के इस्तेमाल के लिए, हर महीने इनवॉइस के ज़रिए बिल भेजा जाता है. डेवलपर, एपीआई प्रॉडक्ट के इस्तेमाल के लिए पैसे चुकाता है. यह पेमेंट, इनवॉइस में शामिल प्लान के हिसाब से तय की गई पेमेंट की शर्तों के आधार पर किया जाता है. एपीआई की सेवा देने वाली कंपनी, डेवलपर को पोस्टपेड या प्रीपेड का स्टेटस असाइन करती है.
प्रॉडक्ट की कीमतें प्रॉडक्ट की कीमत की वह रेंज जिस पर उसे मार्केटिंग किया जा सकता है.
रेट कार्ड का किराया प्लान शुल्क का ऐसा प्लान जिसमें कमाई करने वाले एपीआई प्रॉडक्ट से जुड़े हर लेन-देन के लिए, डेवलपर से तय या बदलाव होने वाला शुल्क लिया जाता है.
किराया प्लान कमाई करने वाले एपीआई पैकेज में दिए गए एपीआई प्रॉडक्ट के इस्तेमाल के लिए, शुल्क, अन्य शुल्क, और रेवेन्यू के बंटवारे की जानकारी.
संसाधन
पाथ
रिसॉर्स पाथ, यूनिफ़ॉर्म रिसॉर्स आइडेंटिफ़ायर (यूआरआई) का एक ऐसा कॉन्सेप्ट है जो किसी रिसॉर्स के नेटवर्क पाथ की पहचान करता है.
रेवेन्यू के बंटवारे की दर का प्लान किराया तय करने का ऐसा प्लान जिसमें कमाई करने वाले एपीआई प्रॉडक्ट से जुड़े हर लेन-देन से मिले रेवेन्यू का एक प्रतिशत, अनुरोध करने वाले ऐप्लिकेशन के डेवलपर के साथ शेयर किया जाता है.
रेवेन्यू का बंटवारा और किराया तय करने का प्लान किराया तय करने का ऐसा प्लान जिसमें कमाई करने वाले एपीआई प्रॉडक्ट से जुड़े हर लेन-देन से मिले रेवेन्यू का एक प्रतिशत, अनुरोध करने वाले ऐप्लिकेशन के डेवलपर के साथ शेयर किया जाता है. हर लेन-देन के लिए, डेवलपर से भी तय या अलग-अलग शुल्क लिया जाता है.
खुद का इनवॉइस रेवेन्यू के बंटवारे के स्टेटमेंट के बजाय जनरेट किया जाने वाला वित्तीय दस्तावेज़. इसमें, डेवलपर को मिलने वाली रकम की जानकारी होती है. साथ ही, यह डेवलपर की ओर से एपीआई उपलब्ध कराने वाली कंपनी के लिए इनवॉइस के तौर पर काम करता है.
स्टैंडर्ड रेट प्लान किराया तय करने वाला ऐसा प्लान जिसे सभी डेवलपर खरीद सकते हैं.
टैक्स डेवलपर के इस्तेमाल और शुल्क पर लागू होने वाला कुल टैक्स.
टॉप अप करना प्रीपेड बैलेंस में पैसे जोड़ने के लिए, प्रीपेड डेवलपर की ओर से की गई कार्रवाई.
लेन-देन की रिकॉर्डिंग से जुड़ी नीति एक ऐसा तरीका जो लेन-देन के पैरामीटर और कस्टम एट्रिब्यूट को कैप्चर करने के लिए, कमाई करने की सुविधा चालू करता है. कमाई करने की प्रोसेस को पूरा करने के लिए, Monetization को इस जानकारी की ज़रूरत होती है. जैसे, हर लेन-देन में कैप्चर किए गए कस्टम एट्रिब्यूट के आधार पर, एपीआई अनुरोधों और जवाबों पर किराया प्लान लागू करना.
ऐसा एजेंट जिसकी जानकारी नहीं दी गई है ऐसा संगठन (या ऑपरेटर) जो ऐप्लिकेशन की बुनियादी सप्लाई में हिस्सा लेता है, ताकि उसे डेवलपर की ओर से कॉन्टेंट खरीदने वाला माना जा सके (सिर्फ़ टैक्स के मकसद से). बिना जानकारी दिए काम करने वाले एजेंट के तौर पर, संगठन (या ऑपरेटर) असली उपयोगकर्ताओं से लिए जाने वाले टैक्स इकट्ठा कर सकता है और उनका हिसाब रख सकता है. यह स्टेटस सिर्फ़ टैक्स के लिए ज़रूरी है — इससे सप्लाई चेन में डेवलपर के कानूनी दर्जे पर कोई असर नहीं पड़ता.
टैक्स के लिए इस्तेमाल किए जाने वाले मॉडल की जानकारी न दी गई हो टैक्स का एक मॉडल, जिसमें एपीआई की सेवा देने वाली कंपनी, असली उपयोगकर्ताओं से लिए गए टैक्स को काटती है और उसे स्थानीय टैक्स अधिकारियों को चुकाती है.
वर्शन डेवलपर के लिए उपलब्ध एपीआई इंटरफ़ेस का वर्शन. उदाहरण के लिए, pivotaltracker.com/services/v3 या api.enterprise.apigee.com/v1. (इस शब्द को 'बदलाव' से अलग माना जाता है. बदलाव, एपीआई प्रॉक्सी में बंडल किए गए कॉन्फ़िगरेशन और नीतियों का वर्शन कंट्रोल वाला पैकेज होता है. कम शब्दों में, एपीआई इंटरफ़ेस के वर्शन होते हैं, जबकि एपीआई प्रोक्सी में बदलाव होते हैं.