Cloud-native API Administration with Red Hat 3scale API Management
After completing this section, you should be able to create application plans and set rate limits for APIs.
Application plans are sets of access rights that allow users to define different rules for consumers of managed APIs. You can use application plans to set rate limits, enable features, resources, and methods for API users.
To create an application plan from the GUI:
On your product detail page, navigate to .
Click the to go to the section.
Set a name and a system name for the new plan. System names must be unique because they are used by Red Hat 3scale API Management as unique identifiers.
Select the check box if applications need to be evaluated by the administrator before they become available.
To set an application plan as default:
On your product detail page, navigate to .
Use the drop-down list below , select the plan you want to set as default.
3scale API Management allows users to monetize APIs by the definition of subscription fees for accounts, products and backends. Pricing tiers are used on application plans for creating paid plans.
Pricing models are strategies that enable customers to pay for the return value they can get. Pricing models can be configured for volume, functionality and resources.
Volume usage, you can assign global request count for calls on products or at the method level.
Functionality, depending on the tier some features of the product can be enabled or disabled.
Resources, you can create tiers for resource levels such as: bandwidth, number of users or transaction values.
On your product page, navigate to
Click on an application plan name.
Navigate to where you can define pricing rules for total requests or in a more granular way at the method level.
You can define pricing rules for products in the section. In this section you can configure a range of requests and assign costs per unit.
You can use the toolbox client to create application plans, this is useful for automation or integration with third party applications.
To create an application plan using the toolbox CLI use the application-plan create option and set the
--approval-required, --cost-per-month, --setup-fee, --trial-period-days for the tenant application plan.
In this example the tenant name is: 3scale-tenant and the application plan is: new_plan.
[student@workstation ~]$ 3scale application-plan create -p \
--approval-required=false --cost-per-month=10.00 --setup-fee=1.0 \
-t "new_plan" --trial-period-days=15 3scale-tenant 2 "Example Plan"
Created application plan id: 9. Default: false; Disabled: falseRate limits enable you to restrict access to API resources, products, and backends. Application plans are also used to configure rate limits.
References
For more information, refer to the Application Plans chapter in the Red Hat 3Scale Api Management Admin Portal Guide at https://access.redhat.com/documentation/en-us/red_hat_3scale_api_management/2.11/html-single/admin_portal_guide/index#application-plans
