Connect Platform
Connect the right people to the right data at the right time
Overview
The Trimble Connect APIs allow you to read, write, and update data into and out of the Connect Platform. Now, you can create folders, upload and download files, modify views, and do much more from any application.
Terms of use
To use Connect services, you must agree to the Terms of Service.
Platform architecture
Connect Platform consists of powerful cloud-based services and cloud-enabled Trimble Connect applications for the browser, desktop and mobile.
On the cloud, the platform provides of a collection of Services with their corresponding APIs and SDKs.
On the client side, Trimble Connect for Browser and Trimble Connect for Windows provide Client APIs for application integrations & extensions.
Connect Platform is open for our customers, Trimble-internal teams & 3rd-party integrators - see Getting Started.
Services
Connect Platform provides the following cloud-based services:
| Service | Description |
|---|---|
| Core | Connect Core service allows one to read, write and update data into and out of the Connect Platform. Now, one can create folders, upload and download files, modify views and do much more from any application |
| Topics | BCF 2.1 compatible service for managing issues on a Connect project. |
| Model | The Model service allows you to execute queries over Building Information Models (BIM). |
| Model Feature | The Model Feature service provides easy read access to Organizer groups in Connect projects. |
| Organizer | The Organizer service allows one to manage hierarchical breakdown structures. |
| Property Set | The Property Set service allows one to manage libraries of property set definitions and attach property sets to external objects. |
| Status Sharing | Status Sharing service allows real-time sharing of the construction statuses of external objects. |
Common Concepts
Regional Endpoints
Connect API offers regional endpoints that you can use to make your requests. The resources in each region are independent of similar resources in other regions.
Regions may be discovered by calling the /regions endpoint of the master region. Use the origin field value to determine the base URL to make API calls to a specific region. The base URLs of other regional Trimble Connect services are also returned for each region.
Paginated responses
All collections/lists support pagination either via a cursor-based query or a Range header to fetch partial lists (HTTP 206). See the API specifications for details.
Date Format
All timestamps should be formatted based on RFC 3339 specifications, specifically to this format: yyyy-MM-ddTHH:mm
Example: 2015-04-12T14:01:44-0700
Cross-Origin Resource Sharing
This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with the W3C spec that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
Error Handling
The Common HTTP Response Status Codes are used. See the API specifications for more details.
SDKs
SDKs (Software Development Kits) provide easy access to the cloud-based Connect Services.
| Platform | SDK | Server APIs covered |
|---|---|---|
| Windows .NET .NET Core | Trimble Connect .NET SDK (NuGet) | API client, local data management/sync for: Core, Organizer, Property Set |
| Web JavaScript TypeScript | trimble-connect-sdk (npm) | API client for: Core, Organizer, Property Set |
Client APIs
Client APIs enable application integrations with Connect applications.
| Platform | API | Description |
|---|---|---|
| Web | Workspace API | Project extensions: The API enables exposing additional capabilities through the Trimble Connect Web application within the Trimble Connect project context. 3D extensions: The API allows the client applications to interact with the Trimble Connect 3D Viewer. Embedded Connect: Workspace API also allows you to interact with an embedded Connect file explorer or 3d viewer. Check out the API documentation. |
| Windows | Trimble Connect for Windows API | A .NET application programming interface allowing external .NET applications to communicate with Trimble Connect for Windows API documentation comes with the installation, see C:\Program Files\Trimble\Trimble Connect\API Documentation\Trimble.Connect.Desktop.API.chm |
Support and Community
For support, visit https://community.trimble.com/community/find-answers/connect-help or reach out to connect-support@trimble.com.
Also, visit the Integrator community at https://community.trimble.com/community/find-answers/connect-help/connect-integrators.