Skip to content
API Cloud

Create and deploy a proxy

Before you begin, you must have:

  • Admin or Trimble Developer role to create API Products.

  • An API Product configured in the API Cloud.

To create an API proxy

Login to Stage or Prod Console.

  1. From the left menu in the Trimble Developer Console, select API Management and then select API Proxy.

  2. On the API Proxy home page, in the top right corner click + ADD PROXY. The Create API Proxy page displays.

  3. On the Create Proxy page, enter the API details:

    • 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. Select Create to create an API proxy. The API Proxy is created in the specified name.

  5. In the created API Proxy, notice the two tabs PRE PROD and PROD. These tabs 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, select CONFIGURE. This button appears only if the configuration for deployment hasn’t been set yet. The Deployment Configuration dialog box displays.

To deploy an API Proxy

Deployments in Azure gateway will take about 5 minutes to complete.

Geo Isolation (FKA Geo-Isolation) to Ireland (EU-West) region is available in PROD. Geo-Isolation publishers to publish their APIs on gateways in a specific region. Geo-Isolation is available on Prod environment only and supported on Ireland (EU-West) region.

Deploy API Proxy in Ireland (EU-West) region

  1. Click the Prod tab.

  2. Under Environment, expand Ireland (EU-West)

  3. Select Configure. The Deployment Configuration section displays

  4. Enter the Target Endpoint and then select DEPLOY CHANGES. The deployment status is displayed in the right corner of the Environment section. The Target Endpoint defines the target URL that API Cloud invokes on a request to the API proxy. The URL of the backend service.

  5. Select DEPLOY CHANGES to publish API Proxy in the specific region.

Deploy in all regions

  1. Select your environment tab.

  2. Select CONFIGURE.

    This button appears only if the configuration for deployment hasn’t been already set.

    The Deployment Configuration dialog box displays.

  3. In the Deployment Configuration dialog, enter the Target Endpoint and then select DEPLOY CHANGES. The deployment status is displayed in the right corner of the Environment section. The Target Endpoint defines the target URL that API Cloud invokes on a request to the API proxy. The URL of the backend service.

    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 will be 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.

  4. Select Save to continue.

  5. To add Threat detection to the deployed environment, in the Security Configuration section, select Basic threat detection and request filtering. (DEPRECATED)

  6. Select Save.

  7. To enable TLS options to the deployed environments, in the SSL Configuration section, select One Way TLS. (DEPRECATED)

  8. Select Save.

  9. Complete the Scope Configuration section.

    You configure or view information regarding the application that is directly created for the proxy that you created. Scope grants permission to consume the API Proxy that is created in context with the scope application. You can also view the client ID and secret of the scoped application in this section.

    The completed Scope usage functionality will be enhanced at a future date.