General Info

On the General Info tab, you can:

General Info

Accessing the General Info tab

Follow these steps to access the General Info tab:

  1. Access the API DOCS page by clicking the left side menu or the card on the Developer Portal home screen.
    home screen with api docs highlighted

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

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

Configuring credentials

To enter access credentials for the API:

  1. Access the General Info tab in API Docs.

  2. Click AUTHORIZE.
    general info tab with authorize button highlighted

  3. Enter the key value.
    available authorizations modal

Tryout

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

With tryout, you can understand the format of requests and responses and what parameters are required by each endpoint.

See how to choose the environment for tryout.

Follow these steps to use tryout:

  1. Follow the steps to reach the Settings and Permissions tab.

  2. In Settings and Permissions, click SELECT TRYOUT ENVIRONMENT.
    button to select environment

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

    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.

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

    button to test the endpoint

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

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

example of the call result
Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]