Seam provides a universal API to connect and control many brands of locks. This guide provides a rapid introduction to connecting and controlling your Wyze locks using the Seam API. To learn more about other device brands supported by the Seam API, such as Yale, Schlage, Kwikset and August, head over to our integration page.
There are two types of Wyze Locks, a Gateway Wyze Lock that supports Wi-Fi connections and a Wyze Lock Bolt that supports bluetooth connections only.
For Gateway Wyze Locks we support all normal functionality including locking or unlocking the device and setting access codes remotely through Seam as long as the lock is proplery connected to the provided gateway.
For Bluetooth-only Wyze Lock Bolts we're not able to control the lock remotely (meaning no locking or unlocking the device and no setting access codes) but we are able to return some information on the lock such as the battery level and the locked / unlocked state.
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 Wyze device, use a non-sandbox workspace and API key.
2 — Link Your Wyze with Seam
To control your Wyze locks via the Seam API, you must first authorize your Seam workspace against your Wyze account. To do so, Seam providesConnect Webviews: pre-built UX flows that walk you through authorizing your application to control Wyze locks.
Obtain a Wyze API Key and Wyze API Key ID
You will need create a Wyze API Key for your Wyze account. To see how to create a Wyze API Key for your Wyze account, click here.
Note that both the API Key and Key ID returned from Wyze are required to connect your Wyze account to Seam. Make sure to copy both values to somewhere secure!
For Sandbox integrations, you can simply use ABC123ABC for both the API Key and API Key ID.
Request a Connect Webview
from seam import Seamseam =Seam()webview = seam.connect_webviews.create(accepted_providers=["wyze"])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: ["wyze"],});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[wyze])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 Wyze sandbox test accountcredentials below:
Wyze API Key ID: ABC123ABC
Wyze API Key ABC123ABC
email: jane@example.com
password: 1234
Confirm the Connect Webview was successful by querying its status:
Next, you can perform the basic action of locking and unlocking the door.
Unlock a door
POSThttps://connect.getseam.com/locks/unlock_door
Request Body
Name
Type
Description
device_id
String
# 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 — Programming Access Code on a Wyze Lock
The Seam API lets you create access codes on Wyze locks with a gateway. These codes can then be entered to unlock the door. You can find out more info about how Seam access codes in our core concept section on access codes.
Wyze does not allow pin code values to be seen after the code is created. If you create a code through Seam, avoid changing the pin code through the app and instead use Seam to change any information about the code!
# 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='123*12346', 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 Wyze 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: