Configuring API Packages and Plans

The API Packages page allows you to manage (create, view and delete) packages and plans associated with APIs.

The following table describes the fields on the Packages page.
Field Description

Name

Name of the Package.

Description

Description of the Package.

Created

The date and time when the Package was created.

Updated

The date and time when the Package was updated.

Actions

Navigates to the API Package Edit page, where properties of the Package can be edited.

Deletes the Package.

The following sub-pages are available from the API Packages page.

API Package Edit Page

The API Package Edit page allows you to configure the name and description of the package.

API Package Key Properties Page



API Package Plans Page

The API Package Plans page allows you to configure the name and description of the package.

The following sub-pages are available from the API Packages Plans page.

API Package Plans Plan Page

The API Package Plans Plan page allows you to configure the name, description and status for a package's plan.

API Package Plans Rate Limit Page

The API Package Plans Rate Limit page allows you to configure call rate limits for a particular package's plan.

API Package Plans Key Properties

The API Package Plans Key Properties page provides settings help you to allow or restrict the developers or administrators from generating keys for the Package Plan.

The Package Key is generated for the developers to access a particular Package and the associated Plan. A key adapter and other key properties can be set on the Key Properties page.

API Package Plans Roles

The API Package Plans Roles page allows you to specify the roles that will have access to the API Plan in the portal.

API Package Plans Definitions

The API Package Plans Defintions page allows you to activate and link the API definition to a plan.

The Package Key is generated for the developers to access a particular Package and the associated Plan. A key adapter and other key properties can be set on the Key Properties page.

Selecting Endpoints for a Definition

To activate endpoints for a definition:
  1. Navigate to API Packages > selected Package > Plans > selected Plan > Definitions > selected Definition > Endpoints.

  2. On the Endpoints page, click the Activate link for the endpoint in the Available Endpoints list. The endpoint moves to the Activated Endpoints list.