diff --git a/_includes/user-menu.html b/_includes/user-menu.html index 0c7ebddf3..2dd5ca97d 100644 --- a/_includes/user-menu.html +++ b/_includes/user-menu.html @@ -77,6 +77,8 @@
  • Amazon Echo
  • ImperiHome
  • IFTTT (external)
  • +
    +
  • openHAB REST API
  • User Interfaces diff --git a/configuration/restdocs.md b/configuration/restdocs.md new file mode 100644 index 000000000..606b23628 --- /dev/null +++ b/configuration/restdocs.md @@ -0,0 +1,20 @@ +--- +layout: documentation +title: openHAB REST API +--- + +{% include base.html %} + +# openHAB REST API + +The REST API of openHAB serves different purposes. +It can be used to integrate openHAB with other systems as it allows read access to items and item states as well as status updates or the sending of commands for items. +Furthermore, it gives access to the sitemaps, so that it is the interface to be used by remote user interfaces (e.g. fat clients or javascript based web clients). +The REST API also supports server-push, so you can subscribe yourself on change notification for certain resources. + +For further details, please check: + +* [The openHAB 1.x wiki REST API article](https://github.com/openhab/openhab/wiki/REST-API) +* The interactive REST API documentation in your local installation, available through the openHAB 2 portal page + +{% include contribution-wanted.html %}