Introduction to the InterSystems API Manager (IAM)
This is not the current version of IAM. For information on using the other versions of IAM, see InterSystems API Manager.
InterSystems API Manager (IAM) is a component of InterSystems IRIS® data platform that allows you to take advantage of microservices and APIs that are either exposed or consumed by your InterSystems IRIS applications. Acting as an API gateway between your InterSystems IRIS servers and applications, it gives you the ability to more effectively monitor and control the traffic of calls between your server-side APIs and your client-side applications. IAM enables you to monitor, control, and govern HTTP-based API traffic.
The more distributed your environment the more critical it becomes to properly govern and monitor your API traffic. IAM enables you to easily route all your traffic through a centralized gateway and forward API requests to appropriate target nodes.
The InterSystems API Manager is powered by Kong Enterprise Version 0.34, an industry-leading API manager from Kong, Inc. The main source of information about IAM is provided by the Kong Enterprise 0.34 documentation. InterSystems provides information about installing IAM and some details of the IAM environment. The InterSystems Worldwide Response Center (WRC) provides support for IAM including the Kong Enterprise features.
Benefits of Using IAM
Using IAM allows you to do the following:
Monitor your HTTP-based API traffic and understand who is using your APIs; what are your most popular APIs and which could require a rework.
Control who is using your APIs and restrict usage in various ways. From simple access restrictions to throttling API traffic and fine-tuning request payloads, you have fine-grained control and can react quickly.
Protect your APIs with central security mechanisms like OAuth2.0 or Key Token Authentication.
Onboard third-party developers and provide them with a superb developer experience right from the start by providing a dedicated Developer Portal for their needs.
Scale your API demands and deliver low-latency responses.
Provide a uniform API for underlying services that have different APIs.
Features of IAM
IAM has the following features:
Kong Gateway — the open source foundation of Kong Enterprise. It is a lightweight, fast, and flexible cloud-native API gateway. It provides a central way to access REST APIs.
Administrative API — provides a REST API to administer and configure services, routes, plugins, and consumers.
Management Portal — allows you to administer and control the Kong Gateway. You can define security groups, policies and monitor performance.
Developer Portal — allows you to provide access to developers, generate API documentation for REST interfaces through their specifications, manage different versions of REST APIs, and secure developer access.
Plugins — provide advanced functionality such as authentication and rate limits. The InterSystems API Manager provides all of the Kong plugins provided by Kong Enterprise. You can purchase additional third-party plugins in the Kong marketplace, known as Kong Hub. InterSystems does not provide support for third-party plugins.
Vitals — provide metrics about the health and performance of IAM and of the usage of the underlying services.
IAM provided with InterSystems IRIS must be used only for APIs that are either provided by InterSystems IRIS or used by InterSystems IRIS. If you want to extend the use of IAM to cover APIs that are independent of InterSystems IRIS, contact InterSystems sales for more information.
The following features of Kong Enterprise are not included in the InterSystems API Manager: Kong Brain, Kong Immunity, and Kong Studio.
How to Learn About IAM
The main source of information about IAM is provided by the Kong Enterprise 0.34 documentation. The following topic provides installation instructions, The InterSystems documentation web site also provides a first look guide. The InterSystems online learning site has online classes, videos and documents that cover topics on IAM, such as building FHIR applications and best practices. On the online learning site, search for API Manager for these resources.