Introduction
To provide a world-class developer experience, Trimble APIs must follow a consistent standard. This document represents Trimble’s API standard governing all published HTTP APIs.
The Trimble API Standard is a living standard with named releases.
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.
Please view the Appendix for background on the philosophy behind the Trimble API Standard.
This document applies specifically to HTTP APIs. Standards for other API types, such as GraphQL, may be defined later. Interested readers should refer to the Trimble Developer Guidelines for more information.
Some Trimble APIs may need to comply with third party requirements that do not align with this Standard. APIs that need to align with other standards are expected to follow this Standard as closely as possible, with deviations documented and reviewed. Compliance with third party integrations that cannot follow this Standard should be accomplished with proxy APIs that are layered on top of APIs compliant with this Standard whenever possible.
For more information on migrating existing APIs to the standard, please consult Migrating APIs to the Trimble API Standard in the Appendix.