Setting up Monetization

Creating an API Project

Refer the Manage API Projects section to create an API Project. Click the Details icon of the project under the Actions column to open it.

Creating a Monetization Limit Check policy

1. Click the Policies tab on the left navigation panel of the API Projects screen.

2. In the Policy palette, select the Monetization Limit Check policy.

   

3. Provide a name for the policy and click Add.
   

   

   Refer to the Adding a Policy the Monetization Limit Check policy section to understand the policy configuration.

4. Click the environment in which the configuration needs to be set, ensure that the Enabled option is selected, and click the Save icon to save the policy.

   

Adding the policy to the Project Level Policies repository

The policy added to the project will be available in the Project policy scope tab, which can be used on the project-level.

1. Go to the Project policy scope tab and click the Policies button.

2. Drag the Monetization limit check policy to the Proxy Response scope.

   

3. Click the More actions icon ontheProxy response scope and select the server group.

   

4. Click Save to apply the changes.

   

Creating a product and adding to the Monetization Project

1. Go to Applications > Products.

2. Select the server group and click the Add button to add a new API Product

   

3. Provide a name and other values as per requirement. Click the API Projects drop-down and select the project created at the beginning of this section.
   

   

4. Click the Save button to save the product configuration.

   

Configuring Monetization

Go to the Monetization tab and perform the actions in the section below.

Adding Product rate plans

In the Rate Plan tab under the Monetization panel,

1. Click the Add icon and add a Rate Plan ID. Click OK.

   

2. Click the Details icon under the Actions column of the newly added Rate plan.

   

Standard Rate Plan

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

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

2. In the Plan Details tab, select the options below:

   1. Revenue Model: Ratecard.

   2. Rating Parameter: Choose 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.

   3. Metering Type: Choose from the options UNIT, STAIR STEP, and VOLUME, and specify the "Duration", "Renewal Term" and the "Payment Due" details.

   4. Freemium Package: Specify if it is applicable; else select "No".

      

3. Under the Rate Plan Rates section, click the Add button to add the Rate for transactions depending on the "Metering Type".

   

4. Go to the Fees tab next to the Plan Details tab and enter fee details.

   

5. Click the Save icon to save the product.

   

Adding a Transaction Recording Policy

1. Go to the Transaction Recording Policy tab next to the Rate Plan tab and click the Add transaction recording policy button.

   

2. In the Transaction Status dialog box, add the parameters to be checked to the context variables and click Update.

   

3. Provide the success criteria and the value of the Transaction Status parameter. Select Checking Criteria as "EQUALS" or "MATCHING" depending on the requirement.

   

4. In the Custom attributes panel, add the attributes that need to be monitored for invoice generation.

   Use this option if some attribute has to be added to the rating parameter while using custom variables.

5. Click Save to save the configuration

   

Creating Client

1. Click the Clients icon on the left pane in the Applications page, click the Add button, and provide a valid email ID.

   

2. Specify configuration details and click the Save button to save the client details.

   

Creating Client Subscriptions with the Monetization product

Click the Client Subscriptions icon present below the Clients icon and perform the following actions:

1. create a new client subscription by choosing the client added above.

   

2. Provide the subscription details and click the Edit button in the Subscribed Products property.

   

3. Select the products and the rate plans associated with the product.

   

4. Click the Save icon to save the Client Subscription

   

Verifying Monetization Setup

To verify whether monetization is enabled, the rate plan ID is set correctly and the limit was successfully executed, perform the following actions in the Analytics page.

Go to the Advanced tab in the Analytics screen. Click the Add button and select any of the options below from the Group by drop-down:

• MONETIZATION_ENABLED: To verify whether Monetization is enabled or not.

• MONETIZATION_SUCCESS: To verify whether the Monetization Limit Check is applied correctly or not.

• API_APPLICATION_RATEPLAN_ID: To verify whether the rate plan ID is set correctly or not.

The green color in the graph represents successful completion of the above tasks and the blue represents failure.