Basic terminology

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

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

Apigee, एपीआई के बारे में कई तरह की जानकारी देता है. साथ ही, उन्हें डेवलप करने और इस्तेमाल करने के सबसे सही तरीके बताता है. शुरू करने के लिए, एपीआई डिज़ाइन वेबकास्ट देखें या मुफ़्त ई-बुक डाउनलोड करें Web API Design: The Missing Link Best Practices for Crafting Interfaces that Developers Love.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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