Was this helpful?

Introduction

You use the management UI or the management API to perform many developer management tasks such as creating a developer and getting or setting a developer's status. However, there are a number of developer-related tasks that you can perform using monetization.

For example, monetization adds tools to the Developers section of the management UI that you can use to view (and edit) details of your developers such as their company name, any additional users they have assigned to their company, and their company address and tax information. You can also change their billing type from prepaid to postpaid.

In addition, you can use monetization to create and otherwise manage developer categories. This enables you to create a rate plan that applies specifically to a category. (See Create rate plans for instructions on how to create a developer category rate plan.) You can create a developer category rate plan only if developer categories have been previously created.

After you create a developer category, you can add developers to the category. You can use the management UI or the management API (and not to a monetization API) to do that.

You can then publish the rate plan. All developers in that category are then able to see the plan (and the API package) listed in the catalog in the developer portal, starting on the effective date of the plan.

Viewing and editing developer information using the UI

To view a list of your developers and edit their information:

  1. Click Developers in the Publish tab.

    This opens the Companies and Developers page.

  2. Select a developer from the list.
  3. In the Details page for the selected developer, click Edit to open the Edit Company page for the developer.

    Developers initially enter the company details on the Settings page of their developer portal. The company name and address are mandatory — developers must enter that information before they can purchase a rate plan. All other details are optional, such as the company registration ID, tax registration ID, and telephone number.

  4. Edit the company details on the Edit Company page, as needed. If you support prepaid and postpaid billing types for your developers, you can change the billing type by selecting from the Billing Type drop-down menu. To specify a developer category for a developer, select a category from the Developer Category drop-down menu. (See Create developer categories for instructions on creating developer categories.)
  5. Click Save to save your updates (or Cancel to cancel).

Creating a developer category using the UI

  1. Click Developer Categories in the Publish tab.

    This opens the Developer Categories page.

  2. Click +Add Developer Category.
  3. Enter a name for the new category and a short description. Then click the checkmark in Action column to accept the update (or the minus sign to cancel).

  4. Repeat steps 2 and 3 for each developer category you want to add.
  5. Click Save to save the developer categories (or Cancel to cancel).

Creating a developer category using the API

To create a developer category, issue a POST request to /organizations/{org_name}/developer-categories.

When you issue the request, you specify:

  • The name of the developer category.
  • A description of the developer category.

For example:

$ curl -H "Content-Type:application/json" -X POST -d \

 '{
    "name": "Gold",
    "description": "Gold category"   
  }' \
POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories"  \
-u myname:mypass

The response should look something like this:

{
  "description" : "Gold category",
  "id" : "aa6f960a-d9fd-416e-be39-c071418aabd0",
  "name" : "Gold"
}

Retrieving developer categories using the API

You can retrieve a specific developer category or all developer categories in an organization. To retrieve a specific developer category, issue a GET request to /organizations/{org_name}/developer-categories/category_id}, where {category_id} is the identification of the developer category (the ID is returned in the response when you create the developer category). For example:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \
-u myname:mypass

To retrieve all API developer categories for an organization, issue a GET request to /organizations/{org_id}/developer-categories. For example:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories" \
-u myname:mypass

Updating a developer category using the API

To update a developer category, issue a PUT request to /organizations/{org_name}/developer-categories/{category_id}, where {category_id} is the identification of the category to be updated. When you make the update, you need to specify in the request body the updated settings and the ID of the developer category. For example, the following request updates the description of a developer category (the update is highlighted):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
    "id": "aa6f960a-d9fd-416e-be39-c071418aabd0",
    "description": "Premium category"   
  }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \
-u myname:mypass

Deleting a developer category using the API

To delete a developer category, issue a DELETE request to /organizations/{org_name}/developer-categories/category_id}, where {category_id} is the identification of the developer category to be deleted. For example:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \
-u myname:mypass

Adding a developer to a developer category using the API

You can add a developer to a developer category when you create the developer using a POST request to the management API /organizations/{org_name}/developers. If the developer is already created, you can add the developer by issuing a PUT request to /organizations/{org_name}/developers/developer_id, where {developer_id} is the identification for the developer (the identification is returned with the developer is created). In either case, you specify the developer category as an attribute in the request body. For example, the following request adds an already-created developer to the developer category named "Gold category" (the developer category-related specifications are highlighted).

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
   "email" : "dev1@myorg.com",
    "developerId" : "K4jW2QLjZ1h8GFA8",
    "firstName" : "Dev",
    "lastName" : "One",
    "userName" : "devone",    
    "attributes" : [ {
      "name" : "MINT_REGISTRATION_ID",
      "value" : "dev1"
    }, {
      "name" : "MINT_DEVELOPER_LEGAL_NAME",
      "value" : "DEV ONE"
    }, {
      "name" : "MINT_DEVELOPER_TYPE",
      "value" : "TRUSTED"
    }, {
      "name" : "MINT_BILLING_TYPE",
      "value" : "PREPAID"
    }, {
      "name" : "MINT_IS_BROKER",
      "value" : "TRUE"
    }, {
      "name" : "MINT_DEVELOPER_CATEGORY",
      "value" : "aa6f960a-d9fd-416e-be39-c071418aabd0"
    }, {
      "name" : "MINT_DEVELOPER_ADDRESS",
      "value" : "{
                   "address1": "Dev One Address",
                   "city": "Pleasanton",
                   "country": "US",
                   "isPrimary": "true",
                   "state": "CA",
                   "zip": "94588"
                }"
    }, {
      "name" : "MINT_DEVELOPER_CATEGORY",
      "value" : "aa6f960a-d9fd-416e-be39-c071418aabd0"
    }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/K4jW2QLjZ1h8GFA8" \
-u myname:mypass

Developer category configuration settings

The following developer category configuration options are exposed to the API:

Name Description Default Required?
name

The name of the developer category.

N/A Yes
description

A description of the developer category.

N/A Yes

Managing developer roles using the API

You can create roles using monetization APIs. This enables you to establish roles for your partners. For example, you can establish administrator and application developer roles for a partner. Those roles can then be assigned to specific partner employees.

Creating a developer role

To create a developer role, issue a POST request to organizations/{org_name}/developer-roles. When you make the request, you need to specify in the request body the name and description of the role and the identification of the organization. For example:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "appDeveloper",
   "description": "App Developer",
   "organization": {
       "id": "{org_name}" 
   }  
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u myname:mypass

Retrieving developer roles

To retrieve developer roles, issue a GET request to organizations/{org_id}/developer-roles. For example:

$ curl -H "Accept:application/json" -X GET \
"https:// api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u myname:mypass

The response should look something like this (only part of the response is shown):

{
  "description" : "App Developer",
  "id" : "appdeveloper",
  "name" : "appDeveloper",
  "organization" : {
   ...
  }
}

Developer role configuration settings

The following developer role configuration options are exposed to the API:

Name Description Default Required?
name

The name of the developer role.

N/A Yes
description

A description of the developer role.

N/A Yes

Retrieving the tax rate for a developer using the API

You can get the current tax rate for a developer by issuing a GET request to organizations/{org_name}/tax-engine. When you make the request, you need to specify the identification of the developer as a query parameter. For example:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tax-engine?developerId=dev7@myorg.com" \
-u myname:mypass

The response should look something like this:

0.09

Performing other developer-specific tasks using the API

Many of the monetization-reralted tasks that you can perform for an organization, such as creating rate plans or creating notification conditions, you can also perform for an individual developer. For example, you can create a bank account for a specific developer or generate a revenue report for a specific developer.

The following table lists developer-specific tasks that that you can perform using monetization APIs. The table also lists where you can find detailed instructions on performing these tasks.

Task Where the find instructions
Create a developer bank account

"Adding a bank account" section in Add bank accounts.

Retrieve terms and conditions accepted by a developer

"Retrieving terms and conditions accepted by a developer" section in Specify terms and conditions.

Retrieve developer bank accounts

"Retrieving bank accounts" section in Add bank accounts.

Retrieve API packages accepted by a developer

"Retrieving API packages accepted by a developer" section in Create API packages.

Create a developer rate plan

"Creating a rate plan" section in Create rate plans.

Retrieve rate plans available to a developer

"Retrieving rate plans" section in Create rate plans.

Retrieve rate plans available to a specific developer that contain a specific product

"Retrieving rate plans" section in Create rate plans.

Retrieve only accepted developer rate plans

"Retrieving rate plans" section in Create rate plans.

Issue credit to a developer

"Issuing a credit" section in Manage credit .

Set a credit limit for a developer

"Setting a credit limit" section in Manage credit .

Retrieve a developer credit limit

"Retrieving a credit limit" section in Manage credit .

"Top up" (adding an amount to) a developer’s prepaid balance

"Topping up a prepaid balance" section in Manage prepaid balances.

Retrieve a developer's prepaid balance

"Retrieving a prepaid balance" section in Manage prepaid balances.

Specify a notification condition for a developer

"Specifying a notification condition and action" section in Set up event notifications and alerts.

Retrieve billing document months for a developer

"Retrieving billing document months" section in Create billing documents.

Create report definitions for a developer

"Creating a report definition" section in Create reports.

Retrieve report definitions for a developer

"Retrieving report definitions" section in Create reports.

Get help

For help, see Apigee Customer Support.

Next steps

Learn how to generate reports, such as billing reports that allows you to view the activity of developers for a single billing month. See Create reports.

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.