The Account Manager is a web tool that allows you to distribute and manage the product licenses your fleet has purchased for CoPilot with ActiveTraffic, MileOn, or both. You can create lists of users (either drivers, devices or vehicles), remotely distribute software licenses to those users, and then re-assign your licenses as needed when your devices or staffing change.
The Account Manager API is a RESTful API that provides endpoints for managing licenses and licensed users. Trimble MAPS partners can also use this API to set up Account Manager for their customers.
What Can You Do With The Account Manager API? #
With this API, your company’s Account Manager administrator can:
- Add and remove licensed users.
- Add and remove licensed products from users.
Getting Started #
To use the Account Manager API, you must request access by contacting your Trimble MAPS sales representative or our Sales team.
Account Manager Terminology #
In the Account Manager, you may assign a license for CoPilot or MileOn to a person (driver), a device that is installed directly in a truck, or a handheld device. To support this variety of uses, we provide a user identifier field called External Id.
External ID is the value that will be used as the User ID to log into CoPilot or MileOn on a device, and it should uniquely identify the user (driver, device or vehicle). For example, an External ID could be a company issued device ID, driver ID, email address, phone number, device descriptor, or vehicle number—whatever works best for your fleet. It is the only required field when adding a new user in the Account Manager.
Resource URL #
Account Manager API Flow #
For Fleets Managing Their Own Licenses #
To create a new user and assign licenses within your account you would:
Authenticate your account and get an
authToken, which should be passed in each subsequent request.
Add a user with POST a request to
/usersthat includes an
externalIdand other optional fields.
Then, as your needs, devices or staffing change over time, you can:
Repeat Step 3 above to assign those licenses you have removed to new users.
For Trimble MAPS Partners Setting Up Customer Accounts #
As a partner, you can use our Account Manager APIs to create accounts for customers. You can then either delegate the day-to-day management of app licenses to an administrator assigned by the customer, or you can actively manage users, devices, and licenses for your customers.
To use the Account Manager API, you need to
obtain an API key. Using that API key, you can generate an auth token by calling the
Authenticate API. This API provides authentication for either partner-level activities (creating and managing customer accounts) or account-level activities (adding users, assigning licenses to users). For partner-level activities, only the
apiKey parameter is required. For account-level activities, the auth token needs to also include the
To get started, you would:
Create a customer account #
Call the Authenticate API to get a token by passing in the
Include the resulting token in an Authorization header (Authorization:Bearer your
authToken) and create an account using the Company API.
Manage the newly created account #
aliasfrom the Company API response and use it to get an Account auth token by calling the Authenticate API. This time, pass in both
Using this new Account auth token, you can then proceed to create users and then assign product licenses to those users. See steps above.
There are several other APIs you may want use to manage an account, including bulk operations that may be useful in partner integrations. Please see our full Account Manager API documentation for more details.