Integrate with the Connect API - Latest Version
New versions of each API listed below are now available in the Developer Console, provided together as the Trimble Connect API product:
| API | Version |
|---|---|
| Core | v2 |
These newer versions do include breaking changes from the earlier, legacy versions (e.g. v2 and 2.0 are different versions of the Core API).
Access Credentials
Section titled “Access Credentials”To access the Trimble Connect API, log into the Developer Console and create a new client application with the preferred authentication type enabled. The API credentials needed will be provided with that application.
Documentation on the Developer Console is available here.
Authentication Types
Section titled “Authentication Types”If using an End-User App, the Authorization Code authentication type will be used. This enables the client application to perform actions on behalf of a logged-in user.
The Extension App type is used for building a Trimble Connect extension, not a cloud-based API integration.
Deployments
Section titled “Deployments”The new Trimble Connect API product in the Developer Console is available via the following regional deployments:
| Region | URL |
|---|---|
| AP-AU | https://ap-au.api.trimble.com/connect/v2 |
| AP-SG | https://ap-sg.api.trimble.com/connect/v2 |
| EU | https://eu.api.trimble.com/connect/v2 |
| UK | https://eu-gb.api.trimble.com/connect/v2 |
| US | https://us-east.api.trimble.com/connect/v2 |
Scopes
Section titled “Scopes”If using the API with a client application created in the Developer Console, scopes define the access granted to a Trimble ID access token. Include only the scopes needed to enable intended functionality when performing an access token call.
| Name | Access |
|---|---|
connect | Access to the entire Trimble Connect API. |
This documentation will be updated if and when new scopes are introduced.
Initial API Transaction
Section titled “Initial API Transaction”If not yet familiar with Trimble ID authentication, view our guide on how to perform an initial API transaction.
Next, identify which cloud-based API services to use.
Finally, view the documentation and OpenAPI definitions on each API needed to begin developing a cloud-based API integration with Trimble Connect.