Create a managed API from a published API. To create a managed API, you must be assigned the Deployer or Admin role. When you create a managed API, API Center generates API endpoint URLs for the API operations, which you can share with API consumers to access the operations with.
1On the API Console page, select the Published APIs tab.
The Published APIs tab shows all the published APIs according to the Last Modified Date of the published API.
2Click the Actions menu on the row of the selected published API and select Create a Managed API.
3Enter a name for the managed API.
The managed API name can contain up to 50 characters, including ASCII letters, digits, Japanese characters, hyphens, dashes, and underscores.
The Name field gets updated based on the changes you make to the Managed API Name field. The version information is appended to the Name field by default. You can't edit the Name field.
4In the URL Context field, enter the context that API Center adds to the API URL.
The context can contain up to 80 characters, including ASCII letters, Japanese characters, digits, hyphens, and underscores.
The context can be shared between different versions of a managed API that belongs to the same published API.
5Optionally, enter a description.
The following table describes the pre-populated and read-only fields available on the creating a managed API page:
Field | Description |
|---|
Location | Location of the project or folder that you selected while creating the published API. When you create a published API from an Application Integration process on the IDMC Services page, API Center automatically saves the published API and its subsequent managed APIs in the same location as the source process. When you create a published API and its subsequent managed APIs from a designed API, they automatically inherit the location of the original designed API. |
Run On | The runtime environment that you specified while creating the Application Integration process. |
Current Version | Current version of the managed API that is deployed on the API gateway. |
Domain (Base URL) | The URL defined in the service configuration of runtime environment agent for API gateway. |
6Optionally, enable the JSON web token (JWT) authentication policy at the managed API level.
You can enable JSON web token authentication at the API level. You can use this JSON web token to authenticate the API and all its operations.
- aOptionally, add required notes, and then click Save.
Notes can contain a maximum of 500 characters.
- bIf both API-level and operation-level authentications are selected, the Warning dialog box appears. Click OK to confirm overriding of all the existing operation-level authentication.
If no authentications were applied to the API operations previously, this dialog box doesn't appear.
For more information about using an API-level authentication policy, see API Policies.
7Optionally, create an IP filtering policy at the managed API level.
For more information about IP filtering policies, see API Policies.
8Optionally, create and associate a user-level rate limit policy for a specific user of the managed API.
For more information about user-level rate limit policies, see API Policies.
9Optionally, create and associate a CORS policy at the managed API.
For more information about CORS policies, see API Policies.
10Optionally, add or update operation level authentication, rate limit, response caching, or privacy policies for both managed APIs or custom managed APIs.
When you deploy an API, you can override the policies that are assigned to it. The following table shows the optional metadata that you can modify for an operation:
Policies | Options |
|---|
Authentication | Choose one or more of the following applicable policy type: - - Anonymous
- - Basic
- - OAuth 2.0
- - JWT - JSON Web Token
- - Session ID
To invoke a managed API using session ID, pass the session ID header value as IDS-SESSION-ID and then run the API. |
Rate Limit | Choose from the available rate limits. Default is system-org-level-rate-limit . |
Response Caching | Define the caching timeout in seconds. |
Privacy Settings | Define the privacy policy for the operation. |
For more information about authentication policies, see API Policies.
11Click Save.
If any validation errors occur, the Validation panel appears. Fix all errors listed on the Validation panel and click Save again.
API Center saves the managed API.
Use the expand or collapse button on the managed API page to view or hide the general properties of the managed API.