How app developers interact with your portal

Out-of-the-box, the developer portal enables your app developers to register, sign in, and manage the apps that will consume your APIs. The following sections describe how app developers interact with your portal.

How app developer registration and sign in are tracked in Edge

Developer registration and portal sign in are tracked using the _apiportal custom attribute in Edge.

When a developer self-registers, the _apiportal custom attribute is added to the developer configuration and the developer status is set to unverified to indicate that the developer has not signed in to the portal. For example: {"status":"unverified","portals":{}}

The first time the developer signs in to a portal, the _apiportal custom attribute is updated to track the portal name and time of access, and set the developer status to active. Each time the developer signs in to the portal, the custom attribute is updated to reset the lastVisit value (in epoch format) for that portal. For example: {"status":"active","portals":{"myorg-myportal":{"lastVisit":1480972935}}}

Register an app developer account

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

App developers create an account on your portal as follows:

  1. Navigate to the portal.
  2. Click Sign in.
    The Sign In page displays.
  3. Click Create account.
    The Create your account page displays.

    >

    Note: You can custom fields to the account creation page, as described in Add custom registration fields to the account creation page.

  4. Complete all fields. All fields are required.

  5. Review and agree to the terms and conditions.

  6. Click Create Account.

    Note: If a developer attempts to register an account with an email ID that has already been registered, a message displays indicating that the account already exists.

  7. If the system suspects your interactions to be robotic, complete the CAPTCHA form and click Verify.

  8. Your account is created and a confirmation email is sent.

    Note: To configure the SMTP server, see Configure an SMTP server.

  9. Click the link in the confirmation email to complete the registration process and sign in to the portal, as described below.

Sign in to the portal

After app developers have created an account on your portal, they sign in.

App developers sign in to the portal as follows:

  1. Navigate to the portal.
  2. Click Sign In.
  3. Enter the email address and password.
  4. Click Sign In.

Change the user account password

App developers change the user account password as follows:

  1. Navigate to the portal.
  2. Click Sign In.
  3. Click Reset Password.
  4. Enter the email address for which you want to change the password.
  5. Click Send Reset Password Link. A reset password link is sent to the email account.

    Note: To configure the SMTP server, see Configure an SMTP server.

  6. Click the link in the confirmation email.

  7. Enter the new password and confirm it.

    Note: The new password cannot be the same as the old password.

  8. Click Create New Password.

The password is reset and the user is signed in to the portal.

View API documentation

App developers can view the API reference documentation that you have published to your portal, as follows:

  1. Navigate to the portal.
  2. Click APIs in the top navigation bar.
  3. Click an API card to view the API reference documentation.

The API reference documentation is displayed. User can learn about and try the APIs. See Overview of API publishing.

Register apps

App developers can register apps to use the API products that you have published, as follows:

  1. Select My Apps from the user drop-down.
  2. Click + New App to create a new app.
  3. Enter a name and description for the app in the New App dialog.
  4. Select one or more APIs in the APIs section. You must select at least one API in order to create an app.
  5. Click Create.

Manage the API products in an app

App developers can manage the API products in their apps. The API products are added to the app details page. For some API products, approval is not automatic. A status of Pending indicates an API product for which access has been requested but not yet granted.

App developers can manage the API products in an app from your portal, as follows:

  1. Select My Apps from the user drop-down.
  2. Click the app in the list.
  3. In the APIs section, click the access toggle to enable or disable access to an API product from the app.

View the API key and secret for an app

App developers can manage the API key for an app from your portal, as follows:

  1. Select My Apps from the user drop-down.
  2. Click the app in the list.
  3. View the API keys in the API Keys section.
  4. Confirm that the status of the API key is Active.
  5. Click Show to view the secret.
  6. Position your cursor over the API key or secret and click to copy it to the clipboard.

Rotate the API key for an app

An app developer can rotate an app's API key periodically or in response to a potential leak or compromise. When an app developer rotates an API key, a new API key is created with the same API product entitlements as the original key. The original API key remains active while you transition it out of use. You must revoke the old API key to prevent its credentials from being accepted, as described in Revoke an API key for an app.

App developers can rotate an API key for an app from your portal, as follows:

  1. Select My Apps from the user drop-down.
  2. Click the app in the list.
  3. In the API Keys section, click Add Key.
  4. Click Confirm in the dialog box to confirm the operation.
  5. Optionally, revoke the old API key, as described below.

Revoke an API key for an app

When an app developer rotates an API key, as described in the previous section, the API key remains active while you transition it out of use. You must revoke an API key to prevent its credentials from being accepted.

App developers can revoke an API key for an app from your portal, as follows:

  1. Select My Apps from the user drop-down.
  2. Click the name of the app.
  3. On the App Details tab, click .
  4. Click Confirm to confirm the operation.
    The Status of the key is updated to Revoked.

Edit app details

App developers can edit the app details, as follows:

  1. Select My Apps from the user drop-down.
  2. Click the app in the list.
  3. Edit the Name or Description fields on the App Details tab.
  4. Click Save.

Delete an app

App developers can delete an app from your portal, as follows:

  1. Select My Apps from the user drop-down.
  2. Click the app in the list.
  3. Click DELETE.
  4. Click Confirm to confirm the operation.

The app is deleted and removed from the My Apps list.