Get Started

Access

Open the Trimble Connect for Browser application and complete the user sign-up process.

Terms of Service

You must agree to the Terms of Service to use Connect services.

Register Application

Please register your application by following the instructions at the Trimble Connect Integrations page.

After registration, we will provide you with a Consumer Key, Consumer secret, Application Name & Callback Url, which you will use to authenticate users with Trimble Identity in order to use the Trimble Connect APIs.

OAuth callback urls

For desktop applications, the callback url must be a local one (e.g. http://localhost) since a local port listener is needed to intercept the OAuth callback.

Multiple callback urls can be registered. Once you’ve received initial application credentials, send a request to connect-support@trimble.com.

To test the APIs with Postman, the Postman callback url (https://oauth.pstmn.io/v1/browser-callback) is preconfigured for your application.

Get Access Token

Once the above steps are completed, you should have the following details:

• Trimble Identity username (email)
• Trimble Identity password
• Application Name
• Application Consumer Key
• Application Consumer Secret
• Application Redirect/Callback Uri

Authentication

To use Trimble Connect APIs you need a user-context OAuth access token from Trimble Identity.

See the Authentication Guide for information on how to authenticate users with Trimble Identity using OAuth. We recommend using the Authorization Code with PKCE authentication flow, but plain Authorization Code flow will also work.

After successful authentication you’ll receive an access token that can be used to authorize Trimble Connect API calls.

Non-interactive Authentication

Trimble Connect does not support OAuth Client Credentials tokens, so non-interactive applications/integrations must use a different authentication approach:

1. Use the Authorization Code flow for initial authentication
2. The initial authentication is interactive, after which you will receive the access and refresh tokens
3. Provision the non-interactive application with the tokens
4. Properly manage the tokens within your non-interactive application. The tokens should be refreshed as needed, with a maximum refresh interval of 9 days to keep the session alive.

Managing tokens

Both the access token and refresh token change over time, so they must be securely stored within your application.

Use Connect Services

To use the Trimble Connect APIs, you must include an Authorization header to your requests. Replace access_token with the actual value you got from the previous authentication step.

Example 1: You can use the get user details API to validate that your authentication has been successful

GET https://app.connect.trimble.com/tc/api/2.0/users/me
Authorization: Bearer access_token

Example 2: You can get the list of projects in the US region with

GET https://app.connect.trimble.com/tc/api/2.0/projects?fullyLoaded=false
Authorization: Bearer access_token

Authorization

Trimble Connect API methods must be called as an authenticated Trimble Identity (TID) user. You need to complete the steps on this page to be able to call the APIs.

Access to data is based on the authenticated user making the Connect API calls.

Most data is organized under a project and, project membership grants users access to project data. Read/write access to project data is separately controlled by permissions. Project admins have full access project’s data, while Account admins have full visibility into projects created under an account.

For more details, see the Concepts section.