Products

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

1. Click the Add

   

    icon on the upper-left part of the Products 

   

   tab in the Applications screen
2. Provide a name in the Product ID text field

3. 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.

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. Please refer to the Creating a Server Group for Project Deployments section in the Quick Start page to add an Environment.
Access	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.
Scope	Comma-separated scopes which are used while generating OAuth Access Token for the product. Example READ,WRITE,DELETE,GET,POST

Adding Projects to a product

To add projects to a product,

1. Click the Edit

   

    icon (see the figure above) in the Projects in Product tab in the API Projects property to add projects to the product.
2. Select the required project from the Add/Remove Projects tab that replaces the Add/Remove Projects tab for the time being.
3. Click the Tick 

   

    mark in the Add/Remove Projects tab to add products.
   
   

   

   
   Figure 3: Editor to add existing projects to the product
   
   
4. Click the Save button to apply the changes after adding project(s) to a product.

To discard the changes before saving, click the Reset 

 icon next to the Save icon.

The new product gets added with the choice of project(s) and the preferred environment(s).

• After saving the product, to edit the properties of the product, make the required changes in the configuration panel and then click Save again.
• To remove a product completely, select the product under the Products tab in the left navigation panel and click the Remove

  

  icon next to the Add icon.
  • To remove a product that is already added to a Client Subscription, it has to be removed from the subscription first.

Monetization

Helps to configure product rate-plans and to add a transaction recording policy.

Transaction Recording Policy

To know how to add a policy, refer to the Adding a Transaction Recording Policy section.

Rate Plan

To know how to add a policy, refer to the Adding Product rate plans section.

Freemium Package

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.

Refer to the Setting up Monetization section to know how to configure monetization.