- Contact Us
- Discover LIVISI Home
- Core Concepts
- API Reference
- Innogy Devices Gen. 1
- Your OAuth 2.0 Authorization code
The easiest way to get started as a developer on the LIVISI Home system is to use our Postman Collection . The collection already comes with client credentials to get you started fast. You will need your own LIVISI Home system to login. You can buy your own system on the Medion Webshop . To set up your system, start with the user account registration .
Just want to know what is possible? Check out the API Reference .
Become a developer and get your own client credentials with less restrictions by contacting us.
1. Setting up Postman
- Download Postman on getpostman.com and install it
- Open Postman
- Download the LIVISI Postman Collection and Environment
- Import the LIVISI Postman Collection and Environment
2. Authorize against your own system
In case of our Client API you are limited to the oAuth 2.0 Authorization Code Grant flow. In Postman there are multiple ways to do the Authorization Code Grant flow. We find the following way the easiest.
You can also use the built in feature of Postman for oAuth 2.0. However, since the LIVISI Home accessToken only has a life time of 48h hours it is quite tedious to retrieve a new one. The following way allows you to also store the refreshToken. This way you can retrieve new accessTokens more quickly.
Copy the following URI to a browser of your choosing:
Now log in with your credentials:
After this you will be redirected to the proxy redirectURI
https://developer.services-smarthome.de/auth. Go ahead and copy the request parameter
code from the browser (fyi: it has a lifetime of 5 minutes):
and paste it in the LIVISI Postman Environment:
POST Token - Using code inside the folder
This added a
refreshToken as well as an
accessToken to the Postman Environment. You are now ready to explore the API. Whenever the
accessToken expires, just send
Post Token - Using refresh token in the same folder to refresh it.
3. Send your first request
Device and send
GET - All Devices. This will let your retrieve all devices of your system. Including the hub, physical devices and other functional devices:
4. WebSocket Connection
Some request have an asynchronous response. In these cases you will have check incoming events via the WebSocket connection. Examples:
- Retrieving discovered devices
- Checking rather a state change action was successful (e.g. switching on a light).
Sadly Postman does not support WebSocket connections. However there are many clients that handle WebSocket connections. For example you can use the Chrome extension Simple WebSocket Client .
- Copy the accessToken from the Postman Environment
- Create the following string
wss://api.services-smarthome.de/API/1.1/events?token=<paste your accessToken here>
- Paste it in the URL of Server Location and click OPEN:
You can read the incoming events in the Message Log area.
Explore common and specific API flows in the Tutorials section. Have fun!