Configuring Postman settings at the provider organization level

Configure Postman credentials and workspace settings at the provider organization level to enable Postman integration for your catalogs.

Before you begin

Before you begin, ensure that you have:

  • Administrator or owner permissions for the provider organization
  • A Postman account with appropriate permissions
  • Postman API credentials

About this task

Postman settings are configured at the provider organization level, which allows all catalogs within the organization to use the same Postman credentials and workspace. Individual catalogs can then enable or disable the Postman integration as needed.

Important: The Postman workspace should be configured as a public workspace to ensure that API consumers can access the published collections.

Procedure

To configure Postman settings at the provider organization level, complete the following steps:

  1. Log in to API Manager and click Manage icon Manage.
  2. Click the Settings icon in the navigation pane to access the provider organization settings.
  3. On the settings page, click Postman.
    The Postman configuration page is displayed.
  4. Click Edit to configure the Postman settings.
  5. In the Postman Cloud URL field, enter the URL of your Postman instance.

    For Postman cloud, use: https://api.postman.com

    If you are using a self-hosted Postman instance, enter the URL for your deployment.

  6. In the API key field, enter your Postman API key to configure the authentication credentials for Postman.
    Note: You can generate an API key from your Postman account settings.
  7. Click Save to save the Postman configuration.
    The Postman settings are saved at the provider organization level and are now available for use in catalogs.

Results

The Postman integration is now configured at the provider organization level. Catalog owners can now enable Postman integration for their catalogs. When a product is published to a catalog with Postman integration enabled, API collections are automatically created and published to the configured Postman workspace.

What to do next

After configuring Postman settings at the provider organization level, you can enable Postman integration for each catalog where you want to use this feature. For more information, see Enabling Postman integration for a catalog.

Tip:

To verify that your Postman credentials are working correctly, enable Postman integration in a test catalog and publish a test product. Check your Postman workspace to confirm that the collection is created successfully.