About REST API
The Partner API is based on a RESTful approach (see REST). It features predictable and resource-oriented URLs and uses HTTP response codes to indicate API errors. The API is designed to be easy to use and to support the development of applications that can interact with Bosch HVAC systems.
Why you should use the REST API:
- Integrate Bosch HVAC systems to a third-party application
- Monitor and control HVAC systems remotely on demand
What can I do with the REST API?
See the API Reference for a list of all available endpoints and their descriptions.
The API is not intended to be used for polling data continuously. Instead, it is designed to be used in combination with the webhooks to receive events about changes that occur for accessible HVAC systems.
API versioning on REST API endpoints
This feature is not yet active.
See API versioning for more information.
When an endpoint of the API is called, the latest version is used by default. However, you can specifically request an older supported version (that is still maintained) of the API history by adding the x-api-version header containing the MAJOR version of the API (e.g., x-api-version: 2) to the request. Specifying minor versions (e.g., x-api-version: 2.1) or invalid versions will be rejected.
It's highly recommended to always specify the API version in the request header to ensure that the API behaves as expected. Otherwise, as soon as a new API version is released, the default version will be updated to the latest one, which will lead to unexpected behavior in the client's application.
Which API version was used for successfully processing the request is visible in the returned response: here the x-api-version header is always added with both the Major and Minor versions.