Skip to main content

​
Overview

Seam provides a universal API to connect and control many brands of smart locks. This guide provides a rapid introduction to connecting and controlling your Yale lock using the Seam API. Note that this guide is intended for Yale locks connected via the Yale wifi bridge and Yale access app. For Z-Wave Yale devices, head over to our guide for SmartThings. To learn more about other smart lock brands supported by Seam such as August, Schlage, and Salto, 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. 
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
This guide uses a Sandbox Workspace. Only virtual devices can be connected. If you need to connect a real Yale Lock, use a non-sandbox workspace and API key.
To control your Yale lock via the Seam API, you must first authorize your Seam workspace against your Yale account. To do so, Seam provides Connect Webviews: pre-built UX flows that walk you through authorizing your application to control your Yale lock.
Note that yale_access or yale_home are now deprecated in favor of justyale which will work with whichever version of the Yale backend.

​
Request a Connect Webview

import { Seam } from 'seam'

const seam = new Seam()

const { connect_webview: connectWebview } = await seam.connectWebviews.create({
accepted_providers: ['yale'],
})

console.log(connectWebview.login_successful) // false

// Send the webview URL to your user
console.log(connectWebview.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 Yale sandbox test accounts credentials below: Confirm the Connect Webview was successful by querying its status: 
const updatedWebview = await seam.connectWebviews.get(
  connectWebview.connect_webview_id,
)

console.log(updatedWebview.login_successful) // true

​
3 — Retrieve Yale Lock Devices

After a Yale account is linked with Seam, you can retrieve devices for this Yale account. The Seam API exposes most of the device’s properties such as battery level or door lock status. 
const allLocks = await seam.locks.list()

const someLock = allLocks[0]

console.log(someLock.properties.online) // true
console.log(someLock.properties.locked) // true

console.log(someLock)
/*
{
device_id: 'b013d947-cef1-4dfe-8aa2-1e452eca5262',
device_type: 'yale_lock',
capabilities_supported: [ 'access_code', 'lock' ],
properties: {
locked: true,
online: true,
door_open: false,
manufacturer: 'august',
battery_level: 0.9999532347993827,
august_metadata: {
lock_id: 'lock-2',
lock_name: 'BACK DOOR',
has_keypad: true,
house_name: 'My House'
},
name: 'BACK DOOR'
},
location: null,
connected_account_id: '2a860181-dba7-49aa-9d5e-a66ff585dc08',
workspace_id: 'd7418ff3-a476-4f48-9a4b-211d1d21a03d',
created_at: '2022-12-16T00:52:16.975Z',
errors: [],
warnings: []
}
*/

​
4 — Locking & Unlocking a Door

Next, you can perform the basic action of locking and unlocking the door.
POST /locks/lock_door See the API Reference for details.

​
Unlock a door

POST https://connect.getseam.com/locks/unlock_door

​
Request Body

NameTypeDescription
device_idString
// lock the door
await seam.locks.lockDoor(someLock.device_id)
const updatedLock = await seam.locks.get(someLock.device_id)
console.log(updatedLock.properties.locked) // true

// unlock the door
await seam.locks.unlockDoor(someLock.device_id)
updatedLock = await seam.locks.get(someLock.device_id)
console.log(updatedLock.properties.locked) // false

​
5 — Setting Access Code on Yale Lock

Most Yale locks come with a keypad built-in to program access codes. These codes can then be entered to unlock a Yale lock. The Seam API makes it easy to program both ongoing codes and timebound codes on a Yale lock. You can find out more about Yale lock access code in our core concept section on access codes. 
// create an ongoing code
await seam.accessCodes.create({
  device_id: someLock.device_id,
  code: '123456',
  name: 'Personal Access Code',
})

// create a timebound code
await seam.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" parameter
await seam.accessCodes.list({
device_id: someLock.device_id,
})

/*
[
{
code: '1988',
type: 'ongoing',
status: 'setting',
created_at: '2022-08-26T12:50:17.858Z',
access_code_id: '26d6138c-6524-4f3c-ac96-43cc3bea0a8d'
},
{
type: 'timebound',
code: '888888',
starts_at: '2028-08-12T19:24:00.000Z',
ends_at: '2028-08-13T19:24:00.000Z',
access_code_id: '8c2db4da-b137-4c08-a2c3-d611e6ff91b3',
}
]
*/

​

​
Next Steps

Now that you’ve completed this guide, you can try to connect a real Yale 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.