Access monetization in Edge

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation. info

Access monetization using the UI or the monetization API, as described in the following sections.

Access monetization using the UI

Access monetization, as described below.

Edge

To access monetization using the Edge UI:

  1. Sign in to https://apigee.com/edge.
  2. Switch to an organization that has monetization enabled.
  3. Under Publish > Monetize, access the monetization features described in the following table.
    Monetization Feature Description
    Companies Group your developers into companies.
    Credits Issue credits for developers.
    Developer categories Group developers or companies with similar characteristics.
    Notifications Set up notifications using notification templates and webhooks.
    Organization profile Perform the following tasks:
    Product Bundles Create API product bundles to bundle your API products
    Rate Plans Create and publish rate plans that developers can purchase to use your APIs
    Reports Create reports for billing, prepaid balances, revenue, or variance
    Webhooks Set up notifications using webhooks

Classic Edge (Private Cloud)

To access the monetization features using the Classic Edge UI:

  1. Sign in to http://ms-ip:9000, where ms-ip is the IP address or DNS name of the Management Server node.
  2. Switch to an organization that has monetization enabled.
  3. Access the monetization features described in the following table.
    4. Monetization Menu Description
    Admin > Notifications Set up notifications using notification templates
    Admin > Organization Profile Perform the following tasks:
    Admin > Webhooks Set up notifications using webhooks
    Monetization > Adjustments Make adjustments to traffic details
    Monetization > Credits Issuing credits for developers
    Monetization > Refunds Post refunds to developers for purchase transactions
    Monetization > Monetization Reports Create reports for billing, prepaid balances, revenue, or variance
    Publish > Companies Group your developers into companies
    Publish > Packages Create API packages to bundle your API products
    Publish > Products Create a transaction recording policy for each API product you want to monetize

Access monetization using the API

The base path of the monetization API is https://api.enterprise.apigee.com/v1/mint. The URL of all monetization requests starts with the monetization base path followed by the path of the target resource.

For a complete list of monetization APIs, see Monetization API.

The following provides an example:

curl -H "Content-Type: application/json" -X POST -d \
'{
 "url":"www.testoperator/termsandconditions",
 "tncText":"Sample text for the T&C",
 "version":"1.1",
 "startDate":"2013-06-24”
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
-u email:password

Examples of the monetization APIs are provided using cURL throughout the documentation. You can copy and paste the sample commands into your command-line terminal. After you copy and paste the command to your terminal, you must replace the variables in the command with information for your Apigee Edge account. For example, in the example above, you would need to replace the following variables:

  • {org_name}: The name of your organization.
  • email: The email address for your Apigee Edge account.
  • password: The password for your Apigee Edge account.