Learn how to connect and control your ControlByWeb device with the Seam API.
Overview
Seam provides a universal API to connect and control many brands of smart devices. This guide provides a rapid introduction to connecting and controlling your ControlByWeb relay device using the Seam API. To learn more about other smart device brands supported by Seam such as Yale, Schlage, and August, 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.
This guide uses a Sandbox Workspace. Only virtual devices can be connected. If you need to connect a real ControlByWeb device, use a non-sandbox workspace and API key.
2 — Link ControlByWeb Account with Seam
To control your ControlByWeb relay device via the Seam API, you must first authorize your Seam workspace against your ControlByWeb Cloud account. To do so, Seam provides Connect Webviews: pre-built UX flows that walk you through authorizing your application to control your ControlByWeb device.
Request a Connect Webview
from seam import Seamseam =Seam()webview = seam.connect_webviews.create(accepted_providers=["controlbyweb"])assert webview.login_successful isFalse# Send the webview URL to your userprint(webview.url)
import { Seam } from'seam'constseam=newSeam()constconnectWebview=awaitseam.connectWebviews.create({ accepted_providers: ['controlbyweb'],})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: ["controlbyweb"])puts webview.login_successful # false# Send the webview URL to your userputs webview.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 ControlByWeb sandbox test account credentials below:
username: jane
password: 1234
Confirm the Connect Webview was successful by querying its status:
After a ControlByWeb account is linked with Seam, you can retrieve devices for this ControlByWeb account. The main device property currently exposed by the Seam API is whether the device is online and reachable.
Next, you can perform the basic action of triggering a relay on the device. This action is mapped to an unlock API call in Seam.
Unlock a door
POSThttps://connect.getseam.com/locks/unlock_door
Request Body
Name
Type
Description
device_id
String
# trigger the relayseam.locks.unlock_door(some_lock)
// trigger the relayawaitseam.locks.unlockDoor(someLock.device_id)
# trigger the relayseam.locks.unlock_door(some_lock)
Next Steps
Now that you've completed this guide, you can try to connect a real ControlByWeb 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: