Quick Start
Seam provides a unified API to connect and control IoT devices, such as smart locks, thermostats, cameras, and sensors. This guide walks you through issuing your first device API call.
Last updated
Was this helpful?
Seam provides a unified API to connect and control IoT devices, such as smart locks, thermostats, cameras, and sensors. This guide walks you through issuing your first device API call.
Last updated
Was this helpful?
To get started with Seam, first connect a set of devices.
In a web browser, go to at and create an account. Once you have logged in to Seam Console, you are working in the default .
In the upper-right corner of the Devices page, click Add Devices.
Seam Console displays an authorization flow (known as a ) that enables you to connect a device account to Seam.
In the Connect Webview, click Continue.
In the manufacturer list, select .
When prompted, type the following sample (sandbox) credentials:
Email: jane@example.com
Password: 1234
Click Submit.
When prompted for a two-factor authentication (2FA) method, select Email.
In the Two Factor Code field, type 123456
and then click Submit and Continue.
Once authorized, the devices associated with this test account appear in your workspace.
In the left navigation pane, click API Keys.
In the upper-right corner of the API Keys page, click Add API Key.
In the Add API Key dialog, type a name for your new API key and then click Create API Key.
Copy the newly-created API key and store it for future use.
Install one of the Seam SDKs in the programming language of your choice.
Unlock your first door!
To start, open a terminal window and export your API key as an environment variable.
The Seam SDK that you have installed automatically uses this API key once you have exported it.
Code:
Output:
Here are some ideas of what you can do next...
To control the devices that you connected in , you must create an API key and install the Seam SDK in the programming language of your choice.
In the top navigation pane of , click Developer.
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 .
Next, use the following code to retrieve one of the devices that you connected in , inspect the supported capabilities of the device, and use the Seam API to unlock the door:
Now that you have completed the Seam API Quick Start, you are well on your way to writing code that can actually control the physical world!
If you have a real device, you can try to control it using the steps in this Quick Start. Note that you must first because sandbox workspaces only enable you to connect test accounts and devices. For more information, see .
If you are creating an app to control your users' devices, see . Seam Connect Webviews are fully-embedded client-side components that you add to your app if you want to enable your users to import their own devices using your app. Your users interact with your embedded Connect Webviews to link their IoT device accounts to Seam through your app. That is, Connect Webviews walk your users through the process of logging in to their device accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices using the Seam API.
Seam supports many device categories. Each device can be broken down into . A capability indicates what the device can do, what properties it has, and what events it emits. To learn more about specific capabilities, such as access codes or thermostats, see the following guides:
Thermostats API
Get started →