---
title: Catalog
description: Understand how to access the Catalog to view API documentation organized by product.
documentId: developer-portal-catalog
locale: en-US
---

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

The [upload of API documentation](/docs/developer-portal/api-docs) and the [organization of APIs into products](/docs/developer-portal/products) are done through the [Portal Manager](/docs/developer-portal/portal-manager).

Follow the steps below to **download a _swagger_ file**.

<Steps>
  <Step>
    ### Step 1

    Access your Developer Portal. Go directly to the link or access the Portal Manager and click **Portal** to get the link.
  </Step>
  <Step>
    ### 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](https://creative-ball-51b3fc85c0.media.strapiapp.com/developer_portal_menu_5c07136fc5.png)
  </Step>
  <Step>
    ### Step 3

    Select the desired product. If necessary, use the search field by API or the product filter.
  </Step>
  <Step>
    ### 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](/docs/developer-portal/appearance) of the [Portal Manager](/docs/developer-portal/portal-manager).

    ![detail of the developer portal product screen and documentation button](https://creative-ball-51b3fc85c0.media.strapiapp.com/catalog_product_documentation_a0f1c7a833.png)
  </Step>
  <Step>
    ### 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](https://creative-ball-51b3fc85c0.media.strapiapp.com/catalog_download_78d2f63287.png)
  </Step>
</Steps>

<a id="_accesses"></a>
## Accesses

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

<Steps>
  <Step>
    ### Step 1

    that the _API Catalog_ route is defined in at least one role;
  </Step>
  <Step>
    ### Step 2

    that the product and the API are defined with this role;
  </Step>
  <Step>
    ### Step 3

    that the user has a role with characteristics 1 and 2.
  </Step>
</Steps>

<a id="access-check"></a>
Administrator, if a user does not see a product or API in the API catalog, verify:

- If the [**product is published** in the catalog](/docs/developer-portal/products#publish-product).
![Image](https://creative-ball-51b3fc85c0.media.strapiapp.com/published_product_4a0b3de936.png)

- If at least one role has [**_API Catalog_** defined as one of its routes](/docs/developer-portal/roles#new-role).
![Image](https://creative-ball-51b3fc85c0.media.strapiapp.com/role_api_catalog_de207ed526.png)

  - If the [**product** is defined with this role](/docs/developer-portal/products#new-role).
![Image](https://creative-ball-51b3fc85c0.media.strapiapp.com/product_role_catalog_9e67d8a074.png)

  - If the **API**:
    - [is defined with this role](/docs/developer-portal/api-docs).
![Image](https://creative-ball-51b3fc85c0.media.strapiapp.com/roles_example_api_docs_74500a2a5d.png)

    - [is enabled to be displayed in _API Catalog_](/docs/developer-portal/settings-permissions#enable-list)
![Image](https://creative-ball-51b3fc85c0.media.strapiapp.com/roles_enable_api_catalog_32a6ee240e.png)

  - If the [user has this role](/docs/developer-portal/developers).
![edit developer screen with menu and role highlighted](https://creative-ball-51b3fc85c0.media.strapiapp.com/role_user_catalog_2a65102bb2.png)

<a id="_registering_and_editing_roles_for_a_product"></a>
### Registering and editing roles for a product

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

<Steps>
  <Step>
    ### Step 1

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

    ![home screen with products highlighted](https://creative-ball-51b3fc85c0.media.strapiapp.com/products_07a7a42b30.png)
  </Step>
  <Step>
    ### Step 2

    Click the ![pencil icon](https://creative-ball-51b3fc85c0.media.strapiapp.com/icon_edit_2_e029ead2c4.png) for the product you want to edit.
  </Step>
  <Step>
    ### Step 3

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

    ![step 1 of product registration with roles highlighted](https://creative-ball-51b3fc85c0.media.strapiapp.com/product_roles_619ffa8c7e.png)
  </Step>
</Steps>

<Callout type="TIP" title="TIP">
- [See how to assign roles to a user](/docs/developer-portal/developers#roles).
- [Publish a product](/docs/developer-portal/products#publish-product) so that it appears in the API catalog.
- [Create a new product](/docs/developer-portal/products).
</Callout>