Skip to main content

​
Overview

Seam provides a universal API to connect and control many brands of locks, including Tedee. This guide provides a rapid introduction to connecting and controlling your Tedee 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. For more details about the Seam Tedee integration, see the Tedee locks device integration guide.

​
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. You can only connect virtual devices in a sandbox workspace. If you need to connect a real Tedee device, use a non-sandbox workspace and API key.
To control your Tedee locks using the Seam API, you must first authorize your Seam workspace against your Tedee account. To do so, Seam provides Connect Webviews: pre-built UX flows that walk you through authorizing your application to control your Tedee sites.

​
Request a Connect Webview

// Use Seam SDK to create a Connect Webview with tedee as the provider
const createdConnectWebview = await seam.connectWebviews.create({
  accepted_providers: ["tedee"]
});

// Print the created webview URL
console.log(createdConnectWebview.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 Tedee 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 Tedee Devices

After a Tedee account is linked with Seam, you can retrieve devices for this Tedee account. The Seam API exposes most of the device’s properties such as battery level. 
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: 'ffc4d67f-e3a6-4ef8-ac84-f3770750422a',
device_type: 'tedee_lock',
capabilities_supported: [ 'access_code', 'battery', 'lock' ],
properties: {
locked: true,
online: true,
manufacturer: 'tedee',
battery_level: 1,
tedee_metadata: {
bridge_id: 1,
device_id: 1,
bridge_name: "Jane's Bridge",
device_name: 'Front Door',
device_model: 'Lock PRO',
serial_number: '111111-11111'
},
supported_code_lengths: [ 5, 6, 7, 8 ],
online_access_codes_enabled: true,
offline_access_codes_enabled: true,
supports_offline_access_codes: true,
name: 'Front Door',
model: {
display_name: 'Lock PRO',
manufacturer_display_name: 'Tedee',
accessory_keypad_supported: false,
offline_access_codes_supported: false,
online_access_codes_supported: true
},
battery: { level: 1, status: 'full' },
image_url: 'https://connect.getseam.com/assets/images/devices/unknown-lock.png',
image_alt_text: 'Placeholder Lock Image',
code_constraints: [ [Object], [Object] ],
supports_backup_access_code_pool: true
},
location: null,
connected_account_id: 'f1e093d9-7a11-4d04-8c7e-619a037bd11a',
workspace_id: '398d80b7-3f96-47c2-b85a-6f8ba21d07be',
created_at: '2024-02-08T19:47:43.810Z',
errors: [],
warnings: [],
is_managed: true,
custom_metadata: {}
}
_/

​
4 — Locking & Unlocking a Door

Next, you can perform the basic action of locking and unlocking a door. POST undefined/locks/lock_door

​
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 Tedee Lock

Some Tedee locks also have a keypad paired to them to program access codes. These codes can then be entered to unlock a Tedee lock. The Seam API makes it easy to program both ongoing codes and timebound codes on a Tedee lock. You can find out more about Tedee lock access code in our core concept section on access codes.
For Tedee-specific access code restrictions, see Access (PIN) Code Requirements.
// 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,
})

​
Next Steps

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