Create partner Axon Evidence API

Axon Interview uses the Partner API to perform operations such as:

  • Get the list of users
  • Get the metadata fields
  • Get the Regex expressions and description
  • Log in
  • Evidence upload
  • Log upload
  • Sync categories

To use the Regex feature, create a new API client and then update the Cloud section in Axon Interview Configuration.

All users of Axon Interview must upgrade to this new API client by end of 2024 to continue using it.

Check if you already have the new API client

  1. Sign into Axon Evidence with an admin account.

  2. Select Admin and API Settings.

  3. If you see an API client with Permissions as Interview_room.marker.any, note the ID and continue below. If you do not see this permission, you need the new API.

  4. Open Axon Interview configuration and select Cloud. If you see the same ID number in API Client ID, you are on the latest API. If the number is different, you need the new API.

Create the partner API client

If you do not have the latest API client as described above, follow these steps:

  1. Sign into Axon Evidence with an admin account.

  2. Select Admin and then under Security Settings, select API Settings.

  3. Select Create Client.

  4. Enter the API Client Name, such as Axon Interview Test.

  5. Scroll down to the Interview_room section and set marker.any to Allowed. This is the only Axon Evidence API permission required by Axon Interview.

  6. At the bottom, select Save, which displays a confirmation.

Important: Save the Secret, Partner ID and Client ID strings to a secure place. They will not be shown again.

  1. Select Done. The list of API Clients displays, including your new API Client.

Update the API client in Axon Interview

  1. Open Axon Interview configuration and select Cloud.

  2. Enter all required fields and select Submit.

Note: Interview v4.7.1 or older may show two additional fields: Upload Access Key and Upload Secret Key. API v2 will still work with older versions of software. However, both of these legacy fields need a value, so enter "1" for each.

  1. Select Save for the new API client to take effect.

  2. Axon Interview Server restarts and applies the new settings.