शब्दावली

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

ऐसे कई कॉन्सेप्ट हैं जो एक सामान्य आइडिया होते हैं, जिनका खास मतलब Apigee में होता है.

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