The following content is sample documentation for end users of your Developer portal. Organization owners can reuse this content for your own Developer portal.
Before users can use the Developer portal for managing apps and API keys, organization owners will need to set up the Apigee integration and configure access control for the Developer portal. See Overview for more information.
Using the Developer portal, users can:
- Read documentation published on the Developer portal
- Create a new app to generate an API key
- Manage API keys
- Manage apps, and
- Use the Try it out console to test the APIs
- On the Developer portal, select Sign in (top right of the screen).
- Sign in using your credentials.
- Once you have signed in, from the user account dropdown, select Apps . The My apps page displays.
- Select Create new App to create a new app. The Create a new app page displays.
- Type a name for the app, and select the API products you want to associate this app with. Note : When you enter the app name, the Developer portal will validate it and display errors if the name contains special or invalid characters.
- Select Create app to confirm your changes. An API key/secret pair is automatically generated for your app and your newly created app will display on the My apps page. The details include the API key, secret information, products associated with the API key and the status of the API key and products associated with it.
A new app is a unique ID and is associated with a specific URL for the portal.
Using the Developer portal, users can create a new API key for a different app/product pairing, update or delete an existing API key.
Users can create a new key to associate your app with a different products combination.
To create a new key:
- On the My apps page, select the app you want to create a new API key for. The selected app details display.
- Click Create API key to display the Create key dialog.
- Select the products you want to uniquely associate to your existing app with this API key, and select Create key . A new API key is now created for your app/product pairing.
In some cases, users may want to add or remove the products associated with an app. This will affect the API key associated with this app/product pairing.
To update the key with this information:
- On the My apps page, select the app you want to update the API key for. The selected app details display.
- For the API key you want to update, select the vertical menu icon, and select Edit to display the Update key dialog.
- Select the product associations to add or remove from the app, and click Update key . The API key is now updated with the app and product combination.
Occasionally, users may want to refresh API credentials for an app/product pairing. You can delete an existing API key associated with an existing app.
To delete an API key:
- On the My apps page, select the app you want to delete an API key for. The selected app details display.
- For the API key you want to update, select the vertical menu icon, and select Delete key . The selected API key is now deleted from the app.
Using Developer portal, users can add multiple apps or edit and delete an existing app. Using the My apps page, they can also sort the app names alphabetically, or by ascending/descending dates for easier searchability and navigation.
Editing an app allows users to change the display name for clear organization and findability if you have multiple apps set up in your Developer portal.
To edit an app:
- On the My apps page, select the app you want to edit. The selected app details display.
- Select Edit to display the Change display name dialog.
- Enter in a new name or make changes, and select Save changes .
Changing the app name only changes the display name for the app, and does not affect the app/product pairing or the API key value.
Users can delete an existing app if it is no longer required for the Developer portal.
To delete an app:
- On the My apps page, select the app you want to delete. The selected app details display.
- Select * Delete . The Delete app warning dialog displays.
- Select Delete app . The selected app is deleted and removed from your My apps page.
Deleting an app will remove its app/product pairings and the API keys.