Enabling Postman integration for a catalog

Enable Postman integration for a catalog to automatically publish API collections to Postman when products are published to the catalog.

Before you begin

Before you begin, ensure that:

About this task

After Postman settings are configured at the provider organization level, you can enable Postman integration for individual catalogs. When Postman integration is enabled for a catalog, API Connect automatically creates and manages Postman collections for the APIs that are published to that catalog.

Important:
  • Postman integration only works with products that have Public or Authenticated visibility. Products with Custom visibility are not supported.
  • For best results, define APIs using OpenAPI 3.0 or 3.1 specifications.

Procedure

To enable Postman integration for a catalog, complete the following steps:

  1. Log in to API Manager and click Manage icon Manage.
  2. Select the catalog for which you want to enable Postman integration.
  3. Click the Catalog settings tab.
  4. In the catalog settings navigation pane, click Postman.
    The Postman integration settings page is displayed.
  5. Set the Enable Postman integration slider control to the On position.

    When you enable Postman integration, the following information is displayed:

    • The Postman workspace ID configured at the provider organization level
    • The Postman cloud URL
    • A confirmation that the integration is enabled
  6. Click Confirm to enable Postman integration for the catalog.
    Postman integration is now enabled for the catalog. When products are published to this catalog, API collections are be automatically created in the configured Postman workspace.

Results

Postman integration is now active for the catalog.

  • When a product is published to the catalog, a Postman collection is created for each API in the product.
  • The collection ID and workspace ID are stored in the API document and made available to the Developer Portal, CMS Portal, or based on the portal option that you selected.
  • A Run in Postman button is displayed in the Developer Portal, CMS Portal or Consumer Catalog for APIs with Postman collections. You can click this button to fork the collection into their personal Postman workspace.

What to do next

Verify that the Postman integration is working correctly:

  1. Publish a test product to the catalog. See Publishing a Product for details.
  2. Log in to your Postman account and navigate to the configured workspace.
  3. Verify that a new collection has been created for each API in the published product.
  4. Access the Developer Portal, CMS Portal, or Consumer Catalog and verify that the Run in Postman button is displayed for the API.

Disable Postman integration for a catalog if required:

  1. Navigate to the catalog settings and click Postman.
  2. Set the Enable Postman integration slider control to the Off position.
  3. Click Confirm.
Important: Disabling Postman integration does not delete existing collections from Postman. Collections that are created previously remains in the Postman workspace. However, new products published to the catalog does not create Postman collections, and existing collections are not be updated when products are republished.