Learn how to connect and control your Salto lock with the Seam API.
Overview
Seam provides a universal API to connect and control many brands of locks. This guide provides a rapid introduction to connecting and controlling your Salto 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.
Note that Salto offers multiple lines of products: Salto Space, Salto KS, and Salto Nebula. This guide is specifically for Salto KS. Salto Space is an on-prem system that is offline. Salto Nebula is not yet fully available as of this writing.
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 Salto site, use a non-sandbox workspace and API key.
2 — Link Your Salto Account with Seam
To control your Salto locks via the Seam API, you must first authorize your Seam workspace against your Salto KS account. To do so, Seam provides Connect Webviews: pre-built UX flows that walk you through authorizing your application to control your Salto sites.
Request a Connect Webview
from seam import Seamseam =Seam()webview = seam.connect_webviews.create(accepted_providers=["salto"])assert webview.login_successful isFalse# Send the webview URL to your userprint(webview.url)
import { Seam } from'seam'constseam=newSeam()const { connect_webview: connectWebview } =awaitseam.connectWebviews.create({ accepted_providers: ['salto'],})console.log(connectWebview.login_successful) // false// Send the webview URL to your userconsole.log(connectWebview.url)
require'seamapi'seam =Seam::Client.new(api_key: 'MY_API_KEY')webview = seam.connect_webviews.create(accepted_providers: %w[salto])puts webview.login_successful # false# Send the webview URL to your userputs webview.url
Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Salto sandbox test accounts credentials below:
email: jane@example.com
password: 1234
Confirm the Connect Webview was successful by querying its status:
After a Salto account is linked with Seam, you can retrieve devices for this Salto 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. Note that Salto disables this functionality by default and requires a special pass-through waiver via Seam. Seam automatically configures your IQ hubs to enable this functionality. Please contact us if you need to disable it.
Unlock a door
POSThttps://connect.getseam.com/locks/unlock_door
Request Body
# 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 Salto Lock
Some Salto locks and access points will have a keypad available to program access codes. These codes can then be entered to unlock the door.
The Seam API makes it easy to program both ongoing codes and timebound codes on an Salto lock. You can find out more about Salto lock access code in our core concept section on access codes.
Salto does not let you specify a code for an access code. Instead Salto generates a 6-digit code, which the Seam API returns.
# create an ongoing codeseam.access_codes.create( device=some_lock, name="Personal Access Code")# create a timebound codeseam.access_codes.create( device=some_lock, 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)# [# AccessCode(access_code_id='631a3a30-3fa7-462a-b3bc-65528ccf8765', type='time_bound', code=None, starts_at='2028-08-12T19:24:00.000Z', ends_at='2028-08-13T19:24:00.000Z', name='My Temp Access Code', status='unset', common_code_key=None),
# AccessCode(access_code_id='4d2f4952-5446-4051-ba7e-a6fc01a376d7', type='ongoing', code='59026', starts_at=None, ends_at=None, name='Personal Access Code', status='set', common_code_key=None)
# ]
Now that you've completed this guide, you can try to connect a real Salto 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: