Basic terminology

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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