API Manager Guide

Back Next

Creating a managed API to expose with the API Microgateway Service

Create a managed API to expose with the API Microgateway Service to use as an API Microgateway proxy to an API endpoint to manage.

Access the Application Integration service and then click

Create a Process

The

Process

window opens.

In the

Process Properties

panel, click

Start

. Enter the required properties and then click

Save

Click

Publish

to publish the process on the Secure Agent.

Click

Properties Detail

. In the Endpoints area, click

Copy

to copy the Service URL or the SOAP Service URL and then click

Open the following URL template:

https://{<host>}:{<port number>}/api/v1/agent/apimgw/apispec

Where:

<host>

is the machine that hosts the Secure Agent that runs the API Microgateway Service.

is the number of the port that the API Microgateway Service is assigned during startup. You can find the port number in the following file:

<Secure Agent installation directory>/apps/ApiMicrogatewayService/logs folder/apimgw.log

Paste the URL you copied to the path element of the URL template.

API manager assigns the managed API name as the value of the id element.

Optionally, define endpoint access policies for the managed API. You can define a rate limit policy, an authentication type, and an IP filtering policy for the managed API.

Define the rate limit policy. Enter one of the following values for timeUnit:

min

hour

day

week

month

year

Define the authentication type. If you use OAuth 2.0 authentication, enter the access token that you generate in

Application Integration

in the request header when you create the managed API. If no value is defined, the authentication type is anonymous. Enter one of the following values for authType:

BASIC

NO_AUTH

OAUTH2

Define as many IP range rules as needed. Enter the rule type and the IP address range for each ipRangeRules section. You can enter one of the following values for type:

ALLOW

DENY

The following example shows a payload of a request to create a managed API with a rate limit policy, basic authentication, and an IP range rule that allows all URLs: