Viewing API Details
To view the API Details page, select an API from the Home or APIs page of the portal. The API Details page includes the following information about an API:
-
Name
Name of the API.
-
Type
The API type can be AsyncAPI, HTML, REST, or SOAP.
-
Contact email
The email of the contact for the API.
-
Categories
The name and value of the predefined category this API belongs to. APIs can have multiple categories. Categories organize APIs into groups to improve browsing and discovery. Categories are created and maintained in Exchange.
-
Tags
The name of a predefined keyword associated with this API. APIs can have multiple tags. Tags are created and maintained in Exchange.
-
Description
A description of the API.
-
Asset version
The version of the API.
-
Version state
The lifecycle state (development, stable, or deprecated) of this API.
-
Instances
The count of instances of the API.
-
Clients
The number of client applications of the API.
The API Console is located in the API Details page. The console component is interactive and shows information about API specifications and their methods. Endpoints are displayed in alphabetical order. See Using the API Console for more information.
View Categories and Tags
To view the categories or tags for an API:
-
On the API details page, click Categories or Tags to view the information.
-
Click Categories or Tags again to close the list.
View Instances Information and Copy the URL
To view the name and URL of an API instance and copy the URL:
-
On the API details page, click View instances.
-
Click the copy icon.
-
Click Close.