Products

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.

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.

Creating a Product

Adding a new product

1. Click the Products tab, select the respective Server group from the drop-down, and click the Add button.
   

   

2. Provide a name in the Product ID text field and click OK to add the product.

   

   
   The product configuration screen gets displayed (refer to the next section).
   

   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
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, which are accessible with or without signing in based on the dev portal admin preferences settings.
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 page to do this.
Scopes	Comma-separated scopes which are used while generating OAuth Access Token for the product. Example READ,WRITE,DELETE,GET,POST
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.

Adding Projects to a product

To add projects to a product, perform the following actions in the Configuration tab:

1. Select the projects from the API Projects drop-down.
   

   

   

   Multiple projects can be added and removed by selecting and clearing the respective check boxes against the corresponding projects.

2. Click the Save button on the upper-right part of the screen 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).

Ensure clicking the Save button after configuring a policy so that the policy gets saved to the server.

Using the policy in a project

• After adding the product, it can be used by the projects from the Policies screen in the respective project.
• After saving the product, to edit the properties of the product, make the required changes in the configuration panel and then click Save again.

More actions

This option helps to see the organizations in which the product is part.

Click the More actions icon on the upper-right part of the screen and click the Organizations option. 

It lists the organizations of which the product is part of. Click Refresh to load if not updated.

Removing products

Click the Delete button against the product that needs to be deleted. 

If the product is added to any of the following, remove it from the corresponding section before trying to delete the product:

• Organization
• Client Subscription

While trying to remove a product which is assigned to any of the above section, an alert appears on the upper-right part of the screen.

To delete multiple products, refer to the Utilities section.

Monetization

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

Rate Plan

To add a Rate plan,

1. Click the Add button at Monetization > Rate Plan. Provide a name and click Add.
   

   

2. Click the Detais icon against the newly added rate plan name to configure the plan.

   

3. Provide the values for the properties and click Save. 
   

   

Standard Rate Plan

In the Standard rate plan, only the provider and the user are involved and hence the developer does not get revenue.

Only the Ratecard revenue model is valid for the Standard rate plan.

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.
• None: 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.

Developer Rate Plan

In the Standard rate plan, the developer, provider, and user are involved and thereby the developer gets a share from the provider for the APIs developed .

Under the Rate plan Configuration section, provide a unique name, and click the Rate plan scope drop-down and select "Developer".

In the Plan Details tab, choose the Rating Parameter from the options "Volume" and "Custom Variable". 

If CUSTOM VARIABLE is selected, please specify the variable/parameter to be used for charging the user. For CUSTOM VARIABLE, the parameter specified has to be added to the custom attributes section in the transaction recording policy.

Unlike the Standard RAte plan scope, all Revenue Models listed below are applicable for the Developer rate plan:

• Ratecard
• Revshare
• Revshare Ratecard

Each of these revenue models is explained in the following sections:

Ratecard Revenue Model

In the Plan Details tab, select the below options for the Ratecard revenue model:

• 1. Metering Type: Choose from the options UNIT, STAIR STEP, and VOLUME, and specify the "Duration", "Renewal Term" and the "Payment Due" details.
  2. Freemium Package: Specify if it is applicable; else select "No".
  3. Under the Rate Plan Rates section, click the Add icon to add the transaction rate depending on the "Metering Type".

Transaction Recording Policy

To add a Transaction Recording Policy,

1. Click the Add transaction recording policy button at Monetization > Transaction Recording Policy.

   

2. Provide the values and click Save.
   

   

To know more, refer to the Adding a Transaction Recording Policy section.