Getting Started with Profiles

This section of the guide provides tips and resources to help you integrate your application with Profiles and start using its services. You can read the materials in this guide sequentially or dive into any topics using the side navigation bar.

Use Profiles to create profile entities like user, account, project, or other contextual entities that are common across applications. By default, Profiles provides predefined global profile types that are common across Trimble. However, user accounts are created through Trimble Identity.

Getting Started

The Profiles API is available through Trimble Cloud Console. The following steps are a short set of prerequisites to using the API.

Prerequisites

Use the following getting started guides to create an application, subscribe to an API, and generate an access token:

1. Create an application in Trimble Cloud Console.

2. Subscribe to the Profiles API.

   Environment	API Product	Proxy Name
   Production	Profiles	Choose the appropriate proxy based on your region choice
   Staging	Profiles	Choose the appropriate proxy based on your region choice

3. Generate an access token.

4. Begin calling the Profiles API using your access token in the header of your API calls.

Listing the Profile Types

The available profile types can be accessed using the following API calls:

• List profile types
• Get profile type by name

You can create a profile entity only when the corresponding profile type is available. For example, to create a project entity, the project profile type must be available in the Trimble Global Space. If the profile type, that you are looking for, is not available in the global space, contact the Trimble Support Team.

For more information on managing profile types, profile instances , and relations, refer to the API Reference.