Publish the New Version and Deprecate the Old

You publish an API to make it available for subscription in the API Store. If you set up multiple tenants, your tenant store will be visible to other tenants as well. Therefore, users of the other tenants can view the APIs that are published in your default API Store. This allows you to advertise your APIs to a wider audience. Although the APIs that are published in your tenant store are visible to the users of other tenant stores, they need to log in to your tenant store in order to subscribe to and use them.

The steps below show how to publish an API to its default API Store:

1. Log in to the API Publisher as a user who has the publisher role assigned. 

2. Click the API that you prototyped in the previous tutorial (e.g., PhoneVerification 2.0.0).
   

3. Go to the API's Lifecycle tab and click Publish. 

   Tip: The Lifecycle tab is only visible to users with publisher privileges.

   

   Tip: Leave the Require Re-Subscription check box cleared if you want all users who are subscribed to the older version of the API to be automatically subscribed to the new version. If not, they need to subscribe to the new version again.You can choose to deprecate old versions of this API at this stage by selecting the Deprecate Old Versions check box.

   Note

   Users will not automatically get subscribed to lower versions of an existing API even if the lower version is newly created. For example, if you create version v1 from existing API version v2, the subscriptions belonging to v2 are not automatically assigned to v1.

   The API is now published to the default API Store.

4. Log in to the default Store and click the APIs menu to see the API that you just published listed there.

5. Go back to the API Publisher and click the API that you want to deprecate (e.g., PhoneVerification 1.0.0).

6. Go to the API's Lifecycle tab and click Deprecate. 
   
   The API is now deprecated.
   

7. Go back to the API Store, click the Applications menu and open the Default Application. Click the Subscriptions tab to see the deprecated API. The subscriptions made to the older API versions must be deprecated now.

   

   Tip: When an API is deprecated, new subscriptions are disabled (you cannot see the subscription options) and existing subscribers can continue to use the API as usual until it is eventually retired.

You have published an API to the API Store and deprecated its previous versions.