Example: Migrate API Version with a subscription

This example walks through the process to migrate a Classic APIM API Version with a Subscription. The published Hello World Test Migration API Version has one endpoint, a CORS Policy, and approves subscriptions automatically. The following image shows the Application with the subscription in the Classic APIM Developer Portal.


Example Application in the Classic APIM Developer Portal

The following procedures will work with any Classic APIM API Version or Proxy to which you have subscribed.

To migrate the API Version:

  1. From the APIM 3.0 navigation pane, open the Migration Tool.
  2. For step one: Click the filter to search for the API Version and select it.
  3. Click Next.
  4. For step two: Leave the Migrate Policies toggle on.
  5. Click Next.
  6. For step three: Select the project for the new Service.
  7. Click Migrate.

After migration finishes, verify the subscription settings and publish the new Service:

  1. In the Services Catalog, navigate to the project folder created for the new Service.
  2. Expand it and click the Service Version to open its details.
  3. Click the Subscriptions tab and verify that the original subscription exists. It will use an API key for authentication and have a time-to-live of 365 days.
  4. To the left of the Service name, click Unpublished and select Public.

Test the subscription for the new Service endpoint with the original API key:

  1. Copy the original API key:
    1. From the waffle menu, select the Classic APIM Developer Portal.
    2. Open the Application subscribed to the API Version.
    3. Click the API key to copy it to the clipboard.
  2. From the waffle menu, select the APIM 3.0 Developer Portal link.
  3. Locate the Service migrated from the API Version.
  4. Click the Service card or table row to open the Service details.
  5. Click the endpoint to show its details.
  6. Click Authorize.
  7. Paste the API key.
  8. Click Authorize.
  9. Click the X to dismiss the Authorize dialog.
  10. Click Try it out.
  11. Click Execute.
  12. The response displays.

If you encounter issues, try the following:

  • Re-copy the API key from the Classic Developer Portal Application and try again.
  • Unpublish the migrated Service and try the API key with the API Version or Proxy in Classic APIM.
  • Verify that the Application with the subscription exists in the APIM 3.0 Developer Portal.
  • Republish the migrated Service and try calling the APIM 3.0 Service endpoint with Postman or a similar tool.