ჩვენ ახლახან გამოვაქვეყნეთ InterSystems API Manager (IAM), InterSystems IRIS მონაცემთა პლატფორმის ახალი კომპონენტი, რომელიც უზრუნველყოფს ვებ API ტრაფიკის ხილვადობას, კონტროლს და მართვას IT ინფრასტრუქტურაში.

ამ სტატიაში მე გაჩვენებთ, თუ როგორ უნდა დააყენოთ IAM და წარმოგიდგინოთ რამდენიმე შესაძლებლობა, რომელიც თქვენთვის ხელმისაწვდომია IAM-ით. InterSystems API მენეჯერი გაძლევთ საშუალებას:

• დააკვირდით API-ს, გაიგეთ ვინ იყენებს API-ს, რომელი API არის ყველაზე პოპულარული და რომელი საჭიროებს გაუმჯობესებას.
• აკონტროლეთ ვინ იყენებს API-ს და შეზღუდეთ API-ს გამოყენება მარტივი წვდომის შეზღუდვებიდან მოთხოვნაზე დაფუძნებულ შეზღუდვებამდე - თქვენ გაქვთ მორგებული კონტროლი და შეგიძლიათ სწრაფად უპასუხოთ API მოხმარების შაბლონების შეცვლას.
• უსაფრთხო API-ები ცენტრალიზებული უსაფრთხოების მექანიზმების გამოყენებით, როგორიცაა OAuth2.0, LDAP ან Key Token Authentication.
• გაუადვილეთ მესამე მხარის დეველოპერებს და მიეცით მათ უმაღლესი API გამოცდილება დეველოპერის სპეციალური პორტალის გახსნით.
• გააფართოვეთ API და უზრუნველყოთ რეაგირების მინიმალური შეყოვნება.

API მენეჯმენტი აუცილებელია SOA-ზე ან მიკროსერვისის არქიტექტურაზე გადასასვლელად, ინდივიდუალური (მიკრო)სერვისებს შორის ინტეგრაციის გამარტივებისთვის, რაც მათ ხელმისაწვდომი გახდება ყველა გარე და შიდა მომხმარებლისთვის. შედეგად, ახალი API-ების შექმნა, შენარჩუნება და მოხმარება უფრო ადვილი ხდება.

თუ უკვე იყენებთ InterSystems IRIS-ს, შეგიძლიათ დაამატოთ IAM ოფცია თქვენს ლიცენზიას. IAM ვარიანტი უფასოა InterSystems IRIS მომხმარებლებისთვის, მაგრამ თქვენ უნდა მოითხოვოთ ახალი ლიცენზიის გასაღები InterSystems-ისგან IAM-ის გამოყენების დასაწყებად.

თუ ჯერ არ იყენებთ InterSystems IRIS-ს და გეგმავთ სცადოთ InterSystems API Manager, გთხოვთ, დაუკავშირდეთ InterSystems-ს.

დაწყება და ინსტალაცია

InterSystems-ის მომხმარებლებს შეუძლიათ ჩამოტვირთოთ IAM დისტრიბუცია ვებსაიტიდან WRC განყოფილება „პროგრამული უზრუნველყოფის დისტრიბუცია“ და მუშაობს Docker კონტეინერის სახით. მინიმალური სისტემური მოთხოვნები:

• docker 17.04.0 +.
• Docker შედგენა 1.12.0 +.
• InterSystems IRIS 2019.1.1+.

თავდაპირველად, თქვენ უნდა ჩამოტვირთოთ Docker სურათი (მნიშვნელოვანია! WRC-ის არქივი არ არის Docker გამოსახულება, თქვენ უნდა გახსნათ იგი, შიგნით არის Docker სურათი):

docker load -i iam_image.tar

ეს ბრძანება გახდის IAM სურათს თქვენს სერვერზე შემდგომი გამოყენებისთვის. IAM მუშაობს როგორც ცალკე კონტეინერი, ასე რომ თქვენ შეგიძლიათ მისი მასშტაბირება InterSystems IRIS-ისგან დამოუკიდებლად. IAM-ის გაშვება მოითხოვს წვდომას InterSystems IRIS-ზე ლიცენზიის ჩამოსატვირთად.

დააყენეთ InterSystems IRIS:

• ჩართეთ ვებ აპლიკაცია /api/IAM
• მომხმარებლის ჩართვა IAM
• მომხმარებლის პაროლის შეცვლა IAM

ახლა დავიწყოთ IAM კონტეინერი. არქივში ნახავთ სკრიპტებს iam-setup Windows-ისთვის და Unix-ისთვის (და Mac-ისთვის). ეს სკრიპტები დაგეხმარებათ გარემოს ცვლადების სწორად დაყენებაში, რაც საშუალებას მისცემს IAM კონტეინერს დაამყაროს კავშირი InterSystems IRIS-თან. აქ მოცემულია Mac-ზე გაშვებული სკრიპტის მაგალითი:

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

როგორც ხედავთ, სურათის სრული სახელი, IP მისამართი, InterSystems IRIS პორტი და პაროლი 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 მხარს უჭერს სამუშაო სივრცის კონცეფციას API-ების მოდულებად და/ან ბრძანებებად დაყოფისთვის. გადადით "ნაგულისხმევ" სამუშაო სივრცეში, რომელსაც გამოვიყენებთ ჩვენი ექსპერიმენტებისთვის.

ამ სამუშაო სივრცის მოთხოვნების რაოდენობა ჯერ კიდევ ნულის ტოლია, მაგრამ თქვენ მიიღებთ იდეას IAM-ის ძირითადი კონცეფციების შესახებ მარცხენა მენიუში. პირველი ორი ელემენტი: სერვისები და მარშრუტები ყველაზე მნიშვნელოვანია:

• სერვისი არის API, რომელზეც ჩვენ გვინდა მივცეთ წვდომა მომხმარებლებს. ამრიგად, REST API InterSystems IRIS-ში არის სერვისი, ისევე როგორც, მაგალითად, Google API, თუ გსურთ მისი გამოყენება.
• მარშრუტი წყვეტს, რომელ სერვისზე უნდა გადაეგზავნოს შემომავალი მოთხოვნები. თითოეულ მარშრუტს აქვს პირობების კონკრეტული ნაკრები და მათი დაკმაყოფილების შემთხვევაში მოთხოვნა იგზავნება შესაბამის სამსახურში. მაგალითად, მარშრუტს შეუძლია შეესაბამებოდეს IP-ს, გამგზავნის დომენს, HTTP მეთოდებს, URI-ის ნაწილებს ან ამ მაგალითების კომბინაციას.

სამსახურის

მოდით შევქმნათ InterSystems IRIS სერვისი, შემდეგი მნიშვნელობებით:

საველე
ღირებულება
აღწერა

სახელი
iris
სერვისის დასახელება

მასპინძელი
IP
InterSystems IRIS სერვერის ჰოსტი ან IP

პორტი
52773
InterSystems IRIS სერვერის ვებ პორტი

გზა
/api/ატელიე
ძირეული გზა

ოქმი
http
ოქმი

დატოვეთ დარჩენილი მნიშვნელობები ნაგულისხმევად. დააჭირეთ ღილაკს Create და ჩაწერეთ შექმნილი სერვისის ID.

მარშრუტი

ახლა შევქმნათ მარშრუტი:

საველე
ღირებულება
აღწერა

გზა
/api/ატელიე
ძირეული გზა

ოქმი
http
ოქმი

სერვისი.id
სახელმძღვანელო 3-დან
სერვისი (ID წინა ნაბიჯიდან)

დატოვეთ დარჩენილი მნიშვნელობები ნაგულისხმევად. დააჭირეთ ღილაკს Create და ჩაწერეთ შექმნილი მარშრუტის ID. ნაგულისხმევად, IAM უსმენს შემომავალ მოთხოვნებს პორტში 8000. ახლა მოთხოვნები იგზავნება http://localhost:8000 და დაწყებული /api/atelier გადამისამართებულია InterSystems IRIS-ზე.

ტესტირება

მოდით ვცადოთ მოთხოვნის შექმნა REST კლიენტში (მე ვიყენებ ფოსტალიონი).

მოდით გავაგზავნოთ GET მოთხოვნა http://localhost:8000/api/atelier/ (არ დაგავიწყდეს / ბოლოს) და მიიღეთ პასუხი InterSystems IRIS-ისგან. თითოეული მოთხოვნა გადის IAM-ის მეშვეობით, რომელიც აგროვებს მეტრიკას:

• HTTP სტატუსის კოდი.
• შეფერხება.
• მონიტორინგი (თუ კონფიგურირებულია).

მე გავაკეთე კიდევ რამდენიმე მოთხოვნა (მათ შორის ორი მოთხოვნა არარსებულ საბოლოო წერტილებზე, როგორიცაა /api/atelier/est/), შედეგები დაუყოვნებლივ ჩანს დაფაზე:

მოდულებით მუშაობა

ახლა, როდესაც ჩვენ გვაქვს მარშრუტის კონფიგურაცია, ჩვენ შეგვიძლია ვმართოთ ჩვენი API. ჩვენ შეგვიძლია დავამატოთ ფუნქციები, რომლებიც შეავსებს ჩვენს სერვისს.

API-ის ქცევის შესაცვლელად ყველაზე გავრცელებული გზა არის მოდულის დამატება. დანამატები იზოლირებენ ინდივიდუალურ ფუნქციონირებას და შეიძლება დაკავშირებული იყოს IAM-თან გლობალურად ან მხოლოდ ცალკეულ ერთეულებთან, როგორიცაა მომხმარებელი (მომხმარებელთა ჯგუფი), სერვისი ან მარშრუტი. ჩვენ დავიწყებთ მარშრუტზე Rate Limiting მოდულის დამატებით. დანამატსა და მარშრუტს შორის კავშირის დასამყარებლად, ჩვენ გვჭირდება მარშრუტის უნიკალური იდენტიფიკატორი (ID).

მოთხოვნის რაოდენობის შეზღუდვა

დააწკაპუნეთ Plugins მარცხენა გვერდითა მენიუში. თქვენ შეგიძლიათ ნახოთ ყველა აქტიური დანამატი ამ ეკრანზე, მაგრამ რადგან ეს IAM სერვერი ახალია, ჯერ არ არის აქტიური დანამატები. ასე რომ, გადადით შემდეგ ეტაპზე "ახალი მოდულის" დაწკაპუნებით.

ჩვენ გვჭირდება მოდული არის „ტრაფიკის კონტროლის“ კატეგორიაში და ჰქვია „Rate Limiting“. აირჩიეთ ის. არსებობს საკმაოდ ბევრი პარამეტრი, რომლის დაყენება შეგიძლიათ აქ, მაგრამ ჩვენ ვზრუნავთ მხოლოდ ორ ველზე:

საველე
ღირებულება
აღწერა

მარშრუტი_იდი
ID
მარშრუტის ID

config.minute
5
მოთხოვნის რაოდენობა წუთში

Სულ ეს არის. მოდული კონფიგურირებული და აქტიურია. გაითვალისწინეთ, რომ ჩვენ შეგვიძლია ავირჩიოთ სხვადასხვა დროის ინტერვალი, როგორიცაა წუთი, საათი ან დღე. პარამეტრები შეიძლება გაერთიანდეს (მაგალითად, 1000 მოთხოვნა საათში და ამავე დროს 100 მოთხოვნა წუთში). მე ავირჩიე წუთები, რადგან ეს აადვილებს მოდულის ფუნქციონალურობის შემოწმებას.

თუ თქვენ კვლავ გაგზავნით იმავე მოთხოვნას Postman-ში, ნახავთ, რომ პასუხი დაბრუნდება 2 დამატებითი სათაურით:

• XRateLimit-Limit-წუთი: 5
• XRateLimit-დარჩენილი წუთი: 4

ეს ეუბნება კლიენტს, რომ მას შეუძლია წუთში 5 მოთხოვნის გაკეთება და შეუძლია კიდევ 4 მოთხოვნის გაკეთება მიმდინარე დროის სლოტში.

თუ ერთსა და იმავე მოთხოვნას განმეორებით გააკეთებთ, საბოლოოდ ამოგეწურებათ ხელმისაწვდომი კვოტა და სანაცვლოდ მიიღებთ HTTP სტატუსის კოდს 429 შემდეგი პასუხის ორგანოსთან ერთად:

დაელოდეთ ერთ წუთს და კვლავ შეძლებთ თხოვნების გაგზავნას.

ეს არის მოსახერხებელი მექანიზმი, რომელიც საშუალებას გაძლევთ:

• დაიცავით უკანა ნაწილი დატვირთვისგან.
• უთხარით კლიენტებს რამდენი მოთხოვნის გაკეთება შეუძლიათ.
• მონეტიზაცია API.

თქვენ შეგიძლიათ დააყენოთ მნიშვნელობები სხვადასხვა დროის ინტერვალებისთვის და ამით გაამარტივოთ API ტრაფიკი გარკვეული პერიოდის განმავლობაში. ვთქვათ, თქვენ დაუშვით 600 მოთხოვნა საათში კონკრეტულ მარშრუტზე. წუთში საშუალოდ 10 მოთხოვნაა. მაგრამ არაფერი უშლის კლიენტს 600-ვე მოთხოვნის შესრულებაში საათის პირველ წუთში. იქნებ ეს არის ის, რაც გჭირდებათ. შეიძლება დაგჭირდეთ უფრო თანაბარ დატვირთვის მიღწევა ერთი საათის განმავლობაში. ველის მნიშვნელობის დაყენებით config.minute 20-ის მნიშვნელობა უზრუნველყოფს, რომ თქვენი მომხმარებლები წუთში არაუმეტეს 20 მოთხოვნას და საათში 600 მოთხოვნას აკეთებენ. ეს იძლევა მცირე მწვერვალებს ერთწუთიან ინტერვალზე, წუთში 10 მოთხოვნის სრულად საშუალო ნაკადთან შედარებით, მაგრამ მომხმარებლებს არ შეუძლიათ საათობრივი კვოტის გამოყენება ერთი წუთის განმავლობაში. ახლა მათ დასჭირდებათ მინიმუმ 30 წუთი, რომ გამოიყენონ ყველა მოთხოვნა. კლიენტები მიიღებენ დამატებით სათაურებს თითოეული მითითებული დროის ინტერვალისთვის, მაგალითად:

HTTP ჰედერი
ღირებულება

X-RateLimit-Limit-საათი
600

X-RateLimit-დარჩენილი საათი
595

X-RateLimit-Limit-წუთი
20

X-RateLimit-დარჩენილი წუთი
16

რა თქმა უნდა, არსებობს მრავალი განსხვავებული გზა შეკითხვის ლიმიტების კონფიგურაციისთვის, იმისდა მიხედვით, თუ რისი მიღწევა გსურთ.

დასკვნები

აქ დავასრულებ, ვფიქრობ, საკმარისი მასალაა პირველი სტატიისთვის InterSystems API მენეჯერის შესახებ. ჩვენ მხოლოდ ერთი გამოვიყენეთ 40-ზე მეტი დანამატიდან. კიდევ ბევრი საინტერესო რამ შეგიძლიათ გააკეთოთ IAM-ით:

• დაამატეთ ცენტრალური ავთენტიფიკაციის მექანიზმი თქვენი ყველა API-სთვის.
• გააფართოვეთ დატვირთვა დატვირთვის ბალანსერის გამოყენებით მრავალ სერვისში.
• დაამატეთ ახალი ფუნქციონირება და შეცდომების გამოსწორება საცდელ აუდიტორიას სრულ განახლებამდე.
• მიაწოდეთ შიდა და გარე დეველოპერებს გამოყოფილი ვებ პორტალი, სადაც დოკუმენტირებულია ყველა API.
• ქეში ითხოვს რეაგირების დროის შემცირებას და სისტემის ფონზე დატვირთვის შემცირებას.

ლიტერატურა

• პრესრელიზი
• შესავალი ვიდეო
• უფრო დეტალური ვიდეო
• დოკუმენტაცია
• Load Balancer Setup

Webinar

გეპატიჟებით ვებინარზე „API Management with InterSystems API Management“, რომელიც გაიმართება 21 ნოემბერს მოსკოვის დროით 10:00 საათზე (GMT+3).
InterSystems API Manager (IAM) არის InterSystems IRIS მონაცემთა პლატფორმის ახალი კომპონენტი, რომელიც უზრუნველყოფს ტრაფიკის მონიტორინგს, კონტროლს და მართვას ვებ API-ებიდან IT ინფრასტრუქტურის ფარგლებში. ვებინარზე ჩვენ წარმოვადგენთ InterSystems API მენეჯმენტის ძირითად შესაძლებლობებს:

• API ტრაფიკის მონიტორინგის ინსტრუმენტები.
• API ტრაფიკის კონტროლი, მათ შორის გამტარუნარიანობის კონტროლი, API ზარების რაოდენობის შეზღუდვა, IP მისამართების ნებადართული და აკრძალული სიების შენარჩუნება და ა.შ.
• API უსაფრთხოების კონფიგურაციის ინსტრუმენტები.
• დეველოპერის პორტალი ინტერაქტიული API დოკუმენტაციის გამოქვეყნებისთვის.
• API-ზე წვდომის ერთი წერტილი.

ვებინარი განკუთვნილია არქიტექტორებისთვის, დეველოპერებისთვის და სისტემის ადმინისტრატორებისთვის.

რეგისტრაცია აუცილებელია!

წყარო: www.habr.com