#App Registration

Before using the APIs, you must register an app and grant permissions to the app. With the registered app, you can use the generated application (client) ID for authentication.

#Register an App

Complete the following steps to register an app:

1. Go to the Settings page and select API app registration in the Additional area.

2. On the API app registration page, click Create app registration under the Public API tab.

3. In the Basic information step, complete the following information:

   1. Enter a name for the app.

   2. Select the corresponding permissions that you need to grant to this app.

4. Click Next.

5. In the Customer scope step, select All customers, Specific customers, or Customer groups as the scope.

6. Click Next.

7. In the Certificates and secrets step, follow the instructions below to configure credentials:

   Credentials enable applications to identify themselves to the authentication service when receiving tokens at a web addressable location (using an HTTPS scheme). For a higher level of assurance, we recommend using a certificate (instead of a client secret) as a credential.

   • Select the Certificate tab, and then click Upload certificate to upload a certificate (.cer file). The certificate serves as credentials that allow your application to authenticate itself, requiring no interaction from a user at runtime. You can refer to Prepare a Certificate to prepare a certificate.

   • Select the Client secret tab, click Add client secret, set the Effective duration to 1 year, 2 years, or 3 years, and then click Add to generate a client secret. Client secret values cannot be entirely shown once they are saved. To get a client secret value for later use, click the Copy button to copy and save it upon creation.

     If you want to delete a certificate or client secret, click the recycle bin button.

8. Click Save to save your configurations.

   When you finish the registration, click the app name and you can copy the generated application (client) ID on the app details page.

#Edit an App

Complete the following steps to edit an app:

1. On the API app registration page, click the app name to access the app details page.

2. In the Basics tab, you can update the app name, permissions, and customer scope if required.

3. In the Certificates and secrets tab, you can view and manage the certificate and client secret.

#Delete Apps

On the API app registration page, select the apps and click Delete. The selected apps will be deleted.