Managing Application Subscriptions to Plans
Subscriptions to plans allow you to determine to which APIs your applications are allowed to send requests.
Understanding Application Subscriptions
Note that an application cannot subscribe to different plans that have entitlements to the same API.
Analytics use subscriptions to filter data by application:
-
API and gateway analytics charts can be filtered to display data from specific applications. Requests from unsubscribed applications are collected as requests from unknown applications.
-
Developer Portal analytics charts are always filtered by application. Application developers must subscribe an application to a plan to view data for their requests to an entitled API.
Note:
To view application analytics data in the Developer Portal for requests to an entitled API, the plan, entitlements and API must be published in addition to subscribing an application to a plan.
Viewing Application Subscriptions
Subscribing an Application to a Plan
You can subscribe an application to a plan to enable the application to access the APIs entitled by the plan.
A plan can provide access to several APIs, and an application can subscribe to multiple plans to get access to different APIs. However, an application cannot subscribe to different plans that provide entitlement to the same API. For example, suppose Plan A provides access to API1, API2, and API3, whereas Plan B provides access to API1 and API4. Suppose your application has subscribed to Plan A to get access to API1. Now your application requires access to API4 as well. To access API4, your application cannot subscribe to Plan B because Plan B has a common entitlement with Plan A for API1. Your application needs to unsubscribe to Plan A and then subscribe to Plan B to get access to API1 and API4.
- On the Applications List page, click the application that you want to subscribe to a plan.
- Click the (Subscriptions) tab.
- Click Subscribe to Plan.
- Select the plan(s) to which you want to subscribe.
- Select an initial subscription state:
- Subscribed: The application is subscribed to the plan.
- Requesting: The application is subscribed, but the subscription must be approved by an API Manager. See Approving or Rejecting Application Subscriptions to approve subscription requests.
- Suspended: The application is subscribed, but it is in a suspended state. See Resuming a Suspended Application Subscription to resume suspended subscriptions.
- Click Subscribe.
Approving or Rejecting Application Subscriptions
A Plan Manager can approve or reject a developer’s request to subscribe their application to a plan to get access to APIs entitled by the plan.
Approving the subscription allows an application to send requests to APIs that are entitled by the plan. Until the subscription is approved, or if the subscription is rejected, requests to these APIs are rejected.
To approve or reject an application’s subscription to a plan:
- From the Applications List page, click the application for which a developer has requested for subscription to a plan.
- Click the (Subscriptions) tab.
- Click the Requesting tab.
- Click the name of the plan to which subscription is requested.
- Click Approve to approve the subscription, Reject to reject the subscription, or Dismiss to dismiss the subscription.
- Optionally specify the reason for your action, and then click Yes to approve or No to reject the subscription.
Suspending Application Subscriptions
You can temporarily suspend an application’s subscription to a plan. While the subscription is suspended, the requests from the application to the entitled APIs in the plan are rejected.
- On the Applications List page, click the application for which you want to suspend subscription to a plan.
- Click the (Subscriptions) tab.
- Click the Subscribed tab on the Subscriptions page.
- Click the plan for which you want to suspend the application’s subscription.
- Click Suspend.
- Optionally specify the reason for suspending the subscription and then click Yes.
Resuming a Suspended Application Subscription
You can resume an application’s suspended subscription to a plan.
- On the Applications List page, click the application for which you want to reactivate a subscription.
- Click the (Subscriptions) tab.
- Click the Suspended tab.
- Click the plan for which you want to resume the application’s subscription.
- Click Resume.
- Optionally, specify the reason for resuming the subscription and then click Yes.
Unsubscribing an Application
You can unsubscribe an application from a plan to remove its access to the APIs entitled by the plan.
When an application unsubscribes from a plan, Application Developers can no longer see the analytics data for the application in the plan in the API Platform Cloud Service Developer Portal.
- On the Applications List page, click the application that you want to unsubscribe from a plan.
- Click the (Subscriptions) tab.
- Click the Subscribed tab. If the subscription to the plan is in the suspended state, click the Suspended tab.
- Click the plan from which you want to unsubscribe the application.
- Click Unsubscribe.
- Click Yes in the banner to confirm.