A group of projects can be gathered and made available for clients by adding them to a product. This product will later be associated with a subscription to client(s), which is secured by an API Consumer Key.
This section illustrates how to add a product, how to add a project to a product and also gives descriptions of the properties available in the Products section.
Creating a Product
Adding a new product
Click the Add icon on the upper-left part of the Products tab in the Applications screen
Provide a name in the Product ID text field
Click OK to add the product.
Figure 1: Dialog box to add product with a Product ID
The product configuration screen gets displayed.
After configuring values and after adding project(s) to a product, click the Save icon on the upper-right part of the screen to save the product.
The name of the product turns green after it is saved.
Adding Product Configuration
Provide the required details under the Product Configuration tab.
Figure 2: Product Configuration attributes
Attribute
Description
Product name
Provide a name for the product that helps to identify the behavior of the product.
Description
Provide a brief description of the product.
Server Groups
Choose Server Groups from the options in the drop-down list.
Select the Private or Public option depending on the nature of access required. The products which are made publicly accessible will be made available for subscription in the Developer portal.
Key Approval
The Key Approval can be made automatic or manual.
Automatic: In case of automatic approval, subscription keys will be generated instantly when a developer subscribes to a product from the Developer portal.
Manual: With Manual approval, the keys are available in the portal only after they are explicitly permitted by the API administrator via client subscription. Refer to the Managing Key Approval section under Client Subscriptions / Applications page to do this.
Quota
Provide the values that set a limit of requests that can be processed for the product. Provide a number and select the minute/hour/day/month from the drop-down list.
The extent of the free period. Select one of the following radio buttons:
By Quantity: The free period is based on a quantity specified in the Volume field.
By Duration: The free period is based on a time interval specified in the Freemium Duration field.
Whichever comes first: The free period ends when either the quantity in the Volume field or the time interval in the Freemium Duration field is reached, whichever happens first.
No: This is not a Freemium plan. This is the default.
Freemium Volume
The volume of transactions (or volume pertaining to a custom attribute recorded in the transaction recording policy) for which developers are charged. The volume is measured across all products in the API package. Enter a volume number, such as 5000. This means that when developers start the plan, they are not charged for the first 5000 transactions (or for the first 5000 uses of a custom attribute-related item). This field is enabled only if you select "By Quantity" or "Whichever comes first" in the "Freemium Package?" field.
Freemium Duration
The time interval during which developers are not charged. Enter a number and select a time period, for example, 1 Month. This means that developers are not charged for 1 month following the start date of the purchased plan. This field is enabled only if you select "By Duration" or "Whichever comes first" in the "freemium Package?" field.