API Settings
The API Settings section in Axon Evidence gives administrators the tools they need to manage API client access to their organization’s data. API access is included with most versions of Axon Evidence but is not available in free programs. Your organization’s licensing automatically determines whether the ability to create and use API clients is enabled—no manual requests are required.
The Axon API allows your organization to interact with its data programmatically, making it easier to integrate with third-party systems or custom software. By leveraging compliant client software, administrators can securely streamline workflows and enhance operational efficiency.
From the API Settings page, administrators can manage API clients, ensuring only authenticated and authorized clients can perform operations on supported data resources, such as:
- Users
- Groups
- Cases
- Evidence
- Devices
- Reports
- Category Management
While the API is designed for customer use, direct access by third-party companies is governed by Axon. To maintain security and compliance, sharing API credentials with unapproved third parties is not permitted under your organization's contract with Axon. If your organization wants to work with a third-party integration, a license must first be established between the third party and Axon to ensure proper authorization.
Contact your Axon representative to learn more about using the API.
Resources for developers include the Axon Developer Community and our API documentation page. Learn more about accessing these in Axon Developer Community and API Documentation access.
Create an API Access Client
When you configure access and authorization for an API client, the API provides the following information:
- Client Secret – A password that your client must use to authenticate itself to Axon Evidence. After authentication, Evidence issues a unique token that the client must provide to authenticate itself during API operations.
- Client ID – The unique ID of the API client that you create. This ID is useful only with the Axon Evidence Partner API.
- Partner ID – Also known as your agency ID, this is the unique ID of your Axon Evidence agency.
To configure a new API client:
- Sign into Axon Evidence.
- Select Admin, and then under Security & Integrations, choose API Settings. The API Access Clients page appears.
- Select Create Client. The controls for naming and authorizing the new client appear. For each API resource, the page provides authorization settings for all currently supported operations. By default, all operations are prohibited.
- In the Client Name box, enter a meaningful description of the new client.
- If Allowed IP Addresses is present, your agency has restrictions on what IP address ranges can access the API. Enter a single IP address, or an IP address range in CIDR notation (third-party site).
- For each resource, choose the access settings that are allowed or prohibited for the new client. See Access and authorization for which API methods and URIs are enabled by each access setting.
- Select Save. Axon Evidence saves the client and displays the secret, partner ID, client ID, and client description.
- In a secure location, save the secret. It is recommended that you also save the client ID with the secret so that you can match the secret to the client.