To explain the process, we will walk you through the use case of controlling a Nuki Smart Lock 3.0 Pro via an ekey fingerprint scanner. The Nuki Smartlock 3.0 Pro has WLAN and BLE on board, so a Nuki Bridge is not absolutely necessary.
If you use a Nuki Bridge, we recommend using the Bridge HTTP-API.
1: Installation and activation
Make sure that all the devices are ready for use and connected to your network.
2: Nuki Web & Nuki API
Register on api.nuki.io to get access to Nuki Web.
Open the Nuki app and search for “Nuki Web”. Connect your Smart Lock with your account and make it ready for integration.
Open Nuki Web via a browser like Google Chrome and log in.
If the connection within the app was successful, you should now see your device.
Move to API and copy the OAuth2 API key.
Open Swagger UI and use the OAuth2 API key for authorization.
Under “Scopes” select “select all”.
The Smart Lock ID is now required. You can find it in the Swagger UI.
Scroll down until you see “POST/smartlock/{smartlockId}/action/unlock Unlock a smartlock”.
Press “Try it out”, paste your Smart Lock ID and press “Execute”.
Your Smart Lock unlocks itself.
In “Responses” you can see the URL needed for the HTTPS request to unlock the Smart Lock.
The Nuki Smart Lock requires a token if you want to control the device via HTTPS requests.
One option could be the Bearer Token you see on the screenshots above, but this token will expire very fast.
A better option is to generate API tokens in Nuki Web.
The token is visible only immediately after it has been generated. Copy it immediately! Then paste it in the ekey bionyx app under “Authentication”.
3: ekey bionyx app
- Activate the HTTPS requests.
- Add the HTTPS request.
2.1 Make sure you choose the correct method, URL, level of security, authentication and the right access token (as described above).
Paste your token under “Access token” and set an expiry time.
4: FINISH
As long as the fingerprint scanner can reach the Nuki Smart Lock in the local network, the HTTPS request it sends will trigger the Nuki Smart Lock. An internet connection is not needed for daily use, but a stable local network is essential.
Important: Please note that, depending on the method, the data may be sent unencrypted in the home network. ekey does not accept any liability for consequences of any kind.