General Info

Step 1

Access the API Catalog page by clicking the left side menu or the corresponding card on the Developer Portal home screen.

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 the for the desired API.

Step 1

Access the General Info tab in API Catalog.

Step 2

Click AUTHORIZE (in green).

Step 3

Enter the key value in the Value field, as shown in the image below.

Step 1

Follow the steps to reach the Settings and Permissions tab.

Step 2

In Settings and Permissions, click SELECT TRYOUT ENVIRONMENT.

Step 3

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

IMPORTANT

The environments available for tryout are named in a standardized way, regardless of the provider, based on the API contract's technical specifications:

• For OpenAPI 3.x: the information is obtained from the servers.url (address) and servers.description (environment name) fields.

• For Swagger 2.0: the URL is formed by combining the scheme, host, and basePath fields.

If the contract does not provide an explicit description for the environment, the system uses the URL host as the identifier or automatically searches for keywords (such as prod, dev, or test) to name the environment.

Step 4

Navigate the API documentation and click Try it out to make calls to the endpoints.

NOTE

If necessary, click Authorize and insert the credentials to access the API.

Step 5

The results will be displayed right below the endpoint. See an example below.