Send Docs Feedback

Adding developers to your organization

Developers access your APIs through apps. When the developer registers an app, they receive a single API key that allows them to access all of the API products associated with the app. However, developers must be registered before they can register an app.

Developers typically have several ways of registering:

In the Edge management UI, select Publish > Developers to open the Developers page. You can see the apps they've created and the keys assigned to the developer. From this page, you can also manage the developer's information or delete them from your org.

If you use the Developer Services portal, Apigee recommends that you log in to the portal as a portal administrator to manually create, edit, and delete developers on the portal, not in the Edge UI. When you add a developer through the administrator interface on the portal, you can set the developer's password for the portal and trigger an automated email message sent to the developer. Also, any changes made to the developer's account on the portal are automatically sent to Edge. When adding or modifying a developer through Edge, no email is sent to the developer and you cannot set the password for the developer on the portal. Therefore, the developer must reset their password on the portal before they can log in to the portal. For more information, see Add and manage user accounts.

Adding a developer manually using the Edge management UI

If you use the Developer Services portal, Apigee recommends that you create, edit, and delete developers on the portal itself, not in the Edge management UI. For more information, see Add and manage user accounts.

  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click Publish > Developers in the menu.
  3. Click the add (+) Developer button.
  4. Enter the first name of your developer.
  5. Enter the last name of your developer.
  6. Enter the developer's email. This the email address you use when sending keys and notifications to this developer.
  7. Add any custom attributes for the developer. For each custom attribute:
    • Click (+) Add Custom Attribute.
    • Enter the attribute name and value.
    For information about defining monetization attributes, see Defining monetization attributes.
  8. Select Save.
  9. If you are using the Developer Services portal, synchronize the portal with the changes to Edge as described below. When the new developer first logs in to the portal, they must use the password recovery process on the portal to set their portal password.

Editing a developer using the Edge management UI

If you use the Developer Services portal, Apigee recommends that you create, edit, and delete developers on the portal itself, not in the Edge management UI. For more information, see Add and manage user accounts.

  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click Publish > Developers in the menu.
  3. Click the developer's entry in the Developers page.
  4. Click Edit.
  5. Edit the developer's first and last name, as needed.
  6. Add or remove any custom attributes.

    For information about defining monetization attributes, see Defining monetization attributes.

  7. Select Save.
  8. If you are using the Developer Services portal, synchronize the portal with the changes to Edge as described below.

Deleting a developer using the Edge management UI

If you use the Developer Services portal, Apigee recommends that you create, edit, and delete developers on the portal itself, not in the Edge management UI. For more information, see Add and manage user accounts.

  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click Publish > Developers in the menu.
  3. Locate the developer to delete in the list of developers.
  4. If the number of Apps for the developer is zero, then the Delete button is enabled.
    • Select the Delete button to delete the user. 
    • Confirm that you want to delete the developer.
  5. If the number of Apps for the developer is not zero, then the Delete button is disabled. You must first delete all apps associated with the developer before you can delete the developer.
    • Click the developer's entry in the Developers page.
    • Under Apps on the developer's page, select the app name.
    • Select Delete on the app's page, and confirm the deletion.
    • After deleting all the developer's apps, you can delete the developer. 
  6. If you are using the Developer Services portal, synchronize the portal with the changes to Edge as described below.

Synchronizing the portal with developers modified using the Edge UI

If you are using a Developer Services portal to publish your APIs, changes made to developers through the Edge UI are not pushed down to the portal. Therefore, you must log in to the portal as a portal administrator and synchronize the portal with Edge for those changes to appear on the portal.

If you use the Developer Services portal, Apigee recommends that you create, edit, and delete developers on the portal itself, not in the Edge UI. For more information, see Add and manage user accounts.

To synchronize the portal with a developer added on Edge:

  1. Log in to your portal as a user with admin or content creation privileges.
  2. Select People in the Drupal administration menu.
  3. Select the Dev Portal Developer Sync button at the top of the page to pull down any developers added on Edge.

Grouping developers into companies

A company is a collection of developers managed as a single entity. A company can be any grouping that is appropriate to your organization such as business unit, product line, or division. Grouping developers into companies is useful when your need  to have multiple developers associated under a single corporate entity. For example, you may need to set up different companies for billing purpose.  However,  developers in your organization don't need to be associated with a company. Note that a developer is always a single entity, uniquely identified by the email element. If a developer is part of a company you'll see the Company name on the Developers page.

You can use the Companies API to set up a company group and the Company Developers API to add developers to the company.

Defining monetization attributes

When adding or editing developers in your organization, you can define one or more of the monetization attributes listed in the following table as custom attributes.

In order to subscribe to a rate plan, if the developer is not grouped with a company, then the following monetization attributes must be defined for the developer: MINT_DEVELOPER_ADDRESS and MINT_DEVELOPER_LEGAL_NAME.
Name Description
MINT_APPROX_TAX_RATE Approximate tax rate for the developer.
MINT_BILLING_TYPE Payment model used for billing. The value can be one of the following:
  • PREPAID - The developer pays in advance for the use of an API product. Funds are deducted from the developer's balance when the API product is used. The developer must maintain a prepaid balance sufficient to purchase the API product.
  • POSTPAID - The developer is billed monthly (through an invoice) for the use of API products. The developer pays for the use of API products based on the payment terms set by the plan(s) included on the invoice.
  • BOTH - Defaults to PREPAID.
MINT_COMPANY_ID Company ID, if applicable. For more information, see Grouping developers into companies.
MINT_DEVELOPER_ADDRESS

Address of the developer. Specify the following name-value pairs:

{
   "address1":"Dev One Address",
   "city":"Pleasanton",
   "country":"US",
   "isPrimary":true,
   "state":"CA",
   "zip":"94588"
}

 

Note: This attribute is required if the developer is not grouped with a company and wants to subscribe to a published rate plan.

MINT_DEVELOPER_CATEGORY Developer category to which you want to add the developer. A developer category is a grouping of developers or companies with similar characteristics. For more information, see Manage developer categories.
MINT_DEVELOPER_LEGAL_NAME Legal name of the developer that will be used in all reports.
Note: This attribute is required if the developer is not grouped with a company and wants to subscribe to a published rate plan.
MINT_DEVELOPER_PHONE Phone number for the developer.
MINT_DEVELOPER_TYPE Developer type. Valid values include: TRUSTED or UNTRUSTED
MINT_HAS_SELF_BILLING Flag that specifies whether self-billing invoices are enabled. If enabled (true), monetization generates a self-billing invoice instead of a revenue share statement. A self-billing invoice is a financial document that details the amount due to the developer. It acts as an invoice to the API Provider on behalf of the developer.
MINT_IS_BROKER Flag that specifies whether the revenue is based on net.
MINT_REGISTRATION_ID Registration ID of developer for use in all reports.
MINT_SUPPORTED_CURRENCY Specifies the ISO 4217 code for the "base" or accounting currency that the developer uses (such as USD for Unites States dollar).
MINT_TAX_EXEMPT_AUTH_NO Government tax exemption number, if applicable.

 

Help or comments?