Oracle by Example brandingImplementing a Plan

section 0Before You Begin

This 15-minute tutorial shows you how to create and publish a plan in Oracle API Platform Cloud Service.

In this series of tutorials, you'll learn how to create and manage plans. This is the first tutorial in Managing Plans in Oracle API Platform Cloud Service. Read the tutorials in the order listed.

Background

In Oracle API Platform Cloud Service, you use plans to group a set of APIs and entitle client applications to subscribe to plans to access the APIs.

In this series of tutorials, you are a plan manager tasked with creating and implementing a plan and subscribing applications to the plan. The plan provides entitlement to an API to enable customers to submit warranty claims. In this tutorial, you will create the plan, configure the rates, add an API entitlement, and publish the plan to the Developer Portal. In the next tutorial, you’ll assign grants to users and manage subscription of applications to the plan.

What Do You Need?

  • An Oracle API Platform Cloud Service instance
  • Access to the instance as a user with the Plan Manager role
  • Access to the WarrantyClaim API or any other published API
  • An active gateway

section 1Create a Plan

Begin by creating your plan.

  1. Sign in to the Management Portal in Oracle API Platform Cloud Service as a plan manager using the following URL format:

    https://instance-identityDomain.apiplatform.ocp.oraclecloud.com/management

    Where, instance-identityDomain refers to the identity domain of your Oracle API Platform Cloud Service instance.

  2. In the Management Portal navigation menu, click Plans.
    Oracle API Platform Cloud Service Management Portal navigation pane
    Description of the illustration nav_pane.png
  3. On the Plans page, click Create.
  4. In the Create Plan dialog, enter the following details:
  5. Click Create.

    The Plans page displays the newly created plan.

    Plans page
    Description of the illustration plans_page_result.png

section 2Configure the Plan Rate Limit and Gateway

After you create the plan, set its rate limits and choose the gateway through which the plan will invoke APIs.

  1. On the Plans page, click your plan.
  2. On the Settings page, click Limited to set a specific rate limit for the plan.
  3. Click the text [Enter number of requests].
    Plan rate limit
    Description of the illustration settings_page.png
  4. Type 100 and click Apply Editor Changes Apply Editor Changes icon.
  5. Click the time interval drop-down arrow and select Minute.

    Your plan now allows 100 requests per minute to its APIs.

  6. In the Gateways section, click Specific to specify the gateway through which the plan can invoke APIs.
  7. Click the text Select one or more gateways. (If no gateways are selected, the entitled APIs will not be accessible.)
    Gateway settings
    Description of the illustration settings_gateways.png
  8. Select a gateway.
  9. Click Save.

section 3Add an API Entitlement to the Plan

Now add entitlement to an API that’ll be available through the plan. A plan can include entitlements to multiple APIs, and a given API can be entitled by multiple plans.

  1. In the plan’s navigation pane, click Entitlements Entitlements icon.
  2. On the Entitlements page, click Add Entitlement.
  3. In the Add API Entitlement dialog, select the WarrantyClaim API.
    Add API Entitlement dialog
    Description of the illustration add_api_dialog.png
  4. Click Add.

    The entitlement to the API is added to the plan.

    API entitlement in a plan
    Description of the illustration api_added.png

section 4Publish and Activate API Entitlements

Next, publish and activate each API entitlement to make it available for use to application developers in the Developer Portal. Publishing a plan does not automatically publish the APIs entitled in the plan.

  1. On the Entitlements page, click the WarrantyClaim API entitlement that you want to publish.
  2. Click Publish.
  3. In the WARNING dialog, click Yes to confirm.

    The status of the API entitlement is shown as Published.

  4. Click the API entitlement again, and select Activate.
  5. In the WARNING dialog, click Yes to confirm.

    The status of the published API entitlement is shown as Active.

    API published and active
    Description of the illustration api_active.png

section 5Publish the Plan

Publish your plan to enable application developers to discover and consume it in the Developer Portal.

  1. In the plan’s navigation pane, click Publication Publication icon.
  2. In the Developer Portal URL section of the Publication page, click [ Enter Portal Name ], and enter WarrentyClaims as the plan name that will appear in the Developer Portal URL. Then, click Apply Editor Changes Apply Editor Changes icon.
    Portal name
    Description of the illustration publish_plan_portal.png
  3. In the Plan Overview section, click Markdown, then click Text to specify the plan overview.
  4. Enter the following text as the plan overview that will appear in the Developer Portal, and then click OK.

    Warranty Claim plan to protect your mobile device from any manufacturing defects for lifetime

    Plan overview
    Description of the illustration publish_plan_overview.png
  5. In the Publication Summary Information section, select the items you want to display in the plan's summary in the Developer Portal. Select the following check boxes:
    • Show plan icon
    • Show description
    • Show rate limit
    • Mark as recommended plan
  6. Click Save.
  7. Click Publish to Portal.

    Your plan is now published to the Developer Portal.

next stepNext Tutorial

Managing Plan Grants and Subscriptions