Thanks for your feedback!
EDIT
Catalog
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.
-
Access your Developer Portal.
Go directly to the link or access the Portal Manager and click to get the link. -
Click in the top right corner of the screen.
You must be logged in.
-
Select the desired product.
If necessary, use the search field by API or the product filter. -
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.
-
In the top right section, select the document revision and click DOWNLOAD SWAGGER.
Accesses
To view the documentation for an API in the catalog, it is necessary:
-
that the API Catalog route is defined in at least one role;
-
that the product and the API are defined with this role;
-
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 at least one role has API Catalog defined as one of its routes.
-
If the API:
-
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:
-
In the Portal Manager, click Products, located in the left side menu or on the home screen.
-
Click the
for the product you want to edit. -
In Roles, select the roles that will have access to the API catalog products.
|
Share your suggestions with us!
Click here and then [+ Submit idea]