Account Manager API

Account Manager is a web tool that allows you to distribute and manage the product licenses your fleet has purchased for CoPilot with ActiveTraffic. You can create lists of assets (either drivers, devices or vehicles), remotely distribute software licenses to those assets, 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 assets. Trimble 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 assets. (Individual or in bulk. Up to 1,000 assets can be added per API call.)
• Add and remove licensed products from assets. (Individual or in bulk. Up to 1,000 assets can be assigned licenses per API call.)
• Update your company’s information and account settings.

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 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 an asset identifier field called External ID.

External ID is the value that will be used as the Username to log into CoPilot on a device, and it should uniquely identify the asset (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 asset in Account Manager.

Resource URL

AWS: https://accounts-api.trimblemaps.com/api/v1
Azure: https://accounts-api.az.trimblemaps.com/api/v1

Account Manager API Flow

Fleets Managing Their Own Licenses

To create a new asset and assign licenses within your account you would:

1. Authenticate your account and get a token, which should be passed as the Bearer token in each subsequent request. When requesting a token, the alias parameter is not required if you are authenticating on behalf of your own fleet in order to retrieve or update your own information. The alias parameter is used by Trimble Maps partners to authenticate and retrieve or update information on behalf of their customers.

2. Add an asset with a POST request to /users that includes an externalId and other optional fields.

3. Assign products to a single asset with a POST request to /license/{productId} or assign products to a list of assets with a POST request to /license/{productId}/bulk.

4. When assigning a license using either the /license/{productId} or the /license/{productId}/bulk endpoints, you can optionally stipulate an add-on constant if the license has an add-on.

5. When retrieving the available licenses for the account using the /summary GET call, you will see an array for the addons in the products section.

Updating assets and licenses

As your needs, devices or staffing change over time, you can:

1. Modify an asset’s information with a PUT request to /users/{externalId} or delete an asset with a DELETE request to /users/{externalId}.

2. Remove a license from a single asset with a DELETE request to /license/{productId} or remove licenses from a list of assets with a DELETE request to /license/{productId}/bulk.

3. Repeat Step 3 above to assign those licenses you have removed to new assets.

Web products

In addition to CoPilot licenses, companies may also be assigned licenses to use Trimble’s cloud-based web tools.

The names of these webProducts are slightly different in the API than the names displayed in the tools themselves.