Creating API Client Credentials

About this task

Before you can authorize an external application to access the SOTI XSight API, you must first generate a client ID and a client secret that the external application can use to authenticate itself to the SOTI XSight API.

To create SOTI XSight API client credentials:

Procedure

  1. Log into SOTI XSight as an administrator.
  2. On the menu bar, click the menu button Main menu button and select Settings. The SOTI XSight Settings menu opens.
  3. On the Settings menu, click Global, then Integration
  4. Select API Clients. The API Clients view opens on the right.
  5. On the API Clients view, click Add buttonnext to Add API Clients. The Add API Client dialog boxopens.
  6. In the Add API Client dialog box, enter a name and the redirect URL for the API client, then click Generate Credentials. The generated client ID and client secret appear in the Add API Client dialog box.
  7. Optional: Click the Copy ID button Copy button to copy the client ID to the clipboard.
    You can also copy the client ID later when it is listed in the Integration section.
  8. Required: Click the Copy Secret button Copy secretto copy the client secret to the clipboard. Ensure that you paste the client secret into a secure file.
    Warning: This is the only opportunity to see and copy the client secret. Once you close the Add API Client dialog box, you will no longer be able to see the client secret.
  9. Click OK to close the Add API Client dialog box and return to the Integration section of the setting view. The new API client is added to the list of clients under SOTI XSight Integration.

Results

Once the client ID and client secret have been generated, you can send them to the external application's administrator so that the application can use them to access the SOTI XSight API.

For more information, see the Authentication topic in the SOTI XSight API documentation.