Thema "API usage questions (2)" in Getting started programming with the Viessmann API

API usage questions (2)

JueBag — Wed, 23 Jun 2021 10:06:04 GMT

After getting my API-Token (and refreshing it) I stumbled on the following questions:

-Since the number of API-Calls are limited the use a single call for each requested value is not the intended way, how shall we concentate multiple requests in one API-Call? An example of such a request on the Portal would help users to create such calls, which in turn would reduce the load on your server.

-Currently I am using

getHeatingBurnerStatistics("hours") and

getHeatingBurnerStatistics("starts"), however both are not listed on the Developer Portal (Tab IOT). Are these the ones that are no longes accesible in the new API.

Betreff: API usage questions (2)

phildaub23 — Wed, 23 Jun 2021 14:02:59 GMT

I would second that request, as those are some of the most important properties of a heating system - how often did the burner start and how long did it run, as well as ideally also the current modulation of the burner.

heating.burner.modulation

heating.burner.statistics.hours

heating.burner.statistics.starts

Please enable access to those simple three number values for the Developer Portal API Keys - thanks a lot in advance!

Betreff: API usage questions (2)

JueBag — Wed, 23 Jun 2021 14:44:57 GMT

@phildaub23

Do you have an idea how to concentate several API Calls or shall we allways call for all features (I don't think/hope so).

Betreff: API usage questions (2)

phildaub23 — Wed, 23 Jun 2021 14:47:11 GMT

@JueBag yes sure, just call the device features api and you get all sensor values of your device at once in one single request.

Betreff: API usage questions (2)

phildaub23 — Wed, 23 Jun 2021 14:52:06 GMT

@JueBag or did I understand you wrong? If you need only a few specific values and not everything all the time, you can filter with a regex in the request, like described in the API documentation:

regex
heating.circuits.%5b0-2%5d.operating.programs.\w+$
regular expression query for returning only matched features

Betreff: API usage questions (2)

JueBag — Wed, 23 Jun 2021 14:53:21 GMT

Thanks for the answer, however I was hoping for another answer (from Viessmann!). IMHO most users won't need all those data points (for me its only 91). That (desired?) procedure will be causing unneccessary load, wasn't that reason to come up with an API limit?

Betreff: API usage questions (2)

JueBag — Wed, 23 Jun 2021 14:59:48 GMT

I migth have missunderstood that part of the docs.

Is that filtering with regex working on the request (i.e. really limiting what is sent to me), I (miss?)understood that as filtering the response.

Betreff: API usage questions (2)

phildaub23 — Wed, 23 Jun 2021 15:03:20 GMT

Yes you understood that right, it filters the response.

Did you try it? You can do ranges, wildcards, or select multiple different data points via regex "or" operators.

if you need lets say those three features:

heating.solar.pumps.circuit
heating.solar.sensors.temperature.collector
heating.solar.sensors.temperature.dhw

you can request it via the regex:

heating.solar.(pumps.circuit|sensors.(temperature.collector|temperature.dhw))

This allows you to "concentate several API Calls"

Betreff: API usage questions (2)

JueBag — Wed, 23 Jun 2021 15:15:32 GMT

Thanks for those insights.

If its really filtering on the received response ( in other words I do get the whole answer) I'll probaly stick with parsing the JSON string.

Betreff: API usage questions (2)

phildaub23 — Wed, 23 Jun 2021 15:19:20 GMT

No, you do not get the whole answer, you get only those data points you are interested in. Also, this (much shorter) response also needs less data transfer of course. The response has to be JSON parsed anyways, the only difference is whether you are getting one huge JSON or a much smaller JSON that is only containing interesting data.

Betreff: API usage questions (2)

JueBag — Wed, 23 Jun 2021 15:36:02 GMT

Now I got! (.stupid.me!)

Could I ask you for an example call, because I do not understand how to do this concetation with REGEX.

The example in the docs just show

https://api.viessmann.com/iot/v1/equipment/installations/{installationId}/gateways/{gatewaySerial}/devices/{deviceId}/features{?regex,filter}

The problem is what to put in for bold part.

-the term "features" is needed, but no "/" afterwards?

-Is the "?" and/or the term "regex" needed?

- Would such:

heating.solar.(pumps.circuit|sensors.(temperature.collector|temperature.dhw))

be a correct concentated input for the filter?

Betreff: API usage questions (2)

phildaub23 — Wed, 23 Jun 2021 15:55:58 GMT

I just tried it out and works like a charm:

https://api.viessmann.com/iot/v1/equipment/installations/{installationId}/gateways/{gatewayId}/devices/{deviceId}/features?regex=heating.solar.%28pumps.circuit%7Csensors.temperature.%28collector%7Cdhw%29%29

I don't know if it is necessary to urlencode all the brackets but it certainly doesn't hurt.

Edit: the url is cropped when I post it - it ends with:

?regex=heating.solar.%28pumps.circuit%7Csensors.temperature.%28collector%7Cdhw%29%29

Betreff: API usage questions (2)

JueBag — Wed, 23 Jun 2021 16:05:46 GMT

Thank you very much!

I'll incooperate that into my requests.

Since I'm coming from the openHAB community, I'll post my (more correctly yours!) findings in a tutorial thread on the openHAB forum.

Betreff: API usage questions (2)

phildaub23 — Wed, 23 Jun 2021 16:18:51 GMT

Glad I could help!