Setting up Monetization

After every step illustrated below, ensure clicking the Save

icon; else the changes won't be saved.

Creating an API Project

Refer the Manage API Projects section to create an API Project.

Click the 

Creating a Monetization Limit Check policy

Click the Policy Configurations

1. Create a Monetization Limit Check policy.

   

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

   

   
   
   

2. Click the environment in which configuration needs to be set, select the Enabled option and click the save

   

    icon to save the policy.
   
   

   

Adding the policy to the Project Level Policies repository

1. Click the Project Level Policies 

   

    icon and go to the Proxy Response tab.
2. Click the Add 

   

   button and select the Monetization policy from the dialog box
3. Click OK to add the Monetization policy and click the Save icon to apply the changes.

Creating a product and Adding to the Monetization Project

Go to the Applications page and perform the following in the Products 

1. 1. Add a new API Product
      
      

      

      
      
      
   2. Provide the values as per requirement and click the Edit 

      

       icon in the Projects in product section to add the project added in Step 1.
      
      

      

      
      
      
   3. In the Add/remove projects section, select the new project created and click the OK 

      

      icon.
      
      

      

   4. Click the Save 

      

      icon to save the product configuration.
      
      

      

Configuring Monetization

Click the Monetization tab under the Product Configuration section.

Adding a Transaction Recording Policy

1. Expand the Transaction Recording Policy section and click the Add 

   

    button.
   
   

   

   
   
   
2. Add the parameters to be checked to the context variables and click OK.
   
   

   

   
   
   
3. Click the Add button in the Transaction Success Criteria section and add an attribute named "Status" to configure success criteria. Select Checking Criteria as "EQUALS".
   
   

   

   
   
   
4. Click the Save icon to save the configuration.
   
   

Adding Product rate plans

1. Expand the Rate Plan section, click the Add icon and add a Rate Plan ID. Click OK.
   
   

   

   
   
   
2. Under the Plan Details tab, select the "Metering Type" from the options UNIT, STAIR_STEP, and VOLUME, specify the "Duration", "Renewal Term" and the "Payment Due" details. Specify the Freemium Package (optional); else select "NO".
   
   

   

   
   
   
3. In the "Rate Plan Rates" tab, click the Add 

   

   icon to add the Rate for transactions depending on the "Metering Type".
   
   

   

   
   
   
4. Click the Fees tab and enter all other fees details.
   
   

   

   
   
   
5. Click the Save icon to save the product.
   
   

   

   
   
   
   

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 icon to save the client details.
   
   

   

Creating Client Subscription with the Monetization product

Click the Client Subscriptions

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

   

   
   
   
2. Provide the subscription details and click the Edit

   

    button in the Subscribed Products property.
   
   

   

   
   
   
3. Use the "Subscribed Products" option to select the product and the rate plans associated with the product.
   
   

   

   
   
   
4. Click the Save 

   

   icon to save the Client Subscription.
   
   

   

1. Subscribed Products in client-subscription cannot be changed after adding the product and setting the rate-plans. Client subscription should not be edited if it is already being used.

2. Individual rate-plans should not be changed after publishing the rate-plan. Only the end date of a published rate-plan can be changed (only if it was previously left as null).

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. In the Group by drop-down, select the options below as required:

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

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

  

  Select other filtering options such as Chart Type, Server Group Date etc. as per requirement.

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

Click Refresh 

 icon after changing the Group By options above to retrieve the respective graphs.