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

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.

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.)

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:

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):

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:

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).

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:

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:

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.