Was this helpful?

How to begin

After the initial set up (see Set up monetization), you can start using monetization. There are some basic tasks that you need to perform before you perform any other monetization-related tasks. The basic tasks are:

  • Edit a profile that contains information about your organization. See Edit the organization profile for details.
  • Add subsidiaries and sub-organizations. Do this only if your organization is a group organization, that is, it has subsidiaries or sub-organizations that it wants to differentiate in its rate plans and transaction records. See Add subsidiaries and sub-organizations for details.
  • Add terms and conditions (T&C's) that developers must accept before they can purchase your rate plans. See Specify terms and conditions for details.
  • Add or delete currencies to or from the currencies initially set up for your organization. See Manage supported currencies for details.
  • Add bank account information for billing and invoices. You only need to do this if you want monetization to generate billing documents and you plan to support postpaid developers. See Add bank accounts for details.

In the next topic, you'll learn how to edit (and otherwise manage) your organization profile. So that's the place to start.

You have two ways to interact with monetization. You can issue calls to the monetization API or you can make selections and entries in the management UI — monetization adds menus to the management UI to request monetization-related services. The Toolkit section in each topic shows you how to make requests using both techniques, if available (some actions can only be requested using API calls).

Toolkit

The goal of the Edit the organization profile topic and succeeding topics is to enable you to interact with monetization either through the management UI or through API calls.

The API typically gives you more extensive access to monetization resources.

If you use the UI: The instructions show you the selections you need to make to perform various tasks. For example:

To edit the organization profile:

  1. Login to enterprise.apigee.com. This opens the management UI.
  2. On the Admin tab, select Organization Profile.

    This opens the Organization Profile page.

     

  3. Click Edit on the Organization Profile page, and enter the following information.
    Field Description
    Operator/Organization
    Operator/Organization Structure

    Indicates whether you are using monetization as a group operator or organization (with subsidiaries or sub-organizations) or as an individual operator or organization (without subsidiaries or sub-organizations). This field is pre-set by the configuration team when they set up monetization for your company. The field reflects your organization structure for monetization (not necessarily your actual registered organization structure). You only need a group structure if you want to differentiate your rate plans or transaction records by subsidiary or sub-organization.

    Name and Information
    Operator/Organization Name

    The name of your organization.

Detailed descriptions are provided for each field in the UI.

If you make direct calls to the API: The instructions include sample API calls displayed as simple cURL commands. You should be able to copy and paste these commands into your command-line terminal.

Here's 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 myname:mypass

After you copy and paste the command to your terminal, you must replace the following variables in the command with information for your Apigee Edge account:

  • {org_name}: The name of your organization.
  • myname: The username for your Apigee Edge account.
  • mypass: The password for your Apigee Edge  account.

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

Get help

For help, see Apigee Customer Support.

Next steps

Learn how to edit your organization profile in Edit the organization profile.

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.