1. Home
  2. ...
  3. API Catalog
  4. API Settings

API Settings

LLMs
The documentation available in API Catalog can be configured in API Settings:

The documentation available in API Catalog 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

NOTE

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

See more about:

API Settings

To access the API Settings screen, follow these steps:

Step 1

Access API Catalog.

Step 2

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

Step 3

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

NOTE

The AVAILABILITY column indicates if:

  • icon with a checkmark the API is available for app creation and to be displayed in the catalog;
  • yellow icon with the letter i the API is not available for display in the catalog or (exclusive) for app creation.
  • red icon with the letter i 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:

Step 1

Follow the steps above to get to the API Settings screen.

Step 2

On the next page, in API Settings, click SELECT TRYOUT ENVIRONMENT.

button to select environment

Step 3

On the screen that opens, select the environment of the API you want to test.

available environments

Step 4

Navigate through the API documentation and click Tryout to make the test call to the endpoint. try it out button

NOTE

If needed, click Authorize and enter the credentials to access the API.

botão authorize

Step 5

Results are shown below the endpoint. See an example below.

example of results of a test call

Enable APP Registration

To allow developers to register their applications in the Developer Portal, simply select the Enable Apps Registration option.

Keep the toggle disabled if you do not want to allow App registration.

location of the toggle to enable Apps registration

NOTE

This option is only available for native connections APIs.

Allow API to be displayed in Catalog

To allow the API to be displayed in Catalog, simply select the Enable in Portal Catalog option.

If you keep the toggle disabled, the API will not be displayed in the Catalog.

location of the toggle to enable the API to be displayed in the Catalog

How happy are you with this page?

Settings and Permissions
API Catalog

We use cookies to enhance your experience on our site. By continuing to browse, you agree to our use of cookies.Learn more