• In progress

    • Configuring Application Access

    Owned by Former user (Deleted)
    Last updated: Jun 10, 2024 by Jenni Wallin
    2 min read

    This page contains an overview of the graphical interface as well as instructions for how to configure an application access.

    If you have an external application that needs to access Usage Engine via an API, you need to create credentials (Client ID and Client secret) first. You must treat the client secret like a password. Keep it confidential and do not share it publicly.

    Creating Application Access

    Creating an application access means assigning a set of credentials with the name of the external application that wants to access the Usage Engine APIs.

    When you click on the Admin tab in the navigation panel, you will see the Application access tab on the top right. When you click on the Application access for the first time, you will see the following screen:

     

    apiaccess-first.png
    Create first application access

    To create an application access:

    1. Click Create application access.

      applicationaccessname.png
      Create application access

    2. Enter the name of the application that wants to access the Usage Engine API, for example, “testapplication” as in the screenshot above.

    3. Click Create. A set of credentials is generated for the application “testapplication” and the following dialog is displayed.

      The Client ID and Client secret for “testapplication” are generated. The Client secret is shown only once so either save the Client secret securely or click on Download JSON file to download the Client ID and Client secret in a JSON file format.

    Note!

    Remember that these credentials authenticate your application and grant access to your data.

    Follow these general rules:

    • Treat the client secret and issued tokens as passwords

    • Only store what you need

    Avoid the following:

    • Hardcoding of credentials in your code

    • Storing the credentials in a code repository

    • Storing the Client secret in plain text

    1. Click Done.
      The created application access will now be listed in the Application Access overview:

      Repeat the procedure to create an additional application access.

      When you have an application access configured, you can use the Edit and Delete buttons to the right to either modify the name of the application access or delete the application access permanently. If you select to delete, you will be prompted to confirm before the application access is deleted.