Guides and Articles

Use this documentation when building your Trimble Connect apps

Introduction to Trimble Connect APIs

Updated: 22 May 2019

 

Trimble Connect API logo

Trimble Connect API is set of different APIs

Trimble Connect is a cloud-based platform that connects the right people to the right constructible data, at the right time. Trimble Connect public APIs enable customers to integrate the platform to their own systems. 

Trimble Connect API is set of Application Programming Interfaces (APIs) that allow communication with Trimble Connect server and web and desktop clients.

Trimble Connect API architecture

Trimble Connect APIs has been used developing Trimble in-house application as well as third party applications. There are multiple APIs and you need to know which APIs to use.

The following image illustrates the Trimble Connect API architecture.

Trimble Connect API architecture

Authentication using the Trimble Identity

At the bottom is the Trimble Idenitity authentication service, which has it own API for authenticating users. It is a separate service. The authentication of Tekla products and online services uses the centralized Trimble Identity system.

Server side APIs available: Core APIs and Status API

Trimble Connect Core APIs

Trimble Connect Core has APIs for managing entities such as projects, project memberships, files, todos, views. The Core APIs and Workflow tools API (see below) are both standard RESTful APIs. They use GET to retrieve information, PUT to store or update a resource, POST to create a new entity, and DELETE to remove it.

The Trimble Connect Core API allows one to read, write and update data into and out of the Trimble Connect platform. One can create folders, upload and download files, modify views and do much more from any application.

Workflow tools (status sharing) API

Trimble Connect Workflow tools enable cloud-based BIM supply chain management. You can control and keep track of assembly and object level status information for project management, scheduling and design review purposes.

External systems are able to integrate with the Trimble Connect using the server side Core APIs and Workflow Tools (status sharing) API. For example, fabrication ERP systems can publish the status data real time using the status sharing API.

If you are a fabricator or equivalent, most probably you have an ERP system or other system with a status concept in place. With the status sharing API, you can visualize your production status on BIM with a “live feed” and update your system status from the Trimble Connect user interfaces.

Client side APIs available: Web API and Desktop API

Trimble Connect has client side applications, such as Trimble Connect Web, Trimble Connect Mobile, and Trimble Connect Desktop. Web and Desktop application have their own APIs. 

Web API

The Trimble Connect for Web API is for managing the embedded web viewer. The 3D viewer JavaScript API can be used to embed and manipulate the Trimble Connect web viewer. The web viewer could be embedded into any web based application.

NOTE! We are in the midst of changing our web viewing technologies. Please contact Jussi Ketoja (jussi.ketoja@trimble.com) before the implementation!

Desktop API

The Trimble Connect for Desktop API is for the Windows desktop. Desktop API can be used, for example, to extend and customize Trimble Connect. Trimble Connect for Desktop API is meant to be easy and intuitive to use in order to minimize the required technical background.