Working with API Plans

This section describes how to work with API Plans, which includes the following functions:
Turn On API Plans
In order to use API Plans, the Portal Administrator must choose to turn on the feature. Note that if the preceding prerequisites are not met, the Administrator will not be able to turn on API Plans and an error message will display.
Before Turning On API Plans
Turning on API Plans is a one-time change and cannot be reverted. Note also that API Plans are not compatible with API Groups; switching this feature on means you are no longer able to use API Groups.
To turn on API Plans:
  1. On the Dashboard, select 
    Publish
    . The APIs page opens.
  2. Select 
    API Plans
    . The API Plans page opens 
  3. Click 
    Turn On API Plans
    .
Configure API Plans
Tip: 
You can also manage API Plans by way of the Portal API (PAPI), or use PAPI in your scripts for managing API Plans.
For more information about the PAPI, see Portal API (PAPI).
After turning on API Plans, the Administrator or API Owner can create and update API Plans, which includes the following functions:
  • Setting up rate limits and quotas for the API Plan
  • Attaching Public and Private APIs to the API Plan
  • Choosing which Organizations can use the API Plan
Note:
 Ensure that your API Plans have lower quota and rate limit than your Account Plans.
To configure API Plans:
  1. On the Dashboard, select 
    Publish
    . The APIs page opens.
  2. Select 
    API Plans
    . The API Plans page opens. By default, the API Plans page displays all API Plans. On this page, you can do the following:
    • Add an API Plan:
       Select 
      Add API Plan
    • Edit an API Plan:
       Select 
      Edit
       under 
      Actions
      .
    • Delete an API Plan:
       Select 
      Delete
       under 
      Actions
      . You cannot delete an API Plan if it is in use by any application. 
Create API Plans
To create an API Plan:
  1. On the Dashboard, select 
    Publish
    . The APIs page opens. 
  2. Select 
    API Plans
    . The API Plans page opens and displays a list of API Plans. 
  3. Select 
    Add API Plan
    . The API Plan page opens.
  4. In the 
    Edit Details 
    tab, complete the following:
    Setting
    Description
    Name
    Enter a name for the API Plan. This is required.
    Note:
     The API Plan name must be unique and cannot exceed 50 characters, which can contain letters, numbers, hyphens (-), and underscores (_).
    Enable quota for this plan
    Select this check box to limit the number of times an application can query the API associated with this Plan. Enter the maximum number of hits for the selected time period.
    Enable rate limits for this plan
    Select this check box to limit the number of concurrent requests an application may send to the API associated with this Plan. Enter the maximum number of requests for the selected time period.
    Tip:
     Setting a low value (such as 50 requests per second) can prevent your API from being overwhelmed by multiple simultaneous requests, which may happen with Denial-of-Service attacks or poorly programmed applications.
    Public Description
    Enter a description that can help API Owners, OrgAdmins, and Developers understand the service level provided by the API Plan to make informed selection for their applications.
    Important!
     If you want to link an Organization to an API Plan, the Organization must already have access to 
    all
     the APIs attached to the plan. The counter in 
    Available Organizations 
    shows you how many Organizations have access to all the selected APIs on the 
    Assign APIs
     page. This counter helps you understand how many Organizations you can potentially make the plan visible to, based on the APIs selected. If the Organization count is 0, this means the API has not been added to any Account Plan or Organization. See Manage Account Plans for more information.
  5. Select 
    Next
  6. In the 
    Assign APIs
     tab, select 
    Add 
    to add the public or private APIs displayed in the Available APIs list. You can make an entry in the 
    Filter
     search box to display a filtered list of available APIs. The APIs you add display in the Selected APIs list. Select 
    Remove 
    if you want to remove the API from the API Plan. A pop-up window opens prompting you to confirm the remove. 
  7. Select 
    Next
    .
  8. In the 
    Assign Organizations 
    tab, select 
    Add 
    to add the organizations linked to the APIs you assigned to the API Plan. You can make an entry in the 
    Filter
     search box to display a filtered list of available organizations. If 0 organization is displayed in the Available Organizations list, you need to assign it to an Organization. The organizations you add display in the Selected Organizations list. Select 
    Remove 
    if you want to remove the organization from the API plan. A pop-up window opens prompting you to confirm the remove.
  9. Select 
    Create
    . When a new plan is created, a notification displays on the API Plans page.
Update an API Plan
To update an API plan:
  1. On the Dashboard, select 
    Publish
    . The APIs page opens.
  2. Select 
    API Plans
    . The API Plans page opens.
  3. Select 
    Edit 
    beside the API Plan you want to update. The page for that API plan opens, displaying the information for that API Plan.
  4. (Optional) 
    In References, select 
    APIs
    Applications
    , or 
    Organizations
     to display a list of the APIs, applications, and organizations assigned to the API plan.
  5. Select 
    Edit
    . The Edit API Plan page opens. 
  6. Update the settings as needed in the 
    Edit Details
    Assign APIs
    , and 
    Assign Organizations
     tabs.
  7. Select 
    Save
    .
Delete an API Plan
To remove an API Plan:
  1. On the Dashboard, select 
    Publish
    . The APIs page opens.
  2. Select 
    API Plans
    . The API Plans page opens.
  3. Select 
    Delete