Registering an Application

Product managers can register applications and assign products to the applications.

Procedure

  1. Log into the Developer Portal.
  2. Click the Applications tab.
  3. Click Register Application.

    An interface appears for defining the application.

  4. Specify the following information to identify the application:
    • Application name

      Enter a name for the application.

    • Icon

      Click Choose file, browse for the file containing the image that you want, and then click Open.

      The selected image appears on the configuration interface.

    • Description

      Optionally, enter a description for the application.

    The bottom of the page shows the products that you can associate with the application.

  5. To choose a product, complete these steps:
    1. In the list of products, click on the name of a product.

      A list of plans that have been enabled for the product appears.

    2. To enable a plan, click Use (in the Enabled column).

      A check box appears in the Enabled column.

  6. If your system administrator has enabled OAuth authentication for your environment, and you want to use OAuth, click Yes in the OAuth section.
  7. If you clicked Yes to specify OAuth authentication, complete these steps to apply scopes:
    1. Click Set Parent.
    2. From the Attach Existing dialog, select one or more scopes to apply, and then click Save.
    3. In the Redirect URL field, enter a URL that users are redirected to when accessing the application.

      You might be prompted to enter a user ID and password to access a partner service referenced by the redirect URL.

      If a label has been associated with the specified URL, the label appears in the Label field.

    4. If no label has been associated with the URL, enter a label.
    5. If you want to specify additional redirect URLs and labels, click Add URL to display additional fields for specifying redirect URLs and labels.

      You can specify up to 10 redirect URLs.

  8. Click Save to save your application.

    An Applications window for your application appears. This window enables you to request an application key for the application.

    When you call an API associated with a product that has been assigned to your application, you must specify the application key in order to invoke the API.

  9. Click Request Key.

Result

An application key is generated and appears in the API Key field.