1. Using Oracle API Platform Cloud Service
  2. Manage Applications
  3. Manage Application Subscriptions to Plans

Manage Application Subscriptions to Plans

Subscriptions to plans allow you to determine to which APIs your applications are allowed to send requests.

Topics

Understand Application Subscriptions

Subscriptions represent the relationship between an application and a plan. To invoke an API that is entitled to plans, a client must create an application and subscribe it to a plan entitling that API.

Application developers use the Developer Portal to subscribe to plans; API managers use the Developer Portal and the Management Portal. You cannot subscribe an application to different plans that have entitlements to the same API.

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.

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.

View Application Subscriptions

You can view the plans to which an application is subscribed.
To view application subscriptions to plans:
  1. From the Applications List page, click the application for which you want to view subscriptions.
  2. Click the Subscriptions icon (Subscriptions) tab.
    The Subscriptions page appears. The plans to which the application has subscribed are displayed.
From this page you can subscribe an application to a plan. You can also approve, reject, suspend, or resume application subscriptions to plans.

Subscribe 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.

To subscribe an application to a plan:

  1. On the Applications List page, click the application that you want to subscribe to a plan.
  2. Click the Subscriptions icon (Subscriptions) tab.
  3. Click Subscribe to Plan.
  4. Select the plan(s) to which you want to subscribe.
  5. 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.
    • Suspended: The application is subscribed, but it is in a suspended state.
  6. Click Subscribe.

Approve or Reject 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 subscription to a plan:

  1. From the Applications List page, click the application for which a developer has requested for subscription to a plan.
  2. Click the Subscriptions icon (Subscriptions) tab.
  3. Click the Requesting tab.
  4. Click the name of the plan to which subscription is requested.
  5. Click Approve to approve the subscription, Reject to reject the subscription, or Dismiss to dismiss the subscription.
  6. Optionally specify the reason for your action, and then click Yes to approve or No to reject the subscription.
Approved subscriptions appear on the Subscribed tab, while rejected subscriptions appear on the Rejected tab. Dismissed subscriptions are deleted.

Suspend Application Subscriptions

You can temporarily suspend an application subscription to a plan. While the subscription is suspended, the requests from the application to the entitled APIs in the plan are rejected.

To suspend an application subscription to a plan:
  1. On the Applications List page, click the application for which you want to suspend subscription to a plan.
  2. Click the Subscriptions icon (Subscriptions) tab.
  3. Click the Subscribed tab on the Subscriptions page.
  4. Click the plan for which you want to suspend the application’s subscription.
  5. Click Suspend.
  6. Optionally specify the reason for suspending the subscription and then click Yes.
The application is no longer subscribed to the plan. The plan appears on the Suspended tab.

Resume a Suspended Application Subscription

You can resume a suspended subscription of an application to a plan.

To resume a subscription of an application to a plan:
  1. On the Applications List page, click the application for which you want to reactivate a subscription.
  2. Click the Subscriptions icon (Subscriptions) tab.
  3. Click the Suspended tab.
  4. Click the plan for which you want to resume the application’s subscription.
  5. Click Resume.
  6. Optionally, specify the reason for resuming the subscription and then click Yes.
The subscription of the application to the plan is resumed. The plan appears on the Subscribed tab.

Unsubscribe an Application

You unsubscribe an application from a plan to remove its access to the APIs entitled by the plan and prevent Application Developers from seeing the analytics data for the application in the plan in the API Platform Cloud Service Developer Portal.

To unsubscribe an application from a plan:
  1. On the Applications List page, click the application that you want to unsubscribe from a plan.
  2. Click the Subscriptions icon (Subscriptions) tab.
  3. Click the Subscribed tab. If the subscription to the plan is in the suspended state, click the Suspended tab.
  4. Click the plan from which you want to unsubscribe the application.
  5. Click Unsubscribe.
  6. Click Yes in the banner to confirm.