Skip to content

feat: switch Viessmann API to v2#540

Merged
CFenner merged 1 commit intoopenviess:masterfrom
MHann1917:master
Apr 10, 2025
Merged

feat: switch Viessmann API to v2#540
CFenner merged 1 commit intoopenviess:masterfrom
MHann1917:master

Conversation

@MHann1917
Copy link
Copy Markdown
Contributor

Switch to v2 of IoT Features API, as v1 will be deprecated End of month. Change is described in the API Documentation: https://documentation.viessmann.com/static/changelog

Switch to v2 of IoT Features API, as v1 will be deprecated End of month. Change is described in the API Documentation: https://documentation.viessmann.com/static/changelog
@CFenner
Copy link
Copy Markdown
Member

CFenner commented Apr 3, 2025

Thanks for the fix ❤️

Are you aware of any endpoints that break?

@CFenner
Copy link
Copy Markdown
Member

CFenner commented Apr 3, 2025

API Endpoints Update

We are replacing several API endpoints with their current versions. This includes:

/iot/v1/equipment/installations/{installationId}/gateways/{gatewaySerial}/devices/{deviceId}/features replaced with /iot/v2/features/installations/{installationId}/gateways/{gatewaySerial}/devices/{deviceId}/features
/iot/v1/equipment/installations/{installationId}/gateways/{gatewaySerial}/features replaced with /iot/v2/features/installations/{installationId}/gateways/{gatewaySerial}/features
/iot/v1/equipment/installations/{installationId}/features replaced with /iot/v2/features/installations/{installationId}/features
/iot/v1/features replaced with /iot/v2/features
Important Notes:

The previous versions (/iot/v1/...) of the listed endpoints will be removed entirely on April 30, 2025. As a result, any existing integrations using these endpoints will cease to function.
The new endpoints (/iot/v2/...) function identically to their predecessors. There are no changes to the request parameters, response formats, or any other functional aspects.

We would also need to replace the endpoints equipment > features if I see it correctly.

@MHann1917
Copy link
Copy Markdown
Contributor Author

@CFenner for requesting gateway / device features, the endpoints /iot/v1/features as well as /iot/v1/equipment/installations/{installationId}/gateways/{gatewaySerial}/devices/{deviceId}/features (if still being used) should not be used anymore as they will be removed. It is important to use /iot/v2/features to request the gateway / device features. The response itself should not change though.
Note that the endpoint for requesting the information of an installation with /iot/v1/equipment/installations?includeGateways=true is not affected by this change.
I hope this helps. Otherwise let me know I am happy to support further on this change.
Regards
Michael

@CFenner
Copy link
Copy Markdown
Member

CFenner commented Apr 8, 2025

So should we use https://api.viessmann.com/iot/v1/equipment/installations or is there also a https://api.viessmann.com/iot/v2/equipment/installations?

@CFenner CFenner changed the title Update PyViCareAbstractOAuthManager.py feat(api): switch to next API version v2 Apr 10, 2025
@CFenner
Copy link
Copy Markdown
Member

CFenner commented Apr 10, 2025

@MHann1917 in the docs there is just the v1 endpoint listed for the installations. Maybe you can update this.

Bildschirmfoto 2025-04-10 um 22 16 35

Anyhow, I tested https://api.viessmann.com/iot/v2/equipment/installations which seems also to be there. So I will make the switch now to v2 for all requests.

@CFenner CFenner changed the title feat(api): switch to next API version v2 feat(api): switch Viessmann API to v2 Apr 10, 2025
@CFenner CFenner changed the title feat(api): switch Viessmann API to v2 feat: switch Viessmann API to v2 Apr 10, 2025
@CFenner CFenner merged commit db843aa into openviess:master Apr 10, 2025
9 checks passed
@MHann1917
Copy link
Copy Markdown
Contributor Author

@CFenner I checked with the colleagues and indeed it is possible to also switch the EQUIPMENT API to v2. The v2 is ready but not yet published. But since it can already be used and the plan is to deprecate the v1 in the future, we will update the documentation already now. So you already did a change that would have come in the future :)
Thanks for the hint and merging the pull request!

@ignazhabibi
Copy link
Copy Markdown
Contributor

@MHann1917: is there any chance that someone at Viessmann fixes this: home-assistant/core#130273 (comment)

Many people here and in the Viessmann community are complaining about this issue and help themselves with reloading the Kommunikationsmodul every day…

So if you are the API PM you may can take care of this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants