Basic terminology

ऐप्लिकेशन प्रोग्रामिंग इंटरफ़ेस—यह एक ऐसा इंटरफ़ेस है जिसकी मदद से, एक ऐप्लिकेशन को दूसरे ऐप्लिकेशन की सुविधाओं या डेटा को इस्तेमाल करना आसान हो जाता है.

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

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

Edge पर एक या उससे ज़्यादा एपीआई, सामान्य एचटीटीपी सेवाओं या ऐप्लिकेशन (जैसे कि Node.js) के लिए फ़ेसेड.

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

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

नेटवर्क पतों और यूआरआई से तय किए गए एपीआई. एपीआई, बेस पाथ और एपीआई संसाधनों के सेट से बना होता है. हर एपीआई प्रॉक्सी एक बुनियादी पाथ तय करता है. साथ ही, वैकल्पिक तौर पर, एक से ज़्यादा एपीआई संसाधन पाथ तय करता है. एपीआई को यूआरआई के सेट के तौर पर देखा जा सकता है. इन सभी यूआरआई का एक ही बेस पाथ होता है.

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

एपीआई संसाधनों (यूआरआई) का एक कलेक्शन, जो कोटा या सेवा प्लान के साथ मिलकर काम करता है. इसे डिज़ाइन के समय, ऐप्लिकेशन डेवलपर के लिए पब्लिश किया जाता है. एपीआई प्रॉडक्ट को कमाई करने के लिए, एपीआई पैकेज में बंडल किया जा सकता है.

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

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

ऐप्लिकेशन रजिस्टर होने पर, Apigee एक एपीआई कुंजी और पासवर्ड जनरेट करता है, जिससे ऐप्लिकेशन की पहचान की जाती है. डेवलपर, ऐप्लिकेशन में एपीआई कुंजी को एम्बेड करता है, जो अनुरोध करते समय कुंजी को दिखाता है. एपीआई सेवाएं, एपीआई पासकोड की पुष्टि करने के लिए, सीधे तौर पर एपीआई पासकोड की पुष्टि करने की सुविधा या OAuth का इस्तेमाल करती हैं.

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

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

Apigee Edge खाते के सभी ऑब्जेक्ट के लिए कंटेनर. इनमें एपीआई प्रॉक्सी, एपीआई प्रॉडक्ट, एपीआई पैकेज, ऐप्लिकेशन, और डेवलपर शामिल हैं.

आपको जिस संगठन का सदस्य बनना है उसके लिए उपयोगकर्ता खाता होना ज़रूरी है. (ज़्यादातर उपयोगकर्ताओं के पास सिर्फ़ एक संगठन में खाता होगा.)

प्रोसेसिंग का एक चरण, जो एपीआई प्रोक्सी प्रोसेसिंग फ़्लो में लॉजिक की एक ऐसी यूनिट के तौर पर काम करता है जिसे फिर से इस्तेमाल किया जा सकता है.

नीति के हिसाब से काम करने वाली सामान्य सुविधाओं में, मैसेज के फ़ॉर्मैट में बदलाव करना, ऐक्सेस कंट्रोल लागू करना, ज़्यादा जानकारी के लिए रिमोट सेवाओं को कॉल करना, बाहरी उपयोगकर्ताओं से संवेदनशील डेटा को मास्क करना, संभावित खतरों के लिए मैसेज के कॉन्टेंट की जांच करना, परफ़ॉर्मेंस को बेहतर बनाने के लिए सामान्य जवाबों को कैश मेमोरी में सेव करना वगैरह शामिल है.

अनुरोध या जवाब वाले मैसेज के कॉन्टेंट या संदर्भ के आधार पर, नीतियों को शर्तों के साथ लागू किया जा सकता है. उदाहरण के लिए, अगर अनुरोध मैसेज किसी स्मार्टफ़ोन से भेजा गया था, तो जवाब के फ़ॉर्मैट को पसंद के मुताबिक बनाने के लिए, ट्रांसफ़ॉर्मेशन नीति लागू की जा सकती है.

डेवलपर के लिए उपलब्ध एपीआई इंटरफ़ेस का वर्शन.

उदाहरण के लिए, pivotaltracker.com/services/v3 या api.enterprise.apigee.com/v1.

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