Skip to content
API Cloud

Create New API

Create New API

This document outlines the process for creating a new API within the Trimble Cloud Console. Users with an ‘Administrator/User’ role belonging to Trimble/Internal teams can access this feature via the ‘Apis’ menu. Creating an API here also acts as creating an application.

API Creation Form

When clicking on Create New API opens a form with several fields to configure a new API. Fields marked with an asterisk (*) are mandatory.

  • Display Name: The name of the API as it will be displayed in the UI for easy identification.

  • Base Path: This value is appended to the consumption or deployment URL. For example, if you enter /cloud/maps as the base path, the full consumption URL will follow this structure: <domain>/cloud/maps/<version>. A concrete example is: https://cloud.stage.api.trimblecloud.com/cloud/maps/v1

  • ApplicationId/Scope Prefix: This field defines the application’s name. Scopes can be configured and associated with this application.

  • Description: A brief description of the API for reference and documentation purposes.

Create New API

Grant Types

Grant types can be selected during the creation process or modified later on the API’s summary page based on the Permission Matrix. This configuration defines the application’s grant types.

  • Authorization Code Grant: Used for web and mobile applications.
  • Client Credentials Grant: Used for server-to-server communication.
  • Device Code: Used for devices with limited input capabilities.
  • Use Refresh Tokens: Allows for obtaining new access tokens without re-authenticating.
  • Token Exchange: A method for exchanging one token for another.

After filling out the mandatory fields and selecting the desired grant types, click Create to finalize the API.