API Settings

The documentation available in API DOCS can be configured in API Settings:

On the API Settings page you can configure the API to allow developers to make API calls directly from the documentation (tryout), enable App registration, and allow the API to be displayed in the Catalog.

API Settings

This configuration is only available for APIs that have been automatically imported with the connection.

See more about:

How to get to the API Settings page .
Making test calls to the API (tryout).
Allowing APP registration for the API.
Allowing the API to be displayed in the Catalog.

API Settings

To access the API Settings screen, follow these steps:

Access API DOCS.
Locate the API you want to test.
If necessary, use the search tool.

In the ACTIONS column of the API list, click on the of the desired API.

The AVAILABILITY column indicates if:

the API is available for app creation and to be displayed in the catalog;
the API is not available for display in the catalog or (exclusive) for app creation.
the API is not available for display in the catalog and (conjunction) for app creation.

Tryout

This feature allows you to make calls to the API directly from the documentation.

With tryout, you can understand the formats of requests and responses and the parameters for each endpoint.

Follow these steps to use the tryout feature:

Follow the steps above to get to the API Settings screen.
On the next page, in API Settings, click SELECT TRYOUT ENVIRONMENT.
On the screen that opens, select the environment of the API you want to test.
Navigate through the API documentation and click Tryout to make the test call to the endpoint.

If needed, click Authorize and enter the credentials to access the API.
Results are shown below the endpoint. See an example below.