Was this helpful?

This topic explains how to register and manage apps using the Apigee Edge management UI. If you do not have a developer portal, you can still publish your APIs to selected users by registering apps manually as described here.

Overview

Developers use apps to access your API products. When you register an app, you select the API product to associate with the app and Apigee generates an API key. Each app has a single API key that provides access to multiple API products.

Apps allow you to control who can access your APIs. You can control who has access to your API products by revoking and refreshing an app's key. And you can also control access to bundles of resources by revoking or deleting access to the products in an app.


You can see all of your organization's apps in the Edge management UI on the Publish > Developer Apps summary page. This page displays performance data for each app, and general information on app keys and user tokens. You can select a specific app from the table to get more detailed information, including the API products that app can access and the resources those products expose. You can also see the key and access token associated with the app. An access token is generated if an app requires login. See End-user tokens for more information.

Registering an app in the Edge management UI

In general, developers register their own apps through your developer portal. However, in some cases you need to register apps for your internal development teams or on behalf of a developer. See What is a developer portal? for more on developer portals. When you register an app, you decide which API products to associate with it. When the app is registered, an API key is automatically generated to grant access to the selected products. Any additional products you associate with the app use the same key.

  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click the Publish tab, then Developer Apps.
  3. Click (+) Developer App on the Developer Apps page.
  4. Enter an application name in the Display name field.
  5. Enter the URL for the callback.
    A callback is the location of a resource that belongs to the application. In most cases, this is the location of a login screen where users enter their username and password.
  6. Optionally, add a descriptive note for the app.
  7. Add any custom attributes for the app. For each custom attribute:
    • Click (+) Add Custom Attribute
    • Add the attribute name and value.
  8. Select a developer from the Developer list.
    Your app must have a developer.
  9. Click Save.
    Your app is added to the apps list on the Developer Apps page.

Editing an app in the Edge management UI

  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click the Publish tab, then Developer Apps.
  3. Select an app in the Developer Apps summary table.
  4. Click Edit.
  5. Edit the app's display name and callback URL, as needed.
  6. Add, remove, or change a note, as needed.
  7. Add, remove, or change any custom attributes, as needed.
    Note: Be careful when you edit custom attributes. If you have a system that has dependencies on custom attributes, it might be impacted if you edit the custom attributes using the Edge management UI.

Controlling access to products in the Edge management UI

You give an app access to your APIs by associating API products with the app. If you want to limit an app's access, you can temporarily revoke access to a product, or permanently cut off access to a product by deleting the product from the app.

When you create an API product, you can also set its Access mode to Internal only or Private. API products marked Internal only or Private do not appear to developers on the developer portal. To get access to these products, you manually add them to a developer's app from the Edge management UI.

Adding access to an API product

You can expand the app's access to your APIs by adding more products:

  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click the Publish tab, then Developer Apps.
  3. Select an app in the Developer Apps summary table.
  4. On the Developer App page, click Edit. 
  5. In the Products section of the Edit Developer App page, click + Product, select the product you want to add to the app, and click the check mark icon.
  6. Click Save. The product is added to the app.

Revoking access to an API product

In this procedure, you are revoking access to this product and the resources it contains. You can re-enable access at any time.

  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click the Publish tab, then Developer Apps.
  3. Select an app in the Developer Apps summary table.
  4. On the Developer App page, click Edit.
  5. In the Products section of the Edit Developer App page, click Revoke next to the product.
    The Revoke button changes to Approve in case you want to make the app part of that product again.
  6. Click Save.

Deleting a product from an app

In this procedure, you are permanently removing a product from an app.

  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click the Publish tab, then Developer Apps.
  3. Select an app in the Developer Apps summary table.
  4. On the Developer App page, click Edit.
  5. In the Products section of the Edit Developer App page, click Remove next to the product.
  6. Click Save.

Manually approve keys

If you specified automatic key approval when you created the API product, a key is automatically approved for use by an app. If you specified manual key approval when creating the API product, you need to approve the key manually in the Edge management UI before the key can be used by the app to access the product.

In this procedure, you manually approve a product in an app.

  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click the Publish tab, then Developer Apps.
  3. If any app is waiting for key approval, Key requested appears in the Key column of the page.
  4. Select an app in the Developer Apps summary table with a pending key request.
  5. On the Developer App page, click Edit.
  6. In the Products section of the Edit Developer App page, click Approve next to the product.
  7. Click Save.

Regenerating new consumer keys

In some cases, you may need to regenerate a new set of consumer keys for an app. For instance, you might do this if the security of the original keys is compromised. Note that if you simply remove products from an app, and then add the products back, the old consumer keys are reused. To regenerate new consumer keys:
 
  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click the Publish tab, then Developer Apps.
  3. Select the app in the Developer Apps summary table for which you want to generate new consumer keys.
  4. On the Developer App page, click Regenerate Key.
  5. In the pop-up, click Regenerate Consumer Key

End-user tokens

If an app has some type of security applied, such as OAuth, each call requires a valid access token. An end-user token controls a user's access to an app. When the user has access to the app, they have access to all the API products that app contains, which in turn gives them access to all the resources within those API products. End-user tokens are automatically generated when a user logs in to an app for the first time. The token stores the scope. As an API provider, you define a scope when you set up your OAuth policy.

コメントを追加

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.