Advertising sustains the DA. Ads are hidden for members. Join today

On this page

Understand how app developers interact with the Apigee module

Last updated on
23 January 2024

The following sections describe how app developers interact with Apigee. Tips for configuring and customizing the experience are provided.

Register an app developer 

Note: Whether a developer can self-register depends on your Drupal Account Settings configuration. Specifically, Registration and Cancellation must be configured to enable visitors to register accounts. See Configuring User Account Settings in the Drupal documentation.

Before app developers can use your APIs, they must register by creating an account.

Alternatively, you can register app developers on their behalf using the Apigee management UI, as described in Managing app developers in the Apigee documentation (though self-service account management via a developer portal is recommended over this approach). In this case, you will need to sync the developers between the portal and Apigee, as described in Synchronize developers with Apigee.

When an app developer registers an account:

New app developers can self-register with your portal as follows:

  1. Navigate to the portal.
  2. Click Log in.
  3. Click the Create new account tab.
  4. Complete the form, including name, email, username, and so on.

    Note: To configure what happens if an email address is already registered in Drupal or Apigee, see Configure developer registration.

  5. Click Create new account.

    Depending on your Drupal account settings, the app developer may receive an email to verify the account creation.

  6. After the account is verified, the developer can log in to the portal.

Manage teams of app developers

The Apigee submodule Apigee Teams enables app developers using your APIs to create teams and collaborate on the same apps.  Before getting started, you will need to install and configure the Apigee submodule Apigee Teams, as described in Configure team management.

Note: Using Apigee (formerly called "Apigee X") with monetization enabled cannot leverage the Teams features in their Drupal developer portals at this time

Once the module in installed, app developers can create teams, add members, and manage apps.

To manage teams as an app developer:

  1. Select Teams in the top nav bar.
  2. Click Add team to add a new team.
  3. Complete the form.

    Note: To configure the fields that are displayed in the team registration form, see Configure team management.

  4. Click Add team.
  5. Click the name of the team to view details.
  6. Click the Members tab to add or remove team members.
  7. Click the Team Apps tab to register team apps.
  8. Click the Edit or Delete tab to edit the team name or delete the team, respectively.

Register an app

App developers can register apps to access the resources in your API products. When registering an app, app developers select the API product to include and Apigee generates a key. Each app has a single key that provides access to multiple API products.

You can register a developer app or a team app, as described in the following sections.

Note: Apps allow you to control who can access your resources. You can control who has access to your API products by revoking and refreshing an app's key. And you can control access to bundles of resources by revoking or deleting access to the API products in an app. For more information, see Register apps and managing API keys in the Apigee documentation.

Register a developer app

To register a developer app:

  1. Select My Apps in the top nav bar.
  2. Click Add app to add a new developer app.
  3. Complete the form.

    Note: To configure the fields that are displayed in the developer app registration form, see Configure app registration.

  4. Click Add app.

Register a team app

Team apps are accessible by all members of the team.

To register a team app:

  1. Select Teams in the top nav bar.
  2. Click Team Apps in the Operations column for the team.
  3. Click Add team app to add a new app.
  4. Complete the form.

    Note: To configure the fields that are displayed in the team app registration form, see Configure app registration.

  5. Click Add team app.

View the API key for an app

View the API key for a developer app or team app, as described in the following sections.

View the API key for a developer app

To view the API key for a developer app:

  1. Select My Apps in the top nav bar.
  2. Click the name of the developer app for which you want to view details.

    Note: To configure the fields that are displayed when viewing developer apps, see Configure app registration

  3. Click Show associated with the consumer key or consumer secret that you want to view.
     

    Show API keys

View the API key for a team app

To view the API key for a team app:

  1. Select Teams in the top nav bar.
  2. Click Team Apps in the Operations column for the team.
  3. Click the name of the team app for which you want to view details.
    Note: To configure the fields that are displayed when viewing team apps, see Configure app registration.
  4. Click Show associated with the consumer key or consumer secret that you want to view.

Monitor apps

Developers can view and export as a CSV file analytics for their apps over a specified time range, including:

  • Average, maximum, and minimum response time
  • Message count
  • Error count

Analytics

Note: The client must have internet access and be able to load the Google Charts visualization libraries at https://www.gstatic.com/charts/loader.js in order to view analytics. You can disable access to app analytics, as described in Configure access permissions.

Monitor a developer app or team app, as described in the following sections.

Monitor a developer app

To monitor a developer app:

  1. Select My Apps in the top nav bar.
  2. Click the name of the developer app.
  3. Click the Analytics tab.
  4. In the Filter section, select the type of data you want to view and the data and time range.
  5. Click Apply to update the chart.

Alternatively, from the My Apps page you can select Analytics in the Operations column associated with the developer app for which you want to view analytics.

Monitor a team app

To monitor a team app:

  1. Select Teams in the top nav bar.
  2. Click Team Apps in the Operations column for the team.
  3. Click the name of the team app for which you want to view analytics.
  4. Click the Analytics tab.
  5. In the Filter section, select the type of data you want to view and the data and time range.
  6. Click Apply to update the chart.

Alternatively, from the Team Apps page you can select Analytics in the Operations column associated with the team app for which you want to view analytics.

Manage apps

Manage a developer app or team app, as described in the following sections.

Note: See also Register an app.

Manage developer apps

App developers can manage their developer apps, as follows:

  1. Select My Apps from the top nav bar.
  2. Click the name of the developer app.
  3. Click the Edit or Delete tab to manage the developer app.

Manage an app

Note: To configure the fields that are displayed when managing developer apps, see Configure app registration.

Alternatively, from the My Apps page you can select Edit or Delete in the Operations column associated with the app you want to manage.

Manage team apps

Members of a team can manage team apps, as follows:

  1. Select Teams in the top nav bar.
  2. Click Team Apps in the Operations column for the team.
  3. Click the name of a team app
  4. Click the Edit or Delete in the Operations column to manage the team app.

Note: To configure the fields that are displayed when managing team apps, see Configure app registration.

Alternatively, from the Team Apps page you can select Edit or Delete in the Operations column associated with the team app you want to manage.

Help improve this page

Page status: No known problems

You can: