Skip to content
API Cloud

Add an API proxy

API proxies decouple the app-facing API from your backend services, shielding those apps from backend code changes. You create and configure an API proxy using the following tasks:

After adding and deploying your proxy, you can create an API Product.

To add an API proxy:

  1. From the left menu in the Trimble Developer Console, select API Management > API Proxies.

  2. On the Team API home page, in the top right corner select + ADD PROXY. The Add New API page displays.

  3. On the Add API page, enter the API Details as follows:

    • Name: This is the name of the API such as ProfileX.
    • Namespace: Namespace is a method of tagging API proxies by Trimble applications or products such as Sketchup, Tekla and so-on. For more details, see Add a Namespace.
    • Version: This is the version number of the published API.
    • Basepath: The basepath is part of the URL used to make requests to your API, such as /profilex proxy. Another example: Consumption URL displays the sample consumption URL of your API when it’s available after successfully publishing it.
    • Scope Prefix: Name of the resource server application that is registered in identity for the proxy. The Scope Prefix defaults to the API Proxy name. However, you can edit this field. This field helps API publishers create applications (separate entries for pre-prod and prod) directly without using the Application option. This field is introduced to restrict application usage in future release cycles.

  4. Click Create to create an API proxy. The API Proxy is created in the specified name. Continue to configure the environment endpoints.

  5. In the created API Proxy, the tabs PRE PROD and PROD list the environments of the proxy. Select the respective environments to configure Target Endpoint for Dev Environment, QA Environment, Stage Environment, or Prod Environment.

  6. In the environment you wish to deploy, click CONFIGURE. The Configure button appears only if the configuration for deployment hasn’t been set yet. The Deployment Configuration dialog box displays.

  7. Enter the Target Endpoint URL, and select DEPLOY CHANGES.

    The deployed endpoints are a combination of the Namespace and the Basepath that you entered on the Create Proxy Page. The Namespace will be in lowercase and spacing is replaced by a dash.

    For example: https://cloud.dev.api.trimblecloud.com/Trimble-Foundation-Products/demoproxy/1.0, Trimble-Foundation-Products indicates the Namespace as software application product, and demoproxy represents the Basepath. If there is no Namespace with the team, you won’t be able to add a proxy.

  8. Select Save to continue and proceed with enabling basic threat detection.

    To enable basic threat detection: (DEPRECATED)

    You enable threat detection for the deployed environment in the Security Configuration section.

    1. Select the Basic threat detection and request filtering option.

    2. Select Save and continue with enabling SSL configuration

      security configuration section

    To enable SSL configuration: (DEPRECATED)

    You enable the TLS authentication option using the SSL configuration section. There are three TLS options in the SSL Configuration section.

    1. Select the One Way TLS option.
    2. Select Save and continue with Scope Configuration.

    To set up the scope configuration:

Continue with Creating an API .