Get Started
Prerequisites
Section titled “Prerequisites”The APIs require an existing TruckMate installation and are licensed separately.
Similar to TruckMate, the API Server is either self-hosted or hosted as a single-tenant solution by Trimble Transportation. Please see the Getting Started page for API server set-up instructions.
URL and License
Section titled “URL and License”| API Service | License Key | Base URL | Description |
|---|---|---|---|
| TruckMate REST API | 69000 | /tm | A comprehensive set of endpoints and methods, allowing transactional integration with major TruckMate product areas. |
| Master Data | 69001 | /masterData | Allows external systems to create, retrieve, update or delete TruckMate configuration data. |
| Finance API | 69200 | /finance | Allows external systems to create, retrieve, or update Truckmate financial information such as invoices, payments, GL entries, and more. (Available in version 2024.3 and later.) |
Authentication
Section titled “Authentication”When using the TruckMate REST APIs the calling application must pass along a Bearer Token to prove their identity to the On-Premise API server. Bearer Tokens are the predominant type of access token used with OAuth 2.0. A Bearer Token must be set in the Authorization header of every request.
TruckMate REST APIs offer 2 methods for authentication.
- TruckMate API Key generated in one of TruckMate’s Window applications
- Login endpoint to generate a time sensitive JWT token
Authorization
Section titled “Authorization”TruckMate REST APIs offer 5 methods of authorization which allow varying access to endpoints and data
- TruckMate User API Key generated within the Security Configuration application on the TruckMate API Credentials tab.
- Login endpoint to generate a time sensitive JWT token
- Client API Key
- Vendor API Key
- TID