Fleet Advisor Hub - API Keys

API Keys in the Fleet Advisor Hub allow you to manage API Keys and Account Tokens for your customer accounts.

An API Key allows a 3rd-party system to connect to Fleetio and access or add data.

• API Keys expire one year (12 months) after creation but can be renewed before the expiration date. If the key expires, it will be revoked.
• Revoked keys cannot be reactivated. Keys can also be revoked manually.

An Account Token is how a third-party system identifies the correct Fleetio Account (Customer) to interact with. This is used along with the partner API Key to integrate with Fleetio.

Manage API Keys and Account Tokens

To manage Partner API Keys and Customer Account Tokens, click API Keys in the Sidebar Navigation of the Fleet Advisor Hub.

In the API Keys index, you can view and manage the API Keys and Account Tokens for your customer accounts.

API Keys

In the API Keys tab, you can:

• Click + Add API Key (a) to add a new API Key (see below)
• Click the Tabs (b) to switch between the API Keys and Account Tokens indexes
• Use Search, Status, and Filters (c) to narrow the results shown
• In each row, you can view the API Key Name, Status, Date Added (d), date and time the key Expires At (e), and the API Key Version (f)
• Click the More Actions Button (g) for an API Key to renew an expiring key, edit the name or version, or revoke it

Account Tokens

In the Account Tokens tab, you can:

• Click + Add API Key (a) to add a new API Key (see below)
• Click the Tabs (b) to switch between the API Keys and Account Tokens indexes
• Use Search, Account Status, and Filters (c) to narrow the results shown
• In each row, you can view the Account Name, Account Status, and Token (d)
• Hover over a customer and click Copy Token (e) to copy the Account Token to your clipboard

Add an API Key

To add a new API Key:

1. Click API Keys in the Sidebar Navigation
2. Click the + Add API Key button in the API Keys index

3. Enter an API Key Name, select the API Version, and click Save

4. Click Copy Token to copy the API Key Token to your clipboard.

5. Click the X in the top right to close the pop-up.

Your API Key will now appear in the API Keys index.

Edit API Keys

Follow the steps below to edit an existing API Key. Only the API Key Name and API Version can be changed.

1. Click API Keys in the Sidebar Navigation
2. Locate the API Key in the index
3. Click the More Actions Button and select Edit

4. Make the necessary changes, then click Save

Renew an API Key

API Keys will expire one year (12 months) after they were created. You can renew an API Key at any time before the expiration date, which will keep the key active for another 12 months from the date of renewal.

Before an API Key expires, account administrators will receive email notifications indicating the upcoming key expiration. The first email will be sent 90 days before the key expires, and if no action is taken, additional emails will be sent up until the expiration date.

To renew an API Key:

1. Click API Keys in the Sidebar Navigation
2. Locate the API Key in the index
3. Click the More Actions Button and select Renew

4. You'll receive a notification on the bottom right of your screen indicating that the renewal was successful

Revoke an API Key

As stated above, if an API Key expires, it will be revoked, terminating any access or integrations using it. However, at times, you may need to manually revoke an API Key for security reasons or if it is no longer in use.

To revoke an API Key manually:

1. Click API Keys in the Sidebar Navigation
2. Locate the API Key in the index
3. Click the More Actions Button and select Revoke

4. In the confirmation pop-up, click Revoke to confirm the action