Configuring API Definitions and Endpoints
The API Definitions page displays a navigable list of API definitions. To add a new API Definition, click New.
The following table describes the fields on the API Definitions page.
| Field | Description |
|---|---|
|
Name |
Name of the API. |
|
Version |
Version of the API. |
|
Description |
Description of the API. |
|
Created |
The date and time when the API definition was created. |
|
Updated |
The date and time when the API definition was updated. |
|
Actions |
|
|
Navigates to the API Definition Settings page, where properties of the API can be edited. |
|
Deletes the API definition. |
The API Definitions page has the following sub-pages with further fields and settings that can be configured.
API Definition Settings
General settings such as API description, API version, cross-domain and robots policies can be defined on the API Definition Settings page.
After entering the policy and other details, click Save to save the changes.
API Definition Security
The API Definition Security page allows you to enable OAuth 2.0 for an API. The OAuth settings are applied to all endpoints that are configured to use OAuth as the security mechanism. Some of these settings can be overridden at the endpoint level.
API Definition Performance Acceleration
An API's performance can be improved by caching the responses in the cache.
The following table describes the field on the API Definition Performance Acceleration page.
| Field | Description |
|---|---|
| Cache Time-To-Live (TTL) | The length of time the data is stored in cache. You can use the drop-down to select a TTL value. By default, the TTL is defined in minutes. |
API Definition Roles
In the API Definition Roles page, specify the roles that will have to the API definition in the Developer Portal. The portal will display only the Interactive Documentation that is appropriate for the user's given role.
API Definition Endpoints
After an API is created, you can create, modify, and delete endpoints associated with the API on the API Definition Endpoints page.
While you are viewing or creating endpoints, you can access the API Definition-related endpoint settings by using the navigational tabs on the left pane of the page. The following sub-pages are available from the API Definition Endpoints page.
Endpoints Page
The Endpoint sub-page allows you to create the name of the endpoint, as well as configure Mutual TLS (MTLS), HTTP Client Profile, Public Endpoint Address, and TIBCO Cloud API Management Endpoint Address.
Configuring an Endpoint to Use MTLS
To configure an endpoint to use MTLS, select the Require Mutual TLS MTLS checkbox.
Protocol and Authentication Page
The Protocol and Authentication page allows you set the key and method details related to an endpoint. You can select parameters such as the endpoint type, supported HTTP methods, method location, and Developer API key location.
Security Page
The Security page allows you to enable System Domain Authentication.
CORS Page
The CORS page allows you to configure Endpoint Cross-Origin Resource Sharing, a W3C standard that defines how the browser and server should interact when cross-domain requests are made.
Call Transformations Page
The Call Transformations page allows you to apply processing logic to an API call before it is sent to the host API servers and after the call is returned from the client API servers.
Performance Acceleration
Endpoint performance can be optimized by managing the cache. If your call responses are cacheable, specifying appropriate caching rules reduces the end-to-end latency time of API calls. The caching rules set at an endpoint-level, as shown in the following image, affect all calls made to the endpoint.
More Page
The More page allows for configuring Traffic-Manager-specific settings. You can configure the Traffic Manager to include or exclude headers from the requests and responses.
