Introduction

CoPilot FleetPortal is a web-based fleet management solution that extends the functionality of CoPilot. It allows fleet managers to remotely configure CoPilot settings and vehicle routing profiles to be used by the fleet and assign specific routing profiles to vehicle and driver groups within the fleet.

What Can You Do With The Fleet API?

The Fleet API allows you to add and modify a list of vehicles and drivers in a fleet account using the API programmatically, rather than entering them manually using the web user interface. You must have an active CoPilot FleetPortal account to use the API.

Getting Started

To gain access to the Fleet API, you must request access by contacting your Trimble MAPS sales representative or our Support team.

Fleet API Flow

If you are a partner/reseller and provide FleetPortal accounts to your customers:

Step 1: Authenticate with the API key to get a list of associated accounts

  • Call /accounts/authenticate with the provided API key to get an authentication token.
  • Call /accounts with the token in the authorization header to get a list of associated accounts with corresponding AccountIds and AccountNames

Step 2: Authenticate with the API Key and an AccountId to manage a specific account

  • Call /accounts/authenticate with provided API key and AccountId to get authentication token specific to a fleet account.
  • Call the /vehicles or /drivers endpoints with the fleet account token in the authorization header to manage vehicles and drivers in the specific fleet account.

If you are a direct CoPilot customer/fleet account and have FleetPortal access:

  • Call /accounts/authenticate with the provided API key to get an authentication token.
  • Call the /vehicles or /drivers endpoints with the token in the authorization header to manage vehicles and drivers in the fleet account.