Integrating with Postman

The Postman integration feature enables API providers to automatically publish API collections to Postman workspace and the API consumers to easily test and work with APIs using the Postman platform.

Postman is a popular API development and testing platform. By integrating API Connect with Postman, you can streamline the API consumption experience for application developers. When you publish an API to a catalog that has Postman integration enabled, API Connect automatically creates a Postman collection from the OpenAPI specification and publishes it to your configured Postman workspace.

You can use the Run in Postman button in the Developer Portal, , or to fork the collection into your personal Postman workspace, where you can test, modify, and work with the API. For more information, see Configuring the Run in Postman button.

Note: To integrate API Connect with Postman, you must meet the following criteria:
  • A Postman account with appropriate permissions to create and manage collections in a workspace
  • Postman API credentials
  • A Postman workspace ID where collections will be published
  • APIs must be defined using OpenAPI 3.0 or 3.1 specifications
Postman collections are automatically managed throughout the product lifecycle. For more information, see Product lifecycle operations and Postman collection.
Important: Product lifecycle operations do not fail if the Postman publish operation fails. This ensures that your API management workflow continues even if there are temporary issues with the Postman integration.

Visibility and access control

To access the published Postman collections, their Postman accounts must have visibility to the workspace where the collections are published. The Postman integration works with products that have the following visibility settings:

  • Public - APIs are visible to all users
  • Authenticated - APIs are visible to authenticated users
Restriction: Postman integration is not supported for products with Custom visibility settings.

Configuring Postman integration

To set up Postman integration, you must complete the following configuration tasks:

  1. Configure Postman settings at the provider organization level - Set up the Postman credentials and workspace information.
  2. Enable Postman integration for a catalog - Turn on the Postman integration feature for specific catalogs.

After configuration is complete, Postman collections are automatically created and managed as you publish and manage products in the catalog.