Seam provides a universal API to connect and control many brands of locks, including Nuki. This guide provides a rapid introduction to connecting and controlling your Nuki locks using the Seam API. To learn more about other device brands supported by the Seam API, such as Yale, Schlage, and August, head over to our integration page.
1 — Install Seam SDK
Seam provides client libraries for many languages, such as JavaScript, Python, Ruby, PHP, and others, as well as a Postman collection and OpenAPI spec.
This guide uses a Sandbox Workspace. Only virtual devices can be connected. If you need to connect a real Nuki device, use a non-sandbox workspace and API key.
2 — Link Your Nuki Account with Seam
To control your Nuki locks via the Seam API, you must first authorize your Seam workspace against your Nuki KS account. To do so, Seam provides Connect Webviews: pre-built UX flows that walk you through authorizing your application to control your Nuki sites.
Request a Connect Webview
// Use Seam SDK to create a connect webview with the provider nukiconstcreatedConnectWebview=awaitseam.connectWebviews.create({ accepted_providers: ["nuki"]});// Print the created webview URLconsole.log(createdConnectWebview.url);
# Create a webview with Nuki as the providercreated_webview = seam.connect_webviews.create(accepted_providers=["nuki"])# Assert that login is not yet successfulassert created_webview.login_successful isFalse# Print the URL of the webviewprint(created_webview.url)
# Create a connect webview with the provider "nuki"created_webview = seam.connect_webviews.create(accepted_providers: ["nuki"])# The webview will not be logged in, which can be confirmedraise'Login should not be succesful'unless!created_webview.login_successful# Retrieve and print out the url of the webviewputs created_webview.url
<?php// initiate the SDK client, you should replace this with your SDK client init portion$seam =newSeamSeamClient("YOUR_API_KEY");// create a connect webview with provider nuki$connect_webview = $seam->connect_webviews->create(['accepted_providers'=> ['nuki']]);// check if the login was successfulassert($connect_webview->login_successful ===false);// print the connect webview URLprint($connect_webview->url);?>
Authorize Your Workspace
Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Nuki sandbox test accounts credentials below:
email: john@example.com
password: 1234
Confirm the Connect Webview was successful by querying its status:
After a Nuki account is linked with Seam, you can retrieve devices for this Nuki account. The Seam API exposes most of the device's properties such as battery level.
Next, you can perform the basic action of locking and unlocking a door.
Unlock a door
POSThttps://connect.getseam.com/locks/unlock_door
Request Body
Name
Type
Description
device_id
String
# lock the doorseam.locks.lock_door(some_lock)updated_lock = seam.locks.get(some_lock.device_id)assert updated_lock.properties["locked"]isTrue# Now unlock the doorseam.locks.unlock_door(some_lock)updated_lock = seam.locks.get(some_lock.device_id)assert updated_lock.properties["locked"]isFalse
// lock the doorawaitseam.locks.lockDoor(someLock.device_id)constupdatedLock=awaitseam.locks.get(someLock.device_id)console.log(updatedLock.properties.locked) // true// unlock the doorawaitseam.locks.unlockDoor(someLock.device_id)updatedLock =awaitseam.locks.get(someLock.device_id)console.log(updatedLock.properties.locked) // false
# lock the doorseam.locks.lock_door(some_lock)updated_lock = seam.locks.get(some_lock.device_id)puts updated_lock.properties['locked'] # true# unlock the doorseam.locks.unlock_door(some_lock)updated_lock = seam.locks.get(some_lock.device_id)puts updated_lock.properties['locked'] # false
useSeam\SeamClient;$seam =newSeamClient('YOUR_API_KEY');$some_lock = $seam->locks->list()[0];# unlock the door$seam->locks->unlock_door($lock->device_id);# lock the door$seam->locks->lock_door($lock->device_id);
5 — Setting Access Code on Nuki Lock
Some Nuki locks also have a keypad paired to them to program access codes. These codes can then be entered to unlock a Nuki lock.
The Seam API makes it easy to program both ongoing codes and timebound codes on a Nuki lock. You can find out more about Nuki lock access code in our core concept section on access codes.
Nuki does not let you create a code starting with the digits "12". Codes cannot contain the digit 0.
# create an ongoing codeseam.access_codes.create( device=some_lock, code="492332", name="Personal Access Code")# create a timebound codeseam.access_codes.create( device=some_lock, code="498882", name="My Temp Access Code", starts_at="2028-08-12T19:23:42+0000", ends_at="2028-08-13T19:23:42+0000")# you can use a device or a device_id as the "device" parameterseam.access_codes.list(device=some_lock)
// create an ongoing codeawaitseam.accessCodes.create({ device_id:someLock.device_id, code:"123456", name:"Personal Access Code",})// create a timebound codeawaitseam.accessCodes.create({ device_id:someLock.device_id, code:"888888", name:"My Temp Access Code", starts_at:"2028-11-12T19:23:42+0000", ends_at:"2028-11-13T19:23:42+0000",})// use a device_id as the "device_id" parameterawaitseam.accessCodes.list({ device_id:someLock.device_id,})
# create an ongoing codeseam.access_codes.create( device_id: some_lock.device_id, code: '123456', name: 'Personal Access Code')# create a timebound codeseam.access_codes.create( device_id: some_lock.device_id, code: '888888', name: 'My Temp Access Code', starts_at: '2028-08-12T19:23:42+0000', ends_at: '2028-08-13T19:23:42+0000')# you can use a device or a device_id as the "device" parameterseam.access_codes.list(some_lock)
Now that you've completed this guide, you can try to connect a real Nuki device. To do so, make sure to switch to a non-sandbox workspace and API key as real devices cannot be connected to sandbox workspaces.
In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: