Page History
API Management uses a hierarchical data model that consists of five primary elements:
Figure: Overview on the API Management Data Model
The main elements of API Management are Clients, Plans and APIs. All of them can contain Policy definitions. To be used, they need to be grouped by an Organization and related by a Contract.
| Element | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Organization |
| ||||||||
| Client |
| ||||||||
Plan |
| ||||||||
| API |
| ||||||||
| Policy |
| ||||||||
| Contract |
|
Versioning
API Management supports versioning for APIs, plans and clients. All three elements share one behavior: They have to be determined to be available for use in the gateway.
| Info |
|---|
While it is still possible to modify a published API and a registered client, a locked plan cannot be revised. |
If modifications to the API Management configuration are necessary, you can do this by:
- Creating a new element.
- Modifying an existing element (only APIs and clients).
- Create a new version of an existing element.
Versioning allows you to modify the configuration of an existing element, but retain the previous version. To create a new version of an element, open its details page and click New Version in the basic settings:
Then, configure your new version:
| Field | Description |
|---|---|
| Version | Enter a version name or number. |
| Make a clone | Enable this checkbox if you want copy the policies and settings of the previous version to your new version. Typically cloning is more convenient when making incremental changes. |
Click Create Version to add the new version. It will be saved to the element.
| Multiexcerpt include | ||||
|---|---|---|---|---|
|
Use drop-down Version in the basic settings of the element to switch between the different versions:
Visibility
The visibility concept of API Management enables a fine-grained access to APIs and defines which user groups can find them. The visibility resides on top of the permission system as another security layer. Visibilities are applicable to Public APIs and plans for Private APIs. The chosen visibility affects both UIs: The content of API Management as well as the content of the API Developer Portal from where API consumers can access the APIs. Relevant for the visibility is the identity management (IDM) group a user belongs to: A user who is part of the API-Management-User group can browse and find the same APIs in API Management and in the Developer Portal once logged in.
You can choose between three different visibilities:
- Organization Members (default)
- API Management Users
- API Developer Portal Visitors
| Example: Three APIs have been created in organization ACME. Each API is assigned a different visibility:
|
| Organization Members (default) APIs are secured by default: If you create a new API, the default visibility setting is Organization Members. Only members of the organization the API has been created in are allowed to see it. Example: API Management users who are explicit member of organization ACME can see API 1, API 2 and API 3. |
| API Management Users Select the visibility API Management Users to allow all API Management users to see your API. Example: All API Management users or administrators can see API 2 and API 3, they do not need to be member of organization ACME. |
| API Developer Portal Visitors Choose the visibility API Developer Portal Visitors to allow API developer Portal users and visitors to see your API. Example: Developer Portal users and anonymous portal visitors without a PAS login can see API 3 only. |
| Panel | ||
|---|---|---|
| ||
|
| Panel | ||
|---|---|---|
|
| Otp | ||
|---|---|---|
|
|
Overview
Content Tools