Overview

Developers register apps to access your API products. When a developer registers an app, the developer selects the API products to associate with the app and Edge generates an API key. Each app has a single API key that provides access to all API products associated with the app.

Apps allow you to control who can access your APIs. You can revoke an app's key, preventing it from accessing all API products. Or you can revoke access to a single API product associated with the 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. 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 associated with the app.

Registering an app in the Edge management UI

However, if you do not use a portal or if you want to maintain complete control over the app registration process, you can register apps by using the Edge management UI. For example, you want to register apps for your internal development teams or on behalf of a developer without access to your portal. When you register an app, you decide which API products to associate with it. When the app is registered, Edge automatically generates an API key to grant access to the selected API products. It is then up to you to determine how to pass that key to the app developer.

Any additional API products you associate with the app use the same key.

Select a developer from the Developer list.
An app must be associated with a registered developer. If the developer does not appear in the list, you can register them. See Adding developers to your organization for more.

If necessary, enter the Callback URL.
A callback URL is the location of a resource that belongs to the app. For example, if you are using OAuth, this could be the location of a login screen where users enter their username and password. This value s not required for all API products.

Optionally, add a descriptive note for the app.

Add any custom attributes for the app. For each custom attribute:

Click (+) Add Custom Attribute.

Add the attribute name and value.

Click Save.
Your app is added to the apps list on the Developer Apps page.

You can specify an expiration time for the client key generated for a new developer app; however, you can only do that by using the API to create the app using the keyExpiresIn attribute. For details, see Create Developer App. Also, note that you cannot update the expiration time of any existing keys. You can only generate new keys with certain expiration time.

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 an API product, or permanently cut off access to a product by deleting the API 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 associating the app with additional API products:

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.

Regenerating a new key

In some cases, you may need to regenerate a new consumer key 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: