Monetization is available on Apigee Edge paid plans only. To enable monetization in your environment, contact Apigee Support.
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 those APIs. Monetization, a feature of Apigee Edge Developer Services, solves those requirements.
Using monetization, you can create a variety of rate plans that charge developers for the use of your APIs bundled into packages. The solution offers an extensive degree of flexibility: you can create pre-paid plans, post-paid plans, fixed-fee plans, variable rate plans, "freemium" plans, plans tailored to specific developers, plans covering groups of developers, and more.
In addition, monetization includes reporting and billing facilities. For example, as an API provider, you can get summary or detailed reports on traffic to your API packages for which developers purchased a rate plan. You can also make adjustments to these records as necessary. And you can create billing documents (which include applicable taxes) for the use of your API packages and publish those documents to developers.
You can also set limits to help control and monitor the performance of your API packages and allow you to react accordingly, and you can set up automatic notifications for when those limits are approached or reached.
Monetization provides an API that is integrated into Edge API Services and a management user interface for API providers that is integrated into the Edge management UI. The management user interface calls the monetization API.
Monetization also provides a developer portal through Edge Developer Services. The developer portal includes monetization-related content that an API provider publishes for viewing by a developer, such as a catalog of available API packages and rate plans for each package. 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.
Edge's monetization feature enables you to monetize your API products that are bundled into packages.
In Edge, an API product is a collection of API resources that are presented to developers as a bundle. An API resource is a RESTful architecture concept – it represents any network-accessible entity or functionality, for example, the Twitter timeline, Google Maps image tiles, or Facebook posts. If you want to monetize one or more resources, or see transaction records for those resources, you need to package them in an API product.
Think of API products as your product line available to developers. You can create different products to provide features for different use cases. So instead of just giving developers a list of resources, you can bundle specific resources together to create a product that solves a specific user need. For instance, you can create an API product that bundles a number of mapping resources to let developers easily add maps to their applications. The API resources bundled in an API product can come from one or more APIs, so you can mix and match resources to create specialized feature sets. To learn more about API resources and API products, see What is an API product?
An API package (also called a monetization package) is a collection of API products that is presented to developers as a bundle, and typically associated with one or more rate plans for monetization. Think of API packages as the revenue generating parts of your product line available to developers.
Your API products and packages are kept in your organization, a container for all the objects (including APIs and developers) defined in your Edge account.
For help, see Apigee Customer Support.
The Edge configuration team does the initial setup of monetization for your organization. After the configuration team creates the initial configuration, there are a number of things you need to do to further set up and use monetization. Learn what the configuration team sets up and what further steps you need to take in Set up monetization.
Help or comments?
- Something's not working: See Apigee Support.
- Something's wrong with the docs: Click Send Feedback in the lower right.
(Incorrect? Unclear? Broken link? Typo?)