|
|
---
|
|
|
title: Features
|
|
|
---
|
|
|
# API Features Overview
|
|
|
|
|
|
The demo version of the API supports most of the endpoints specified in the KNX IoT 3rd Party API specification. OAuth2 with client credentials and HTTP callback subscriptions are also supported.
|
|
|
|
|
|
This page links to detailed documentation for each area.
|
|
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
## Implemented Endpoints and Features
|
|
|
|
|
|
The demo implements most endpoints and features as described in the official KNX IoT 3rd Party Specification.
|
|
|
For details, see the following page:
|
|
|
[Table of Implemented Endpoints and Features](home/04-Features/01-Implemented-Endpoints-and-features)
|
|
|
Reference: [KNX IoT 3rd Party API Specification](https://support.knx.org/hc/en-us/articles/10386532582930-Downloads)
|
|
|
|
|
|
## Not Implemented Endpoints
|
|
|
|
|
|
Some endpoints are not implemented in the demo version. Most notably:
|
|
|
- `/datapoints/{datapointId}/proxies`
|
|
|
- Timeseries
|
|
|
- WebSocket-based subscriptions
|
|
|
|
|
|
See: [Table of Not Implemented Endpoints and Features](home/04-Features/02-Not-implemented-Endpoints-and-features)
|
|
|
|
|
|
In general the demo version supports most of the specified endpoints, OAuth2 with client credentials and HTTP Callback Subscriptions. For details the pages below are available.
|
|
|
## Additional Endpoints and Features
|
|
|
|
|
|
[[_TOC_]]
|
|
|
The demo includes:
|
|
|
- Two endpoints that are not part of the official specification
|
|
|
- Additional smaller features
|
|
|
|
|
|
See: [Overview and Description of Additional Endpoints and Features](home/04-Features/03-Additional-Endpoints-and-features)
|
|
|
|
|
|
## Additional Notes on Behavior
|
|
|
|
|
|
## Implemented Endpoints and features
|
|
|
Details to implemented Endpoints and features are described in the [Knx IoT 3rd Party Specification](https://support.knx.org/hc/en-us/articles/10386532582930-Downloads).
|
|
|
[Table of implemented endpoints and features](home/04-Features/01-Implemented-Endpoints-and-features)
|
|
|
This section describes certain behaviors of the API that go beyond the core specification.
|
|
|
See: [Behavior Details](home/04-Features/04-Behaviour-Details)
|
|
|
|
|
|
## Not implemented Endpoints
|
|
|
Most notably the endpoint /datapoints/{datapointId}/proxies, timeseries and the websocket based subscription are not implemented.
|
|
|
[Table of not implemented endpoints and features](home/04-Features/02-Not-implemented-Endpoints-and-features)
|
|
|
## Non-Compliant Behavior
|
|
|
|
|
|
## Additional Endpoints and features
|
|
|
There are two not specified endpoints available aswell as additional smaller additional elements.
|
|
|
[Overview and description of additional endpoints and features](home/04-Features/03-Additional-Endpoints-and-features)
|
|
|
The demo version differs from the specification in a few aspects.
|
|
|
See: [Overview of Non-Compliant Behavior](home/04-Features/05-Non-compliant-behaviour)
|
|
|
|
|
|
## Additional notes on behaviour
|
|
|
More detailed description of API behaviour in some aspects
|
|
|
[Behaviour Details](home/04-Features/04-Behaviour-Details)
|
|
|
## Certificates in the Demo
|
|
|
|
|
|
## Non compliant behaviour
|
|
|
The demo version does differ from specification in a few aspects
|
|
|
[Overview of non compliant behaviour](home/04-Features/05-Non-compliant-behaviour)
|
|
|
The demo uses a self-signed certificate for Idevid and supports Ldevid.
|
|
|
More information: [Certificates](home/04-Features/06-Certificates)
|
|
|
|
|
|
## Certificates in the demo
|
|
|
The demo version uses a self signed certificate for Idevid and supports using Ldevid
|
|
|
[More](home/04-Features/06-Certificates)
|
|
|
## Demonstration View
|
|
|
|
|
|
## Demonstration view
|
|
|
The configuration interface contains a demonstration view easily to inspect API like output of installation resources.
|
|
|
[More](home/04-Features/07-Demonstration-View) |
|
|
\ No newline at end of file |
|
|
The configuration interface includes a demonstration view to inspect API-like outputs of installation resources.
|
|
|
More information: [Demonstration View](home/04-Features/07-Demonstration-View) |
|
|
\ No newline at end of file |