Consume an API

You can discover/find APIs in the Cloud Console and subscribe to the API to consume it.

To consume an API:

1. Register your application with Trimble Cloud Console.

   Register your application

   To register your service application in Trimble Cloud Console:

   1. On the left pane select Identity Management > Applications.

   2. On the Applications home page, in the top right corner select + ADD APPLICATION. The Create Application page displays.

   3. In the Application Type section, select one of the following options:

      • Service Application A service application are intended to be used in programmatic workflows or server-server communication.
      • Application Refers to any Trimble application that is intended to be accessed by an end user.

   4. Select Continue to enter the applications details.

      Field	Description
      Application Environment	Select the environment that the applications must be registered to, Prod or Pre-Prod.
      Name	Version of the API published. The name of your client.
      Display Name	Provide a display name of the application.
      Description	Provide a description for the application.

   5. Continue with completing the Configurations section. The fields that display depend on your selection in step 3.

      • For Service Application

      Service Application Grant types - Only Client Credentials Grant displays.

      • For Application

        Field	Description
        Application Grant Types	Select the grant types that will be used for authenticating users or applications.
        Allowed Callback URLS	Refers to the redirect URI of the application after logging into Identity. More than one UL can be added to this field. The total URI length should not exceed 400kb. This field appears only when you select the Authorization Grant type.
        Allowed Logout URLS	The URIs that Identity can redirect to after log out. More than one UL can be added to this field. The total URI length should not exceed 400kb. This field appears only when you select the Authorization Grant type.

   6. Select COMPLETE to save changes.

2. Navigate to Products and log in.

3. Subscribe your application to one or more APIs.

Subscribe your application

To subscribe a service application to the API Cloud Management

1. From the Trimble Cloud Console, on the left pane select Products

2. Search for and select the API Cloud Management API.

   

3. To subscribe your application with the API Cloud Management API, select the +ADD SUBSCRIPTION icon.

   

4. Copy the consumer key and secret.

View client key and secret

You can view the application key and secret from the following screen:

Application quick view

Developer Marketplace