Superseding a Product with another Product
You can supersede a published Product with another Product by using the API Manager.
Before you begin
The superseding Product must be in the Staged, Deprecated, or Published state. The Product to be superseded must be in the Published state.
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
- The superseding Product is published.
- The same visibility, subscriber, and gateway enforcement settings from the original Product are used for the superseding Product.
- The original Product is moved to the Deprecated state. When a Product is deprecated, application developers that are already subscribed to the Product can continue to use it, but no new developers can subscribe to the Product. A deprecated product can be published again if required.
Although you can publish to a development Catalog, the development Catalog should be used only for testing purposes. Similarly, a Developer Portal created from a development Catalog must be used for testing purposes only, and not for production use. For more information on Catalogs, see Working with Catalogs.
When you use the test tool in a development Catalog, any Product that you test is forced through and overwrites staged and published Products even if the APIs are being used in the Developer Portal.
- When you publish, replace, or supersede a Product, there is a short delay before the APIs in the Product are available to be called through the API Connect gateway.
- All references in this topic to a Catalog, can also be applied to a Space in a Catalog, unless specified otherwise.
Procedure
To supersede a Product, complete the following steps:
Results
Your superseding Product is in the Published state.
The Product that was superceded is in the Deprecated state.
Your superseding Product is published to your preferred organizations or communities. Application developers within the groups you selected can see and use the APIs within the Product. The original Product is deprecated.Any application developer requests to use your Product are displayed on the Approvals tab in the containing Catalog, where you can decline or accept the request.
Customers who are already subscribed to the deprecated Plan are not disconnected from their credit card billing provider subscription to the deprecated Product, as it is still available for existing customers to use. New customers cannot subscribe to the deprecated Plans.