Get started with Salto KS Locks
Learn how to connect and control your Salto lock with the Seam API.
Last updated
Was this helpful?
Learn how to connect and control your Salto lock with the Seam API.
Last updated
Was this helpful?
Seam provides a universal API to connect and control many brands of locks. This guide provides a rapid introduction to connecting and controlling your 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 .
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.
email: jane@example.com
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:
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.
POST
https://connect.getseam.com/locks/unlock_door
device_id
String
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.
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 support@seam.co.
Seam provides client libraries for many languages, such as JavaScript, Python, Ruby, PHP, and others, as well as a Postman collection and spec.
JavaScript / TypeScript (, )
Python (, )
Ruby Gem (, )
PHP (, )
Java ()
C# (, )
Go ()
Install using .
Once installed, to get your API key, and export it as an environment variable:
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: pre-built UX flows that walk you through authorizing your application to control your Salto sites.
Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the Salto credentials below:
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
for
Lock a Door
Returns a pending action result
No content