Adding an API Key

Audere Premium admins can access API Keys from their Account Settings.

When upgraded to Premium, the API Keys menu item is available.

Note: This functionality is only available for Premium admins

  1. Select your Profile icon in the upper-right corner of the page, and then select Account Settings from the drop-down menu to open the Account Settings page.
    menu Account settings
  2. Select API Keys from the side menu. 
    API Keys home
  3. Select the Add Icon Add icon to create a new API key in the New API Key dialog.
    new api key dialog
  4. Enter the name of the API key in the Key Name field.
    • A Key Name is required and is limited to 200 characters.

Permissions

To enable an application to access data from Audere, the Premium admin must provide the necessary permissions. None is the default permission.

  • Select None, Read, or Write as the permissions for the Assignments, Projects, and People | Roles data.
    • None: Allows the application no access
    • Read: Allows the application to read data
    • Write: Allows the application to read, update, delete and perform actions

Create and Copy an API Key

  1. Select Create once complete or Cancel to close the dialog without saving.
    • When a new API Key is created, a dialog with the key displays.
  2. Select Copy Key to copy the key to your computer's clipboard. This allows you to paste the API key with your system controls [Ctrl + V] to Word, Notepad, etc.
    copy key
    API key caution note
  3. Select Ok to exit the dialog.

See Also:

Updating an API Key

Using Swagger and the Audere API

Viewing a Public Key