Managing your Products

You can manage your products in API Manager by using the Products page of the associated catalog. In this view, you can move the products through their lifecycle, display analytics information, and control who can see or subscribe to the products. The syndication feature in IBM® API Connect means that products can also be managed by using the Products tab of the associated space.

Before you begin

To complete the product management tasks that are described in this topic, you must either be the owner of the API provider organization, or be assigned Manage permission for products in the catalog that contains the product. If you have View permission for products, you have read-only access to the product management page. For information on configuring product management permissions for a catalog, see Creating and configuring catalogs.

The syndication feature in IBM API Connect means that products can be contained within a space in a catalog. In this case, to complete the product management tasks that are described in this topic, you must either be the owner of the API provider organization, or be assigned Manage permission for products in the space that contains the product. For information on configuring product management permissions for a space, see Managing user access in a space.

About this task

For more information about the product lifecycle, see The Product lifecycle.

For more information about the syndication feature, see Using syndication in API Connect.

For information on viewing analytics that can provide insight into product and API usage and performance, see API Analytics.

For information about product billing, see Monetizing your Products.

Procedure

To manage your product, complete the following steps.

  1. In the navigation pane of the API Manager UI, click Manage icon in the API Manager UI navigation pane Manage catalogs, then select the catalog that you want to work with.
    The Products page of the catalog opens, and all of the products available in that catalog are displayed.
  2. If the product that you want to work with is contained within a space, select the required space by completing the following steps:
    1. Click the Spaces tab.
    2. Select the space that you want to work with.
    The Products page of the space opens, and all of the products available in that space are displayed.
  3. Expand a product to see details of the APIs and plans in that product.
    Manage options are also available, depending on the state of the product. To view the manage options, click the options icon options icon and select the options that you require.
  4. To manage the lifecycle of a version of a product, click the options icon options icon alongside the product version, and select the required lifecycle action.
  5. To set the migration target of a version of a product, click the options icon options icon alongside the product version, and select Set migration target. In the Set migration target window, select the product that you want to set as the migration target, and select Next. Then map the migration source plans to the migration target plans, and click OK.
    Restriction: If the plan is part of a product that is contained within a space in the catalog, and the migration action is being made at the space level, the plan that you are migrating subscriptions from must be located in the same space as the plan you are migrating to. If the migration action is being made at the catalog level, subscriptions can be migrated across spaces. For more information about the Space feature, see Using syndication in API Connect.