The API Microgateway Service manages Application Integration processes that run on your organization's on-premises Secure Agent. Use the API Microgateway Service to expose managed APIs as API Microgateway proxies.
Preview Notice: Effective in the 2020 October release, API Microgateway Service is available for preview.
Preview functionality is supported for evaluation purposes but is unwarranted and is not production-ready. Informatica recommends that you use in non-production environments only. Informatica intends to include the preview functionality in an upcoming release for production use, but might choose not to in accordance with changing market or technical circumstances. For more information, contact Informatica Global Customer Support. To use the functionality, your organization must have the appropriate licenses.
The API Microgateway Service supports the following API Manager access policies:
•IP filtering policy
•Rate limit policy
•Basic authentication
The API Microgateway Service provides REST APIs to create and deploy API Microgateway proxies. API consumers access the managed APIs deployed as API Microgateway proxies on your organization's on-premises environment. The Application Integration processes expose REST Service URL and SOAP Service URL endpoints.
Use the API Microgateway Service to build an API Microgateway proxy to an API endpoint to manage. The API Microgateway Service builds an API Microgateway as an immutable Docker image on your organization's Secure Agent machine. You then use the API Microgateway Service to deploy the Docker image in a container on the Secure Agent Docker runtime environment for API access. The API Microgateway applies the API access policies that you configure before forwarding the requests to Application Integration endpoints.
The following diagram shows the API Microgateway Service and API Microgateway components exposing a managed API in the on-premises environment:
The Secure Agent Docker runtime environment hosts the Docker images using the blue-green deployment strategy to provide zero downtime during updates of the API Microgateway component.
Configuring API Microgateway Service
Configure the API Microgateway Service properties when you edit a Secure Agent in Administrator.
The following image shows the API Microgateway Service properties in the System Configuration Details area:
The following table describes the API Microgateway Service configurations:
Type
Name
Description
AGENT_RUNTIME_SETTINGS
project-name
Name of the project that stores the API configurations. You can change the name as per requirement, for example when you create a new project.
Note: Project name must not contain the characters /or /0. If a project name includes restricted characters, the project creation fails.
AGENT_RUNTIME_SETTINGS
docker-registry-name
Name of the local Docker registry that contains all the named and tagged API Microgateway Docker images on the Secure Agent machine.
Note: Docker image and tag names must not contain the following characters: -_,. If a Docker image or tag name includes restricted characters, the image build fails.
DOCKER_CONTAINER_SETTINGS
blue
First Docker image container that deploys on the Secure Agent machine, alternates with green.
You can change the following ports of the blue container:
- http-port. The default value is: 16090
- https-port. The default value is: 16095
DOCKER_CONTAINER_SETTINGS
green
Second Docker image container that deploys on the Secure Agent machine, alternates with blue.
You can change the following ports of the green container:
- http-port. The default value is: 17090
- https-port. The default value is: 17095
DOCKER_CONTAINER_SETTINGS
haproxy
Router of the Docker image containers on the Secure Agent machine. Switches traffic between blue and green containers.
You can change the following ports of the haproxy container:
- http-port. The default value is: 6090
- https-port. The default value is: 6095
Note: To stop the API Microgateway, stop all three Docker image containers.
