Table of Contents
Fleetio's API (Application Programming Interface) allows access to Fleetio data resources (e.g. Vehicles, Meter Entries, and Fuel Entries) so that developers can build integrations with third-party and/or internal software systems.
In order for a third party to obtain access to the API, an API Key must be generated.
IMPORTANT: API access is only available for Professional and Premium Plan customers.
What is an API Key?
An API Key serves as the username and password for the external party accessing your Fleetio data.
PERMISSIONS: API keys are directly associated with the User who creates them; therefore, all data available through the API will be determined by the permissions of this User.
IMPORTANT: API Keys can be regenerated and/or revoked; therefore, we strongly recommend that each application or integration connecting to Fleetio be assigned its own API Key.
Create an API Key
- Go to your Account Menu and select Settings.
- In the Settings sidebar, click Manage API Keys. This will open a new browser window.
- Click the + Add API Key button.
- Add a Label to help organize your API Keys so that the purpose of each key is clear, and select the API Version using the drop-down.
- Click the Save button.
Once added, Fleetio will display the generated API Key under the Token heading next to the Label you created earlier.
Edit or Revoke Access
To Edit or Revoke access to the API, hover over an API Key and click the More Actions Button.
IMPORTANT: API Keys should be kept secret, therefore we strongly discourage pasting it online or committing it to a repository.
Account Token
In order for data requests to be fulfilled through the API, an Account Token must be passed. These appear below your API Key listing.
Account Tokens can also be identified directly from the URL from any page in Fleetio.
For example, if the URL for the Fleetio Dashboard is https://secure.fleetio.com/abc123/dashboard, then abc123 is the Account Token.
API Requests
The API Keys page also includes a fully functional code snippet for the account and API key, and an example of how the token from the API key is used:
TIP: Learn more in the Fleetio Developer Documentation.
