हमने हाल ही में InterSystems API Manager (IAM), InterSystems IRIS डेटा प्लेटफ़ॉर्म का एक नया घटक जारी किया है जो IT बुनियादी ढांचे के भीतर वेब API से / की निगरानी, ​​नियंत्रण और यातायात नियंत्रण प्रदान करता है।

इस लेख में, मैं आपको IAM को कॉन्फ़िगर करने का तरीका दिखाऊंगा और कुछ विशेषताओं को प्रदर्शित करूंगा जो IAM के साथ आपके लिए उपलब्ध हैं। InterSystems API प्रबंधक आपको इसकी अनुमति देता है:

• एपीआई देखें, समझें कि एपीआई का उपयोग कौन कर रहा है, कौन से एपीआई सबसे लोकप्रिय हैं, और किन लोगों को सुधार की आवश्यकता है।
• नियंत्रण जो एपीआई का उपयोग करता है और अनुरोध के आधार पर सरल उपयोग प्रतिबंधों से एपीआई के उपयोग को प्रतिबंधित करता है - आपके पास अनुकूलन योग्य नियंत्रण हैं और आप एपीआई खपत पैटर्न में बदलावों का तुरंत जवाब दे सकते हैं।
• OAuth2.0, LDAP, या कुंजी टोकन प्रमाणीकरण जैसे केंद्रीकृत सुरक्षा तंत्र के साथ API को सुरक्षित रखें।
• तीसरे पक्ष के डेवलपर्स के काम को सरल बनाएं और उन्हें डेवलपर्स के लिए एक विशेष पोर्टल खोलकर एपीआई के साथ उत्कृष्ट अनुभव प्रदान करें।
• एपीआई को स्केल करें और प्रतिक्रिया में न्यूनतम देरी सुनिश्चित करें।

SOA या microservice आर्किटेक्चर में संक्रमण के लिए API का प्रबंधन आवश्यक है, जो व्यक्तिगत (माइक्रो) सेवाओं के बीच एकीकरण को आसान बनाता है, जिससे उन्हें सभी बाहरी और आंतरिक उपभोक्ताओं के लिए सुलभ बनाया जा सकता है। परिणामस्वरूप, नए एपीआई बनाने, बनाए रखने और उपभोग करने में आसान हो रहे हैं।

यदि आप पहले से ही InterSystems IRIS का उपयोग कर रहे हैं, तो आप अपने लाइसेंस में IAM विकल्प जोड़ सकते हैं। आईएएमएस विकल्प इंटरसिस्टम आईआरआईएस ग्राहकों के लिए मुफ्त है, लेकिन आईएएम का उपयोग शुरू करने के लिए, आपको इंटरसिस्टम्स से एक नई लाइसेंस कुंजी का अनुरोध करने की आवश्यकता है।

यदि आप पहले से ही InterSystems IRIS का उपयोग नहीं कर रहे हैं और केवल InterSystems API प्रबंधक को आज़माने के लिए योजना बना रहे हैं, तो InterSystems से संपर्क करें।

शुरुआत और स्थापना

InterSystems IAM ग्राहक WRC साइट से "सॉफ़्टवेयर वितरण" अनुभाग डाउनलोड कर सकते हैं और इसे डॉक कंटेनर के रूप में चला सकते हैं। न्यूनतम सिस्टम आवश्यकताएँ:

• डॉकटर 04.17.0+।
• डॉकर कम्पोज़ 1.12.0+।
• इंटरसिस्टम IRIS 2019.1.1+।

प्रारंभ में, आपको डॉकर छवि डाउनलोड करने की आवश्यकता है (महत्वपूर्ण! डब्ल्यूआरसी के साथ संग्रह एक डॉकटर छवि नहीं है, आपको इसे डॉकयर छवि के अंदर अनपैक करने की आवश्यकता है):

docker load -i iam_image.tar 

यह कमांड आपके सर्वर पर बाद में उपयोग के लिए IAM छवि उपलब्ध कराएगा। IAM एक अलग कंटेनर के रूप में काम करता है, इसलिए आप इसे InterSystems IRIS से स्वतंत्र रूप से स्केल कर सकते हैं। IAM चलाने के लिए, आपको लाइसेंस डाउनलोड करने के लिए InterSystems IRIS तक पहुंच की आवश्यकता है।

इंटरसिस्टम IRIS कॉन्फ़िगर करें:

• वेब ऐप /api/IAM चालू करें
• सक्षम IAM उपयोगकर्ता
• IAM यूजर पासवर्ड बदलें

अब IAM कंटेनर चलाएं। संग्रह में आपको विंडोज और यूनिक्स (और मैक) के लिए iam-setup स्क्रिप्ट मिलेगी। ये स्क्रिप्ट आपको पर्यावरण चर को सही ढंग से सेट करने में मदद करेंगे, जिससे IAM कंटेनर को इंटरसिस्टम IRIS से कनेक्ट करने की अनुमति मिलेगी। यहाँ मैक पर एक स्क्रिप्ट का एक उदाहरण है:

 source ./iam-setup.sh Welcome to the InterSystems IRIS and InterSystems API Manager (IAM) setup script. This script sets the ISC_IRIS_URL environment variable that is used by the IAM container to get the IAM license key from InterSystems IRIS. Enter the full image repository, name and tag for your IAM docker image: intersystems/iam:0.34-1-1 Enter the IP address for your InterSystems IRIS instance. The IP address has to be accessible from within the IAM container, therefore, do not use "localhost" or "127.0.0.1" if IRIS is running on your local machine. Instead use the public IP address of your local machine. If IRIS is running in a container, use the public IP address of the host environment, not the IP address of the IRIS container. xxx.xxx.xxx.xxx Enter the web server port for your InterSystems IRIS instance: 52773 Enter the password for the IAM user for your InterSystems IRIS instance: Re-enter your password: Your inputs are: Full image repository, name and tag for your IAM docker image: intersystems/iam:0.34-1-1 IP address for your InterSystems IRIS instance: xxx.xxx.xxx.xxx Web server port for your InterSystems IRIS instance: 52773 Would you like to continue with these inputs (y/n)? y Getting IAM license using your inputs... Successfully got IAM license! The ISC_IRIS_URL environment variable was set to: http://IAM:****************@xxx.xxx.xxx.xxx:52773/api/iam/license WARNING: The environment variable is set for this shell only! To start the services, run the following command in the top level directory: docker-compose up -d To stop the services, run the following command in the top level directory: docker-compose down URL for the IAM Manager portal: http://localhost:8002 

जैसा कि आप देख सकते हैं, IAM उपयोगकर्ता के लिए पूर्ण छवि का नाम, आईपी पता, इंटरसिस्टम आईआरआईएस पोर्ट और पासवर्ड सभी आपको शुरू करने की आवश्यकता है।

स्क्रिप्ट चलाने के बजाय, आप पर्यावरण चर को मैन्युअल रूप से सेट कर सकते हैं:

 ISC_IAM_IMAGE=intersystems/iam:0.34-1-1 ISC_IRIS_URL=http://IAM:<PASS>@<IP>:<PORT>/api/iam/license 

लांच

अब कमांड चलाकर IAM चलाएं:

 docker-compose up -d 

यह कमांड IAM कंटेनरों को व्यवस्थित करता है और यह सुनिश्चित करता है कि सब कुछ सही ढंग से शुरू हो। कंटेनरों की स्थिति कमांड का उपयोग करके जाँच की जाती है:

 docker ps 

किसी ब्राउज़र में localhost:8002 एडमिन इंटरफेस खोलें।

अब तक, यह खाली है क्योंकि यह एक पूरी तरह से नई साइट है। चलो इसे बदलते हैं। आईएएम एपीआई को मॉड्यूल और / या टीमों में विभाजित करने के लिए कार्यक्षेत्र की अवधारणा का समर्थन करता है। कार्यक्षेत्र "डिफ़ॉल्ट" पर जाएं जो हम अपने प्रयोगों के लिए उपयोग करेंगे।

इस कार्यक्षेत्र के लिए अनुरोधों की संख्या अभी भी शून्य है, लेकिन आपको बाईं ओर मेनू में IAM की बुनियादी अवधारणाओं का एक विचार मिलेगा। पहले दो तत्व: सेवाएं और रूट सबसे महत्वपूर्ण हैं:

• सेवा - एपीआई, जिसे हम उपभोक्ताओं तक पहुंच प्रदान करना चाहते हैं। इस प्रकार, InterSystems IRIS में REST API एक सेवा है, उदाहरण के लिए, Google API, यदि आप इसका उपयोग करना चाहते हैं।
• रूट तय करता है कि आने वाले अनुरोधों को किस सेवा में पुनर्निर्देशित किया जाना चाहिए। प्रत्येक रूट में शर्तों का एक विशिष्ट सेट होता है, और यदि वे मिलते हैं, तो अनुरोध संबंधित सेवा को भेजा जाता है। उदाहरण के लिए, एक रूट एक आईपी, एक प्रेषक के डोमेन, HTTP विधियों, एक URI के कुछ हिस्सों या इन उदाहरणों के संयोजन से मेल खा सकता है।

सेवा

आइए निम्नलिखित मूल्यों के साथ InterSystems IRIS सेवा बनाएं:

शेष मूल्यों को डिफ़ॉल्ट रूप से छोड़ दें। Create बटन पर क्लिक करें और बनाई गई सेवा की आईडी को लिखें।

मार्ग

अब एक मार्ग बनाते हैं:

शेष मूल्यों को डिफ़ॉल्ट रूप से छोड़ दें। Create बटन पर क्लिक करें और निर्मित रूट की आईडी को लिखें। डिफ़ॉल्ट रूप से, IAM पोर्ट 8000 पर आने वाले अनुरोधों को सुनता है। अब http://localhost:8000 भेजे गए अनुरोधों और /api/atelier शुरू होने वाले इंटरसिस्टम IRIS पर पुनर्निर्देशित /api/atelier ।

परीक्षण

आइए एक REST क्लाइंट में अनुरोध बनाने का प्रयास करें (मैं पोस्टमैन का उपयोग करता हूं)।

हम http://localhost:8000/api/atelier/ (मत भूलना / अंत में) के लिए एक GET अनुरोध भेजेंगे और InterSystems IRIS से प्रतिक्रिया प्राप्त करेंगे। प्रत्येक अनुरोध IAM के माध्यम से जाता है जो मैट्रिक्स एकत्र करता है:

• HTTP स्थिति कोड।
• विलंब।
• निगरानी (यदि कॉन्फ़िगर किया गया है)।

मैंने कई और अनुरोध किए (गैर-मौजूद एंडपॉइंट के लिए दो अनुरोधों सहित, जैसे / एपीआई / एटलियर / एस्ट /), परिणाम तुरंत डैशबोर्ड पर दिखाई देते हैं:

प्लगइन्स के साथ काम करें

अब हमारे पास रूट कॉन्फ़िगर हो गया है, हम अपने एपीआई को नियंत्रित कर सकते हैं। हम उन सुविधाओं को जोड़ सकते हैं जो हमारी सेवा के पूरक हैं।

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

अनुरोध सीमा

बाईं साइडबार पर मेनू में प्लगइन्स पर क्लिक करें। आप इस स्क्रीन पर सभी सक्रिय प्लगइन्स देखते हैं, लेकिन चूंकि यह IAM सर्वर नया है, इसलिए अभी तक कोई सक्रिय प्लगइन्स नहीं हैं। तो "नया प्लगइन" पर क्लिक करके अगले चरण पर जाएं।

हमें जिस प्लगइन की आवश्यकता है वह "ट्रैफिक कंट्रोल" श्रेणी में स्थित है और इसे "रेट लिमिटिंग" कहा जाता है। इसे चुनें। ऐसी कुछ सेटिंग्स हैं जिन्हें आप यहाँ सेट कर सकते हैं, लेकिन हम केवल दो क्षेत्रों से चिंतित हैं:

वह सब है। प्लगइन कॉन्फ़िगर और सक्रिय है। मैं ध्यान देता हूं कि हम अलग-अलग समय अंतराल चुन सकते हैं, जैसे कि मिनट, घंटा या दिन। सेटिंग्स को संयोजित किया जा सकता है (उदाहरण के लिए, प्रति घंटे 1000 अनुरोध और उसी समय प्रति मिनट 100 अनुरोध)। मैंने मिनटों को चुना, क्योंकि यह प्लगइन की जांच करना आसान बनाता है।

यदि आप पोस्टमैन को फिर से वही अनुरोध भेजते हैं, तो आप देखेंगे कि प्रतिक्रिया 2 अतिरिक्त हेडर के साथ वापस आ गई है:

• XRateLimit- सीमा-मिनट: 5
• XRateLimit- शेष-मिनट: 4

यह क्लाइंट को बताता है कि वह प्रति मिनट 5 अनुरोध कर सकता है और वर्तमान समय अंतराल में वह 4 और अनुरोध कर सकता है।

यदि आप बार-बार एक ही अनुरोध करते हैं, तो अंत में आप उपलब्ध कोटा से बाहर हो जाएंगे और इसके बजाय आपको निम्नलिखित प्रतिक्रिया निकाय के साथ एक HTTP स्थिति कोड 429 प्राप्त होगा:

एक मिनट रुको और आप फिर से अनुरोध भेजने में सक्षम होंगे।

यह एक सुविधाजनक तंत्र है जो आपको इसकी अनुमति देता है:

• बैकएंड को लोड सर्जेस से बचाएं।
• ग्राहकों को बताएं कि वे कितने अनुरोध कर सकते हैं।
• मुद्रीकृत एपीआई।

आप अलग-अलग समय अंतराल के लिए मान सेट कर सकते हैं और इस प्रकार एक निश्चित अवधि के लिए एपीआई यातायात को सुचारू कर सकते हैं। मान लीजिए कि आप किसी विशिष्ट रूट पर प्रति घंटे 600 अनुरोधों की अनुमति देते हैं। प्रति मिनट औसतन 10 अनुरोध हैं। लेकिन कुछ भी ग्राहक को घंटे के पहले मिनट में सभी 600 अनुरोधों को पूरा करने से रोकता है। शायद यह वही है जो आपको चाहिए। आप एक घंटे के भीतर और भी अधिक लोड प्राप्त करना चाह सकते हैं। config.minute फ़ील्ड का मान 20 पर सेट करके, आप गारंटी देते हैं कि आपके उपयोगकर्ता प्रति मिनट 20 से अधिक अनुरोध और प्रति घंटे 600 अनुरोध करते हैं। यह प्रति मिनट 10 अनुरोधों की पूरी तरह से औसतन स्ट्रीम की तुलना में मिनट के अंतराल में छोटे कूदता है, लेकिन उपयोगकर्ता एक मिनट के लिए प्रति घंटा कोटा का उपयोग नहीं कर सकते हैं। अब उन्हें अपने सभी प्रश्नों का उपयोग करने के लिए कम से कम 30 मिनट की आवश्यकता होगी। ग्राहकों को प्रत्येक दिए गए समय अंतराल के लिए अतिरिक्त हेडर प्राप्त होंगे, उदाहरण के लिए:

बेशक, आप जो हासिल करना चाहते हैं, उसके आधार पर क्वेरी सीमा को अनुकूलित करने के कई अलग-अलग तरीके हैं।

निष्कर्ष

मैं इसे समाप्त कर दूंगा, मुझे लगता है कि InterSystems API प्रबंधक के बारे में पहले लेख के लिए सामग्री काफी पर्याप्त है। हमने 40 से अधिक प्लगइन्स में से केवल एक का उपयोग किया। आप IAM के साथ कई और दिलचस्प चीजें कर सकते हैं:

• अपने सभी एपीआई के लिए एक केंद्रीय प्रमाणीकरण तंत्र जोड़ें।
• कई सेवाओं के लिए बैलेंसर का उपयोग करके लोड को स्केल करें।
• एक पूर्ण उन्नयन से पहले परीक्षण दर्शकों के लिए नई कार्यक्षमता और बग फिक्स जोड़ें।
• सभी एपीआई का दस्तावेजीकरण समर्पित वेब पोर्टल के साथ आंतरिक और बाहरी डेवलपर्स प्रदान करें।
• प्रतिक्रिया विलंबता को कम करने और सिस्टम बैकएंड लोड को कम करने के लिए कैश अनुरोध करता है।

संदर्भ

• प्रेस विज्ञप्ति
• परिचय वीडियो
• अधिक विस्तृत वीडियो
• प्रलेखन
• एक लोड बैलेंसर को कॉन्फ़िगर करना
• एपीआई प्रबंधन पर एक वेबिनार रिकॉर्डिंग