Register applications

External applications can use the Oracle Commerce REST web services APIs to provide integrations or extensions to the administration interface or the storefront.

You must register an application in the administration interface before it can access Oracle Commerce data. Registering an application automatically generates the following:

  • An application ID that identifies the application internally.
  • An application key that you use to authenticate the application.

The application key is a JSON Web Token (JWT) from the Oracle Commerce OAuth server. Your registered application exchanges the key for an access token as part of the authentication flow. For more information, see Use the application key for authentication.

To register an application:

  1. Click the Settings icon.
  2. Click Web APIs and display the Registered Applications tab.
  3. Click the Register Application button.
  4. Enter a name for the application.
  5. Click Save.

    The application ID and application key are automatically generated and the application is added to the list on the Registered Applications page.

To acquire the application key:

  1. Click the Settings icon.
  2. Click Web APIs and display the Registered Applications tab.
  3. Click the name of the application whose key you want to get.
  4. Click the Application Key box to reveal the key.
  5. Copy the key and provide it to the application developer.

    See Use the application key for authentication for more information.

To reset the key for a registered application:

  1. Click the Settings icon.
  2. Click Web APIs and display the Registered Applications tab.
  3. Click the name of the application whose key you want to reset.
  4. Click Reset.

    The new application key is automatically generated. The existing application key is automatically revoked and can no longer be used to authenticate the application.

To unregister an application:

  1. Click the Settings icon.
  2. Click Web APIs and display the Registered Applications tab.
  3. Click the name of the application you want to unregister.
  4. Click Delete.
  5. Click Save.

    The application’s ID is removed from the system and its application key is automatically revoked.