Managing API key access
API keys allow another system to connect to Traknova. You can limit each key so it can only do what that system needs.
For example, a system that reads vehicle information does not need permission to immobilise a vehicle. Giving each key the smallest amount of access reduces the risk if the key is ever exposed.
Before you start
- Know which Traknova tasks the connected system needs to perform.
- Make sure you personally have access to those tasks.
- Keep the key secret and never send it by email or place it in a document.
Choose what an API key can do
- Open Account.
- Select Api.
- Find the key you want to change.
- Select the shield icon.
- Turn on only the access needed by the connected system.
- Close the window when you are finished.
The change takes effect straight away. If a recently removed option is still visible, refresh Traknova and open the key again.
You can only give a key access that you have yourself. Ask another authorised team member for help if an option is unavailable.
Available access
The options shown depend on what is available to your company and what you are allowed to grant. They can include:
| Access | What the connected system can do |
|---|---|
| Command history | View previously sent vehicle commands |
| Vehicle controls | Lock or unlock supported vehicles |
| Immobiliser controls | Immobilise or mobilise supported vehicles |
| Customers | Work with customer records |
| Geofences | Work with geofence areas |
| Notifications | Work with notifications |
| Tracking devices | Work with trackers and related devices |
Some Traknova options are for people only and cannot be given to API keys. These options are not selectable.
Take extra care with immobiliser controls
Immobiliser controls can stop a vehicle from being driven. Only enable this for a trusted system that genuinely needs it.
Before enabling it:
- confirm the system handles vehicle safety correctly;
- restrict where the key can be used from;
- limit how often it can send requests;
- make sure the key can be replaced quickly if it is exposed.
Remove access
Select the shield icon beside the key and turn off the access that is no longer needed. The connected system will no longer be able to perform that task.
Delete the key completely if the connected system is no longer used or if you believe the key has been exposed. Create a replacement key rather than reusing the old one.
If something does not work
The connected system is denied access
Open the key and check that it has the access required for the task. If the option is not shown, contact the person who manages your Traknova account or Traknova Support.
An option cannot be selected
You may not have permission to give that access, or the option may be for team members rather than API keys. Ask another authorised team member for help.
A live connection stops after access is removed
This is expected. The connected system must reconnect after the correct access has been restored.
A change does not appear
Refresh Traknova and open the key again. Contact Traknova Support if the change still does not appear.