How-To Guides
Get a Trimble ID
Section titled “Get a Trimble ID”Before you begin, ensure you have the following:
- Trimble ID (TID): All access to the Developer Console is managed through TID. If you do not have a TID, you would need to create one in order to log into the Console.
Access the Developer Console
Section titled “Access the Developer Console”- Users that are already part of an IAM account can log in using their existing credentials.
- Users that are not part of an IAM account can sign up and an account will be created automatically based on the information on your TID account upon sign-up.
- Access to the Developer Console does not require any product licensing or entitlement.
- Applications belong to teams, which belong to IAM accounts.
- You must review and accept the Terms and Conditions during the onboarding process.
Create team
Section titled “Create team”A Team in the Trimble Developer Console is a shared workspace where members of an organization can collaboratively manage applications and securely access integration credentials. All applications are owned at the team level.
Currently, each IAM account supports one team only.
To Create a Team:
- If a developer is associated with a single account and no team has been created under that account, they can create a team using the Team Creation Wizard after logging in. Enter a valid Team Name and Team Description, then select Create Team.
- If a developer is associated with more than one account, they can use the Account Name dropdown in the Team Creation Wizard to select the account where the team should be created. Then enter a valid Team Name and Team Description, and select Create Team.
Once the team gets created, the creator of the team becomes a “Team Admin” and can add additional members to the team by clicking the “Add member” button under Team > Team Members tab.
A team member can be added in the team and granted any of the roles described below:
Team roles and permissions
Section titled “Team roles and permissions”Understanding roles is critical for managing your application’s lifecycle:
| Role | Capabilities |
|---|---|
| Admin | Invite team members, enable product sandboxes, authorize applications on an account level. |
| Developer | A developer may create, delete, and edit their own applications, including client secret rotation and callback URL management. They may not invite or delete team members or create new sandbox environments. |
Invite users to a Team
Section titled “Invite users to a Team”Only an Admin can invite additional developers to a Team.
To invite users to a team, admins need to navigate to Team Members > Add Member > Enter email address > Select the role in the team > Add member
The invited user receives an email with a link to the Console, where they can accept or decline the invitation.
Admins can also add users who are not part of the IAM account into a team and grant them either an Admin or a Developer role in the team. But in that case they are considered as “Guest Users”. Guest users will not have the ability to do a few things in the Developer Console and should reach out to the Account Admin to get added to the Account.
Guest Users cannot:
- Create new teams under the IAM account
- Publish apps to Marketplace
- Cannot access Sandboxes for testing
Join Team
Section titled “Join Team”Developers can join an existing team in their account by selecting Request to Join after logging in to the Console.
If the developer is associated with more than one account, they must first select the account that contains the team they want to join, then select Request to Join.
If a developer has already created or joined a team and wants to create or join additional teams under other accounts they are associated with, they can navigate to Team > Browse all teams > Add team.
After selecting a team and submitting a join request, a Team Admin must approve it before you can become a member.
Create your application
Section titled “Create your application”Applications in the Trimble Developer Console act as the secure container for your API credentials and govern how your code interacts with Trimble products. By creating an app, you generate the unique identity your integration needs to authenticate and access data.
Before you begin:
- Create a Team: Ensure you have created or joined a team workspace, as all applications must belong to a collaborative team.
- Identify your API: Know which Trimble product (e.g., ProjectSight or Trimble Connect) you intend to integrate with.
Start the app wizard
Section titled “Start the app wizard”Navigate to your team’s Applications tab and click Create App to launch the setup wizard.
Add app details
Section titled “Add app details”Provide a unique Name and a brief Description for your application. These details help to identify the purpose of the integration during the authorization process.
Select an API Product
Section titled “Select an API Product”An API Product is a subscription that allows your application to securely access data and services from a specific Trimble product (such as ProjectSight or Trimble Connect). It enables your app to authenticate and interact with Trimble APIs to perform tasks and integrations.
Choose the specific Trimble product you wish to integrate with from the provided list.
Choose your application type
Section titled “Choose your application type”Select the application type that matches your integration’s architecture:
- End-User App: For web or mobile apps where a user signs in (uses Authorization Code Grant).
- Server-to-Server App: For back-end services or scripts running without user interaction (uses Client Credentials Grant). These type of applications cannot be published to Trimble Marketplace by partner developers.
- Extension App: Specifically for embedding UI extensions within products like Trimble Connect.
Each API Product may support different application types. Review the product-specific documentation to understand which application types are available and choose the right option for your integration.
Retrieve your credentials
Section titled “Retrieve your credentials”Once your application gets created, navigate to the Credentials & Grant Type tab in the application overview. Here you will find your:
- Client ID: Your app’s public identifier.
- Client Secret: A private key used to authenticate your API calls.
Delete an Application
Section titled “Delete an Application”If an application is no longer needed, you can remove it to keep your workspace organized. Deleting an application permanently retires its credentials and immediately stops its ability to receive successful responses from Trimble APIs.
You can delete an application in two ways within the Developer Console.
- From the Application List: Navigate to Team > Applications, locate your app in the list, and select Delete App from the three-dot menu (…) on the right.
- From the App Details Page: Select your application from the list to open the App Details page, then click the Delete Application button.
Important Restrictions
To maintain the integrity of the ecosystem, certain applications are protected from deletion. You cannot delete an application from the Developer Console if it has entered the Marketplace lifecycle.
Applications with the following statuses cannot be deleted:
- Pushed: The app has been submitted for Marketplace consideration.
- In Review: The Trimble Marketplace team is currently auditing the application.
- Published: The app is live and available on the Marketplace.
Perform an initial API call
Section titled “Perform an initial API call”If not yet familiar with Trimble ID authentication, view our guide on how to perform an initial API transaction. It provides direction on interactive user login, getting a token, and calling an endpoint with both Trimble ID and Trimble Connect API examples included (which can be applied to other API products in the Developer Console, too).
Test your application in sandbox
Section titled “Test your application in sandbox”Authorize your application to access data
Section titled “Authorize your application to access data”List your app on Trimble Marketplace
Section titled “List your app on Trimble Marketplace”Listing your application on the Trimble Marketplace allows you to distribute your application across the Trimble ecosystem. Learn more about becoming a Technology Partner.
Prerequisites
Section titled “Prerequisites”In order to publish to the Trimble Marketplace, you first must be a Trimble Technology Partner.
Push Your Application to Marketplace
Before listing an application, ensure your setup meets the following requirements:
- Technology Partner Account: The application must be created under an account registered as a Trimble Technology Partner.
- Account Permissions: Guest users cannot push applications. You must be added to a specific company account by the Account Owner in order to be able to Push apps to the Marketplace.
- Eligible Application Types: Only End-User Apps (including Extension Apps) can be published to the Marketplace. Server-to-Server Apps are for internal background processes and are ineligible.
If your account is verified as a Marketplace enabled Technology Partner, you can submit individual applications:
- Navigate to Applications and select the specific app you want to publish.
- Select the Marketplace tab from the left sidebar of your application overview page.
- Click Push to Marketplace.
- The application status updates to Pushed.
Important Restriction: Once an application is Pushed, it enters the Marketplace lifecycle and cannot be deleted from the Developer Console.
Manage Listing in Marketplace
After pushing your application, a draft product is created in the Marketplace. You must have a valid account ID in the Trimble Marketplace
- On the app’s Marketplace tab in the Developer Console, click Manage Listing.
- You will be redirected to the Marketplace Partner Portal. Sign in to the Marketplace Partner Portal with your account credentials.
- Verify Product Listing: Confirm that the Product pushed shows up in Trimble Marketplace with the Splash Title (Application Name), Splash Description (Application Description) and the name of your account/company fields populated correctly.
- Conclude Beta Phase: After this step, no additional actions need to be taken on Developer Console or Marketplace Partner Portal for this Beta Phase.
- Send Email: Send an email to robyn_davis@trimble.com with the name of your application with the subject “Trimble Developer - Beta Testing”
Account Owner Access
Section titled “Account Owner Access”In order to perform certain actions on the platform (e.g. creating a team or enabling a client application for use with an API product), an account owner (or a secondary account owner) will be needed. If you do not know who has owner-level access to an account, the Trimble Admin Console may allow you to view existing account owners filtering by role on the users page within the account. If that function is not available, no account owner is listed, or if the owner listed is no longer valid, let us know.
To enable us to help more efficiently, choose the Sign In and Product Access and Other Access Issues options on top of this form. In the description, indicate that you need help adding an owner to your account, the name of the account (including any likely variations if unknown), the account ID (if known, which can be found in the URL of the Admin Console), and the full name and email address of the user to be the account owner. Trimble Global Support will follow up to help provide the access needed.