Releases · homematic-community/XML-API

13 Nov 12:04

0a8e110

XML-API Addon 2.3 Latest

Latest

This is a minor release fixing some minor issues and brings some minor additional features to XML-API (see What's Changed below).

Important

Please note, that if you are currently using XML-API v1 and you are upgrading to XML-API v2, the applications that are using XML-API have to be compatible to XML-API v2 since version 2 introduces some important security related breaking changes compared to XML-API v1 (cf. https://homematic-forum.de/forum/viewtopic.php?f=41&t=77234#p749409).

What's Changed

allow some common URL encodings for description in tokenregister.cgi by @Maik2208 in #83
fixed broken programactions.cgi by @jens-maus via #80, #84

Full Changelog: 2.2...2.3
_{315ecc8c22fa89a10d06a55f71d54c708f152e4e0d2c76317cb81a9b077fa036 xmlapi_addon-2.3.tar.gz}

Contributors

jens-maus and Maik2208

Assets 3

27 Oct 06:36

jens-maus

2.2

902a4f0

XML-API Addon 2.2

This is a minor release fixing some minor issues and brings some minor additional features to XML-API (see What's Changed below).

⚠️ UPDATE NOTICE ⚠️
Please note, that if you are currently using XML-API v1 and you are upgrading to XML-API v2, the applications that are using XML-API have to be compatible to XML-API v2 since version 2 introduces some important security related breaking changes compared to XML-API v1 (cf. https://homematic-forum.de/forum/viewtopic.php?f=41&t=77234#p749409).

What's Changed

statechange.cgi extended by return value "success" by @Maik2208 in #78
devicelist.cgi extended by device_id by @Maik2208 in #79
allow requests from localhost (127.0.0.1) without sid because they are considered safe anyway by @jens-maus
added interface ise id check to devicelist.cgi, mastervalue.cgi,
mastervaluechange.cgi, state.cgi and statelist.cgi by @jens-maus which fixes #68
reworked protocol.cgi to use combinations of Write and WriteXML to output the XML response in a compatible way that even < and > characters are correctly URL encoded by @jens-maus which fixes #27
fixed some minor tcl linter syntax warnings by @jens-maus

New Contributors

@Maik2208 made their first contribution in #78

Full Changelog: 2.1...2.2
_{f4a5c013c0c94b36dcbc4e154bfd0827003889ed50169b89104116bc2c0e8038 xmlapi_addon-2.2.tar.gz}

Contributors

jens-maus and Maik2208

Assets 3

19 Oct 11:40

jens-maus

2.1

8a2112a

XML-API Addon 2.1

This is a bugfixing release fixing some important issues which had been introduced with XML-API 2.0 and brings some minor additional features to the XML-API in general (see Changes below).

Changes:

fixed issue in state.cgi with usage of LastDPActionTime() which is only valid for channels and not for datapoints where LastTimestamp() should be used instead (#76).
reworked mastervalue.cgi and mastervaluechange.cgi to automatically choose the right interface url for the xmlrpc call to query and set the MASTER paramset. This finally should allow to query and set all supported HomeMatic interfaces like HmIP, HmIPW, BidCos-Wired as well as third party interfaces like CuXD, etc (#36).
if only one ise_id is supplied in statechange.cgi, new value will not be splitted by "," chars anymore. This should allow to set states of single ise ids which require "," characters (#25).
add info attribute to sysvarlist.cgi to output DPInfo() of system variables (#58).

Full Changelog: 2.0...2.1
_{e8579d67b7603cbb21e1a8d78b4eca65b5fde141b340a43aa0bec00cc8699bda xmlapi_addon-2.1.tar.gz}

Assets 3

14 Oct 15:09

jens-maus

2.0

b76e520

XML-API Addon 2.0

This is a new major release of the XML-API addon which in addition to some important bugfixes and feature changes also comes with some important security improvements which however also introduce ⚠️ breaking changes ⚠️ compared to XML-API v1.

These security improvements introduce a mandatory, stateless API token mechanism which requires users to first register for a new API token via a new tokenregister.cgi function and then this token key can be used in applications to query the XML-API in its usual way (cf. https://homematic-forum.de/forum/viewtopic.php?f=41&t=77234#p749409). However, every user/developer is requested to read all changes carefully.

Changes:

⚠️ breaking change: complete overhaul of all API functions of XML-API for improved security. Now all API calls are secured by stateless token based authentication forcing users to specify a valid sid=XXXXXXXX security token identifier. For registering, revoking and listing API tokens new tokenregister.cgi, tokenrevoke.cgi and tokenlist.cgi API functions have been added to XML-API. This should greatly improve the general security in a CCU if the XML API addon is installed, especially if the WebUI might be exposed for remote access and thus should address #29 and #31.
rework of the main API description page to contain more detailed documentation about every API function including their supported parameters including links with a forwarded session id identifier.
added new option to run programs with condition check (#60)
unify behaviour regarding virtual remotes and add query parameter (#11)
retrieve min/max values only when sysvar is numeric (#46)
updated mastervalue.cgi to fix #19 (#58)
LastDPActionTime added to output of state.cgi (#52, #47, #48)
add substitution for %5E (^) (#64)
Allow values for combined parameters (#69)