Catalog

Understand how to access the Catalog to view API documentation organized by product.

The Catalog page displays the documentation for your APIs, organized by product.

The upload of API documentation and the organization of APIs into products are done through the Portal Manager.

Follow the steps below to download a swagger file.

Step 1

Access your Developer Portal. Go directly to the link or access the Portal Manager and click Portal to get the link.

Step 2

Click APIs in the top right corner of the screen. You must be logged in.

detail of the developer portal header with an indication of the link to the catalog

Step 3

Select the desired product. If necessary, use the search field by API or the product filter.

Step 4

Click the API's DOCUMENTATION button. The images below are for illustrative purposes only. Colors, logos, and other elements may vary depending on the customization made in Portal > Appearance of the Portal Manager.

detail of the developer portal product screen and documentation button

Step 5

In the top right section, select the document revision and click DOWNLOAD SWAGGER.

detail of the catalog screen with document revision and download button options

Accesses

To view the documentation for an API in the catalog, it is necessary:

Step 1

that the API Catalog route is defined in at least one role;

Step 2

that the product and the API are defined with this role;

Step 3

that the user has a role with characteristics 1 and 2.

Administrator, if a user does not see a product or API in the API catalog, verify:

If the product is published in the catalog.
If at least one role has API Catalog defined as one of its routes.
- If the product is defined with this role.
- If the API:
  - is defined with this role.
  - is enabled to be displayed in API Catalog
- If the user has this role.

Registering and editing roles for a product

Administrator, follow these steps to define which roles can access the API Catalog:

Step 1

In the Portal Manager, click Products, located in the left side menu or on the home screen.

home screen with products highlighted

Step 2

Click the pencil icon for the product you want to edit.

Step 3

In Roles, select the roles that will have access to the API catalog products.

step 1 of product registration with roles highlighted

TIP

See how to assign roles to a user.

Publish a product so that it appears in the API catalog.

Create a new product.

How happy are you with this page?

Portal Manager

API Status