The Apps URL scheme API offers simple methods to interact with the Nuki App on iOS or Android.
This allows to perform tasks like deeplinking to a specific Smart Lock, passing over invite codes or triggering lock actions via NFC tags.
Calling URL
The Nuki Apps register the URL nuki:// which can be called from within a browser or an app. For NFC Tags the registered URL is https://nuki.io/nfc-handler/
Example:
nuki://
Opens the Nuki App
Services
nuki://name/%name
Jumps to a specific Smart Lock by name and opens its bottom sheet (Same as opening the app and tapping on the Smart Lock). If the name is unknown the app opens with no additional action.
nuki://id/%id
Jumps to a specific Smart Lock based on it’s Nuki ID and opens its bottom sheet (Same as opening the app and tapping on the Smart Lock). If the Nuki ID is unknown the app opens with no additional action.
nuki://invite/%id
Opens the invite code page and directly inserts the provided invite code. If the ID is invalid, it’s not inserted and the invite page is displayed without prefilled invite code.
nuki://delete/%id
Opens the settings page of the Smart Lock with the provided Nuki ID and displays directly the confirmation dialogue for removing a Smart Lock (Sames as opening the app, tapping on it, selecting settings, scrolling down and tapping on “Remove Smart Lock”). If the ID is invalid the app opens with no additional action.
NFC Tags - Tap to unlock
https://nuki.io/nuki-handler/nfc?nukiId=%id
Opens the Nuki App and executes the simple lock action that unlocks the supplied Nuki ID via BLE. The Nuki ID needs to be supplied in decimal format.
It can be written with any NFC Tag writer (e.g. NFC Tools) as URL on a compatible NFC tag (e.g. NXP NTAG215). Adding a second data set with type application and content “io.nuki” might help to open the Nuki App without any dialogues on Android devices.
Latest version of the Apps URL scheme API
Apps URL scheme 2.0 (70 KB)
Terms of Use
Thank you for using one of NUKI’s Application Programming Interfaces. By accessing or using our APIs, you are agreeing to the terms of use of the Nuki APIs.