Monetization overview

As an API provider, you need an easy-to-use and flexible way to monetize your APIs so that you can generate revenue for the use of your APIs. Using monetization in Apigee Edge, you can create a variety of monetization plans that charge developers (or pay them through revenue sharing) for the use of your APIs.

To access APIs, app developers send an API key with requests, which uniquely identifies the developers and their apps in Edge. As an API provider, this allows you to track who is calling your APIs and charge app developers for their usage. You can also measure the usage data through analytics and generate reports.

The following sections introduce key features of monetization:

Watch an introductory video to learn more about monetization.

Key components of monetization

To monetize your APIs, you define the components shown in the following figure.

The monetization components are summarized in the following table. The monetization components are scoped to your organization, the top-level container for all the objects (including APIs and developers) defined in your Edge account.

Component Description
API product Collection of related RESTful APIs presented to developers as a bundle. Defines access limits, API key approval method, and other configuration for all bundled API proxies. For more information, see What is an API product?
API package Bundle one or more API products into a single monetized container. For more information, see What is an API package?
Transaction recording policy Rules that are used to determine which API calls are determined to be a transaction for monetization. For example, if the response.reason.phrase flow variable has a value of OK, that counts as a transaction. For more information, see What is a transaction recording policy?
Rate plan Charges that are incurred for the use of APIs offered in a monetized API product bundle. For example, you can charge monthly flat rate or charge a specific rate per transaction. For more information, see What is a rate plan?

Integration of monetization in your developer portal

Monetization also provides a developer portal through Edge. The developer portal includes monetization-related content that an API provider publishes for consumption by a developer, such as a catalog of available API product bundles and rate plans for each product bundle. As an API provider, you can take advantage of the monetization features in the developer portal or integrate monetization features into your own developer portal.

Apigee supports the processing of credit card payments using Worldpay in the developer portal. Monetization features in the developer portal integrate with the Worldpay payment system using a Drupal module, which enables your developers to make credit and debit card payments, set up prepaid and recurring payment plans, and set up other billing options. To set up credit card payment processing using Worldpay, you must have a Worldpay account and enable and configure the required Monetization and Worldpay modules, as described in Enabling and configuring Monetization and Worldpay modules in the developer portal.

For more information about integrating monetization in your Drupal-based develper portal, see Overview of monetization in the developer portal.