Tutorial: Supersede a Product
This tutorial shows you how to supersede a published product with another product.
Before You Begin
This task can be completed by users who are assigned one of the following roles:- Catalog Owner
- Catalog Administrator
- Portal User
You must also do the following steps.
- Complete the Tutorial: Importing an API tutorial.
- You must have a Developer Portal that is activated for the Sandbox catalog. If you do not, complete the Tutorial: Creating the Developer Portal tutorial.
- You must have created an application in the Developer Portal and subscribed it to a product. If you do not, complete the Tutorial: Creating Accounts and Applications on the Developer Portal tutorial.
About this tutorial
In this tutorial, you are going to complete the following lessons:Modify an Existing API
Take the following steps to modify an existing API.
- In the Welcome page, click the Develop icon
in the navigation bar. - In APIs tab, click the ellipsis button
for existing API FindBranch x.0.0 and select Save as a
new version.
- Click Submit. The dialog box closes.
- Click FindBranch 3.0.0 to edit the new API.
- Click /details in the Path list.
- Click GET in the Operations section.
- Take the following actions.
- Enter loc in the NAME field and select Required.
- Select query in the LOCATED IN field.
- Select string in the TYPE field.
- Enter Location hint in the DESCRIPTION field.
- Click Add.
Duplicate and Change a Product
Take the following steps to duplicate and then modify an existing product.
- Click the Develop icon in the navigation bar.
- Click .
- Select New product and click Next.
- Enter 2.0.0 in the Version field and click
Next.
- Select FindBranch 3.0.0 and click Next.
- Accept the defaults for Plans and click Next.
- Accept the defaults for Publish, Visibility, and Subscribability. Click
Next.
- Summary page opens. Click Done.
- Click the ellipsis button alongside FindBranches 1.0.0 product and select
Stage.
- Select Sandbox, then click Next.
- Select Public and Authenticated. Then click
Stage to add the product to the Sandbox catalog.
Supersede a Product
- Click the Manage icon
in the navigation bar. - Click the Sandbox catalog.
- Click the ellipsis button alongside the product FindBranch auto product x.0.0 and select
Supersede.
- Select FindBranches.
- Click Next.
- Select default-plan plan in the target column.
- Click Supersede.
The deprecation process starts immediately. You can see the state as in progress.
Observe that the state of both products changes over time. FindBranch auto product x.0.0 is now deprecated, and FindBranches 1.0.0 is published. All external applications subscribed to FindBranch auto product x.0.0 remain subscribed but should migrate to FindBranches 1.0.0. The external application developer completes the migration in the Developer Portal.
Migrate a Product
- In a new browser window, sign in to the Developer Portal using the account you created in Tutorial: Creating Accounts and Applications on the Developer Portal.
- In the header, click Apps.
- Click AppOne.
- Click Subscriptions.
- Under the Product subscription section, click Migrate this subscription to plan
'default' in product 'FindBranch' at version '2.0.0'.
- Click Migrate subscription.
- Notice that the subscription changed to the target product. The subscription is now changed to
the target product.
What you did in this tutorial
- Created a new API
- Created a new Product
- Superseded an existing published product with the new product
- Migrated a subscribed external application to the new product