Hydrawise API change

[Nick-Adams-AU]

Hi,

The Home Assistant Hydrawise integration that utilises this repo seems to have broken in the last 24-48 hours:

home-assistant/core#31957

Looking into the error, it seems as though the Hydrawise API format may have changed recently. Unfortunately I can't find the previous API documentation so I'm only guessing from the errors.

Are you able to confirm if the current API matches your previous API documentation?

[santoal]

That is correct. Json response format has changed. Looks like there is a v2 if the api which is completely different too. I’m not using this code but have adapted for Homeseer

[Nick-Adams-AU]

I have received new API documents from Hydrawise:

Hydrawise REST API.pdf

While it is frustrating that they have made unannounced changes to their API, it is appreciated that this API is now, according to Hunter, "updated, maintained and tested".

[santoal]

I received the same info. Functionality has been cut back significantly. Also the setzone function doesn't seem to work for me as documented.

[edif30]

What has been cut back? You can still make API calls to turn on and off zones for x minutes. Besides rain click sensor (which really didn't work) what functionality went away?

[Nick-Adams-AU]

I'm not sure any features have been removed but there are some fields like name and user_id that have been removed. The structure of the relays/zones has also changed substantially.

Frustratingly, Hunter don't seem to care or understand that doing this without notice is going to break things.

[santoal]

Yes - lots of fields in the response which I was using are gone. Agreed on them making changes without notice. Its part of accepting the conditions of use with the REST API. I'm beginning to think v2 will be a better way to go. I managed to get some basics working through this interface here:
https://app.hydrawise.com/api/v2/graph/explore
you need to authenticate a session first by logging in through the same browser instance. Try:
{
controller(controllerId:****) {
id
lastContactTime{value}
zones {
id
name
icon {
fileName
}
}
}
}
where **** is your controller id. You can pull almost any data you want.

[santoal]

Also - I just alerted them that the setzone REST command doesn't work as documented in v1.4. They said they are looking in to it... either that or I got it wrong.

Update: It appears it is now fixed

[santoal]

I've had a close look at the api now. I can't even figure out a clean way of determining which zone is running. The return json structures have completely changed. I've advocated a roll-back to 1.3 and give users enough time to consider transitioning to v2.

[Nick-Adams-AU]

FYI - they are making changes on the fly. "timestr" was always blank but is now populated.

I've also asked for a rollback and they said that they "had to make major changes due to GDPR and CCPA". This still doesn't explain why they made the change with zero notice. IMHO, rolling back will not happen.

You might be able to detect the running zone by checking relays[n].time == 1.

[edif30]

This was back in April of 2019. I spoke to the guy who I assume runs things over there. I was taken back by this and hoped that things would change. Seems it has not to some degree. Maybe if we all really press the issue they can work with us a bit.

Thank you for your inquiry to access the Hydrawise API.
We are currently rebuilding our API access utilizing OAuth2.

Our Beta version of OAuth2 will soon be released, to a limited number of invited business partners we expect to have full version release in the first half of 2019.

The Hydrawise API will only be provided to business partners.
API access for private use is not scheduled for release until Nov 2019.

When we are ready for your team to work on the integration we will contact you.

This will include our:

• Terms & Conditions of Use (Business Agreement)
• GDPR Privacy Agreement, which must be signed.
  On the return of the signed Agreement, we will provide login details and documentation on using your OAuth2 authorization and the relevant scopes.

Regards

[edif30]

Also, I am mistaken. As of a few days ago when I noticed that I was getting Tracebacks in HA, I could still hit the older API and get all of the same data back via curl. Now that I look at my data, all the older stuff is gone. This really sucks TBH. I'm going to have to wait until I can start using the system when winter breaks in order to test. Hopefully in the meantime things can be sorted out. Huge bummer here.

[Nick-Adams-AU]

@edif30 Can you please remove the Hydrawise staff members personal details?

[edif30]

Just noticed. Honest oversight. Done.

[ptcryan]

Hi All, I have read through the thread but I'm not completely clear what the issue is. When I wrote this I was following API v1.3. The v1.4 above doesn't appear at first glance to be much different. The statusschedule call no longer needs the hours parameter. Any other changes?

Is Hunter saying that the v1.x API is no longer supported? Based on the message above I'm not sure if the v2 API is going to be open to the public. If so that's a very disappointing.

Anyway, if I can figure out what needs to be changed to make the module compatible again I'll be glad to push out a new version.

Oh, and here's Hydrawise API v1.3.pdf. Hard to find online anymore.