Skip to content
API Cloud

Dev & QA Environment API Refactoring Changes

This document outlines the changes to how APIs are published and managed, simplifying the API proxy structure and standardizing versioning. These updates affect both new and existing APIs in Console.

New API Publishing Workflow

With the new provider workflow, all new APIs will be published with a single staging URL. The concept of separate Dev, QA, and Stage environments as distinct deployment URLs is being retired.

Old structure:

  • Dev: https://cloud.dev.api.trimblecloud.com/
  • QA: https://cloud.qa.api.trimblecloud.com/
  • Stage: https://cloud.stage.api.trimblecloud.com/

New structure:

  • Stage: https://cloud.stage.api.trimblecloud.com/

If you need to differentiate deployments for lower environments (e.g., dev or QA), you should now append suffixes like -dev or -qa to the basepath and display name of your API.

Versioning

New APIs will now adhere to Trimble API Standards for versioning, which only supports whole numbers appended with a v. For example: v1, v2.

The consumption URL for new versions of newly created APIs will be in the following format: https://cloud.stage.api.trimblecloud.com/<basepath>/<version>

Changes to Existing APIs

Existing APIs that were created with multiple environments (Dev, QA, Stage) will be “flattened” to align with the new structure.

  • Each of the existing environment deployments (Dev, QA, Stage) will be separated into individual APIs.
  • The resource server applications associated with each environment, which were previously visible on the old API Proxy summary page, will now function as separate, standalone APIs.
  • Existing consumption URLs will remain supported for these older, flattened APIs to ensure a smooth transition.
  • The existing versioning scheme for these older APIs will also continue to be supported.

When a new version deployment is created for these flattened APIs, the consumption URL will be in this format to maintain environment distinction:

  • If Dev: https://cloud.dev.api.trimblecloud.com/<basepath>/<version>-dev
  • If QA: https://cloud.qa.api.trimblecloud.com/<basepath>/<version>-qa

Before API Restructuring (View: Old API Proxy):

![Before API Restructring](/images/Before Restructuring.png)

After API Restructuring (Old API Proxy Menu):

After API Restructring

After API Restructuring (Apis):

After API Restructring APIs