Registering app developers

Register and manage your app developers, as described in the following sections. (App registration is a separate process, as described in Register apps and manage API keys).

Introduction

Apigee provides many benefits that are completely dependent on knowing who's calling your APIs. For example, API security, traffic management, and a fair amount of analytics data depend on knowing who's calling. And how does Apigee know who's calling your APIs? By reading unique information in each API call, such as a user ID, an API key, or an OAuth token. That unique information locks or unlocks the functionality you build into your API proxies, giving you full control over API access and behavior.

That's why app developers need to register to use your APIs. Once added, developers register their apps, choose the APIs they want to use, and receive the unique API credentials (consumer keys and secrets) needed to access your APIs.

How to register app developers

Register app developers using one of the following methods:

Recommendations for managing developer accounts on developer portals

Apigee recommends that you manage developer accounts directly on your developer portal.

If you are using the integrated portal, this is the only way to ensure that the developer accounts on the integrated portal and Apigee stay in sync.

If you use the Drupal-based developer portal, managing developer accounts directly on the developer portal provides the following advantages:

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

    When adding or modifying a developer using Apigee, 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 sign in to the portal.

  • Any changes made to the developer's account on the portal are automatically sent to Apigee.

If you decide to manage Drupal-based developer accounts using Apigee, you must synchronize app developers between the portal and Apigee.

Exploring the Developers page

Access and explore the Developers page using the Apigee UI.

To access the Developers page:

  1. Sign in to the Apigee UI.
  2. Select Publish > Developers in the left navigation bar.

The Developers page is displayed.

As highlighted in the figure, the Developers page enables you to:

Adding a developer

To add a developer:

  1. Access the Developers page.
  2. Click + Developer.
  3. Enter the developer details, including first name, last name, email, and username.
  4. Click Create.

Viewing and editing developer details

View and edit developer details.

To view and edit developer details:

  1. Access the Developers page.
  2. Click the row of the developer that you want to view and edit to open the developer details.
  3. In the Details section, the following information is displayed. Edit the developer details, as required.
    Detail Description
    Details Developer first and last name, username, and email; registration status and duration; and developer ID.
    To edit the developer details, click within any of the following fields:
    • First Name
    • Last Name
    • Email
    • Username
    Modify the content and press Enter to confirm the change.
    Custom attributes Custom attributes defined for the developer. Configure custom attributes, as required. For more information, see: Managing custom attibutes for a developer
    Apps Apps that have been registered by the developer. See Registering apps and managing API keys.
  4. Activate or deactivate the developer in the Status field.
    For more information, see Activating and deactivating a developer.

Apigee keeps the following entities in cache for a minimum of 180 seconds after the entities are accessed.

  • OAuth access tokens. This means the ExpiresIn element on the OAuth v2 policy won't be able to expire an access token in less than 180 seconds.
  • Key Management Service (KMS) entities (Apps, Developers, API Products).
  • Custom attributes on OAuth tokens and KMS entities.

Managing custom attributes for a developer

Add up to 18 custom attributes for each developer.

To manage custom attributes:

  1. Access the Developers page.
  2. Click the row of the developer for which you want to manage custom attributes to to open the developer details.
  3. Click + in the Custom Attributes section.
  4. Enter the attribute name and value.
  5. Click .
  6. To delete a custom attribute, position your cursor over the attribute and click in the actions menu.

Activating and deactivating a developer

When an app developer self-registers in your portal, you can configure whether or not they are active by default.

When a developer is inactive, the developer can still sign in to the developer portal and create apps, but none of the corresponding API keys will work. The developer's apps still retain their approved (or other) status, as do the API keys, even though they're not valid while the developer is inactive.

To activate or deactivate a developer:

  1. Access the Developers page.
  2. Click the row of the developer that you want to activate or deactivate to to open the developer details.
  3. In the Details section, set the Status field to Active or Inactive, as required.
  4. Repeat the steps if the developer is in multiple organizations.

Exporting publishing data

Export the following publishing data as a comma-separated values (CSV) file:

  • Developer details
  • Developer, application, and API product details

To export publishing data:

  1. Access the Developers page.
  2. Click Export CSV...
  3. Select Developers or Developers, Apps, and Products from the drop-down.

The selected publishing data is downloaded as a CSV file.

Deleting a developer

To delete a developer:

  1. Access the Developers page.
  2. Position your cursor over the row of the developer that you want to delete to display the actions menu.
  3. Click .
  4. Click Delete to confirm the deletion.

Synchronizing app developers between the portal and Apigee

If you are using a Drupal-based developer portal to publish your APIs, changes made to app developers using Apigee are not propagated to the portal. You must sign in to the portal as a portal administrator and synchronize the portal with Apigee for those changes to appear on the portal.

To synchronize your developer portal with the app developers defined on Apigee, refer to the following section:

Drupal 8: Synchronize developers with Apigee Apigee

Managing developers using the API

Manage developers using the Developer APIs.