Creating a Package
You must have the API Gateway's manage packages and plans functional privilege assigned to perform this task.
You can create an API Package from the Manage packages and plans page.
To create an API Package
1. Click Packages in the title navigation bar.
2. Click Create in the Manage packages and plans section.
3. Select Package.
4. Click Create.
5. Provide the following information in the Basic information section:
Field | Description |
Name | Name of the API package. |
Version | Version assigned for the API package. |
Team | Team to which the application must be assigned to. You can select more than one team. To remove a team, click the icon next to the team. |
Description | A brief description for the API package. |
Icon | An icon that is displayed for the API package. Click Browse and select the required image to be displayed as the icon for the API package. The icon size should not be more than 100 KB. |
You can save the API package at this point and add the plans at a later time.
6. Click Continue to add plans.
Alternatively, click Plans in the left navigation pane.
7. Select the plans that are to be associated with the API package.
You can save the API package at this point and add APIs at a later time.
8. Click Continue to add APIs.
Alternatively, click APIs in the left navigation pane.
When you add an API to a package for monetization, the API key authentication mechanism is automatically added to the IAM policy at API level. If the API already contains an IAM policy that has two authentication mechanisms with the AND condition, then the condition will be switched to OR. This ensures the monetization is supported when certain consumers access the API by just using the API key.
9. Type characters in the search box and click the search icon to search for the required APIs.
A list of APIs that contain the characters specified in the search box appears.
10. Select the required APIs to be associated with the Package and click + to add them.
You can delete the APIs from the package by clicking the Delete icon adjacent to the API in the API list.
11. Click Save.