Get started with Salto KS Locks
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.
npm i seam
Once installed, sign-up for Seam to get your API key, and export it as an environment variable:
$ export SEAM_API_KEY=seam_test2ZTo_0mEYQW2TvNDCxG5Atpj85Ffw
2 โ Link Your Salto KS 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.
Create a Connect Webview
Code:
from seam import Seam
seam = Seam() # Seam automatically uses your exported SEAM_API_KEY.
connect_webview = seam.connect_webviews.create(accepted_providers=["salto_ks"])
assert connect_webview.login_successful is False
# Use the returned Connect Webview URL to display
# the Connect Webview authorization flow to your user.
print(connect_webview.url)
Output:
https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
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 Salto sandbox test accounts credentials below:
email: [email protected]
password: 1234
During the authorization process, Seam adds an admin user to your Salto KS site. Do not suspend or remove this Seam Integration admin user.


Confirm the Connect Webview was successful by querying its status:
updated_webview = seam.connect_webviews.get(connect_webview_id: webview.connect_webview_id)
assert updated_webview.login_successful # true
3 โ Retrieve Salto Devices
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.
all_locks = seam.locks.list()
some_lock = all_locks[0]
assert some_lock.properties["online"] is True
assert some_lock.properties["battery_level"] is True
print(some_lock)
# Device(device_id='681bf7bc-e7c6-48e6-acfe-6dbabd0615c5', device_type='salto_lock', location=None, properties={'locked': True, 'online': True, 'battery_level': 1, 'salto_metadata': {'model': 'wall_reader_pin', 'lock_id': 'lock_2', 'lock_type': 'wall_reader_pin', 'locked_state': 'locked', 'battery_level': 'fresh', 'customer_reference': 'BACK DOOR'}, 'has_direct_power': True, 'max_active_codes_supported': 100, 'supported_code_lengths': [6], 'name': 'BACK DOOR'}, capabilities_supported=['access_code', 'lock'])
4 โ Locking & Unlocking a Door
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.
Lock a Door
Returns a pending action result
No content
POST /locks/lock_door HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"device_id": "text"
}
Returns a pending action result
No content
Unlock a door
POST
https://connect.getseam.com/locks/unlock_door
Request Body
device_id
String
# lock the door
seam.locks.lock_door(device_id: some_lock.device_id)
updated_lock = seam.locks.get(device_id: some_lock.device_id)
assert updated_lock.properties["locked"] is True
# Now unlock the door
seam.locks.unlock_door(device_id: some_lock.device_id)
updated_lock = seam.locks.get(device_id: some_lock.device_id)
assert updated_lock.properties["locked"] is False
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.
# create an ongoing code
seam.access_codes.create(
device=some_lock,
name="Personal Access Code")
# create a timebound code
seam.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" parameter
seam.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)
# ]
Next Steps
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:
If you have any questions or want to report an issue, email us at [email protected].
Last updated
Was this helpful?