Was this helpful?

About monetization

When monetization is activated for your organization, monetization features are automatically added to your Developer Services portal. With monetization activated, developers complete additional information in their user settings. In particular, they must select a rate plan you've set up, which includes agreeing to your terms and conditions. Monetization also give developers self-service access to billing and reports, product catalogs, and other monetization-specific settings.

Monetization support on the developer portal is controlled by Drupal modules. To enable monetization, you first enable and configure the required modules. After enabling these modules, the Monetization menu entry is automatically added to the portal, as shown below:

Monetization also defines additional Drupal roles that give you finer control over access to monetization administration and functionality. The Monetization Administrator and Finance Administrator roles are pre-configured with access to specific monetization functionality, but you can change that access for any aspect of monetization by using the People > Permissions page from the Drupal administration menu.

The monetization features of the developer portal are integrated with the WorldPay payment system. With WorldPay, you can handle payments from credit cards and debit cards, set up prepaid and recurring payment plans, and set up more billing options.

Before you can enable monetization, you must have already set up a WorldPay account, and obtained the following information from WorldPay:

  • Installation ID
  • Secret key

For information on using monetization features, see The basics of monetization.

Configuring monetization on the developer portal

Use the following process to configure monetization:

  1. Set Up WorldPay, Paypal, or other monetization-compatible payment account.
  2. Create a Terms & Conditions page as described in Add and manage user accounts.
    Once created, the Terms & Conditions page URL on the portal is <siteURL>/legal.
  3. Enable the Drupal monetization modules, described below.
  4. Configure the connection to WorldPay, described below.
  5. (Optional) Enable recurring payments, described below.

Enable the Drupal monetization modules

To enable monetization on the developer portal, you have to enable the following modules:

Module Description
DevConnect Monetization Provides connection to Apigee's monetization services API.
DevConnect Monetization Payment Provides connection between Apigee's monetization services and WorldPay System.

To enable the monetization modules:

  1. Log in to your portal as a user with admin or content creation privileges.
  2. Select Modules in the Drupal administration menu.
  3. In the list of module categories on the left, select DevConnect Mint. This displays the monetization modules.
  4. Select only the DevConnect Monetization and DevConnect Monetization Payment modules to enable them. Do not select any other modules in the DevConnect Mint category.
  5. Select Save Configuration.
    The developer portal might prompt you with a message that it must enable additional modules. Ensure that you respond by enabling those modules.
  6. Select Configuration > Dev Portal Settings in the Drupal administration menu.
  7. On the Dev Portal Settings page, expand the Monetization Configuration area.
  8. Ensure that the Default Monetization Role is set to Monetization Administrator.
  9. The default setting for the cache clear interval is set to 600 seconds (10 minutes) by default. Change that value if you want to use a different interval.
  10. Leave the other settings unchanged for now.
  11. Save the configuration.

After you enable monetization, you will see two new items on your developer portal:

  • If you are logged in to the portal as an administrator, the Store item now appears in the Drupal administration menu. You use this item to configure the payment system used by monetization.
  • All developer portal users now see the Monetization menu entry in the portal menu. Developers use that menu item to manage payments on the portal.

Configure the connection to WorldPay

To configure the connection to WorldPay, you need the following information from WorldPay:

  • Installation ID
  • Secret key

To configure the connection to WorldPay:

  1. Log in to your portal as a user with admin or content creation privileges.
  2. Select Store > Configuration > Payment methods  in the Drupal administration menu. The Payment methods page appears.
  3. Select the Payment via WorldPay rule. The page Editing reaction rule "Payment via WorldPay" appears.
  4. Under Actions, select Enable payment method: Payment via WorldPay.
  5. Uncheck the box next to Use WorldPay installation password.
  6. In the appropriate locations, enter the following information from WorldPay:
    • Installation ID
    • Secret key
  7. Select Save.
    The developer portal should now allow developers to make payments through the Monetization menu item.

(Optional) Enabling recurring payments

Recurring payments require configuration both from WorldPay and on the developer portal. Before you enable recurring payment, you must ensure that your WorldPay account is configured to process them.

After ensuring that your WorldPay account can handle recurring payments, you can work with Apigee to enable them on your portal.

Add new comment

Provide your email address if you wish to be contacted offline about your comment.
We will not display your email address as part of your comment.

We'd love your feedback and perspective! Please be as specific as possible.
Type the characters you see in this picture. (verify using audio)

Type the characters you see in the picture above; if you can't read them, submit the form and a new image will be generated. Not case sensitive.