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.

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.

  1. Log in to API Manager.
  2. In the Welcome page, click the Develop APIs and Products tile.

    APIM screen

  3. Click the options icon options icon for existing API FindBranch x.0.0 and select Save as a new version.

    API supersede menu

  4. In the Version field, enter 3.0.0.
  5. Click Submit field. The dialog box closes.

    Save as new version

  6. Click FindBranch 3.0.0 to edit the new API.

    API list

  7. Click Paths in the navigation bar.
  8. Click /details in the Path list.

    Path list

  9. Click GET in the Operations section.

    Operations list

  10. Scroll down. Click Add in the Parameters section.
  11. Take the following actions.
    1. Enter loc in the NAME field.
    2. Select query in the LOCATED IN field.
    3. Select string in the TYPE field.
    4. Enter Location hint in the DESCRIPTION field.

    Get parameter configuration

  12. Click Save.

Duplicate and Change a Product

Take the following steps to duplicate and then modify an existing product.

  1. Click the Develop icon Develop icon in the navigation bar.
  2. Click Add > Product.

    Add product

  3. Select New product. Click Next.

    New product

  4. Enter FindBranches in the Title field. Click Next.

    New product

  5. Select FindBranch 3.0.0. Click Next.

    New product

  6. Accept the defaults for Plans. Click Next.

    New product

  7. Accept the defaults for Publish, Visibility, and Subscribability. Click Next.

    New product

  8. Click Develop in the breadcrumb trail to return to the list of APIs and Products.

    New product

  9. Click the options icon options icon alongside FindBranches 1.0.0 product. Select Stage.

    Stage product

  10. Select Sandbox, then click Stage to stage the product to the Sandbox catalog.

    Stage product

Supersede a Product

  1. Click the Manage icon options icon in the navigation bar.
  2. Click the Sandbox catalog icon.
  3. Click the options icon options icon alongside the product FindBranch auto product x.0.0 and select Supersede.

    Supersede product

  4. Select FindBranches.

    Supersede product

  5. Click Next.
  6. Select default-plan plan in the target column.
  7. Click Supersede.

    Supersede product

Notice the state of both products change. 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.

Superseded product

Migrate a Product

  1. 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.
  2. Click Apps.

    Portal products

  3. Click AppOne.

    Portal applications

  4. Click Subscriptions.

    AppOne application

  5. Click Migrate this subscription to plan 'default' in product 'FindBranch' at version '2.0.0'.

    AppOne subscriptions

  6. Click Migrate subscription.

    Migrate subscription

  7. Notice that the subscription changed to the target product.

    Migrated subscription

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