<- Up: Documentation Home

How to get started with the KNX i-bus® IoT Dashboard API


How to get the rights to use the local REST API on a KNX i-bus® IoT Dashboard Server

Create a user account via the IoT Dashboard Tool who has the right to access the API and upload the project to the device.

How to authorize to the local REST API on a KNX i-bus® IoT Dashboard Server

You can access the API of a physical device in the same network via different tools, e.g. via Postman. In the following example we are showing the access using the Swagger on the box:

  1. Open http://ipadress:port/swagger/ in your webbrowser to see the Swagger Interface
  2. Open the call “api/user/login/” from the list and press “try out”. Edit user/password according to your IoT Dashboard Account
  3. Then click the execute button
  4. Copy the token received as a response (only the value as selected below)
  5. Then unblock API via the “Authorize” button in the right upper corner of the Swagger window.
  6. Please type “Bearer” and paste the token after one space and the press “authorize”.

Now you are authorized to the device and can start using all the other API calls shown at Swagger.