Get API Key
Install Client Library
Connect a Device
Your First Device API Call
Get started with August Locks
Get started with NoiseAware Sensors
Get started with Schlage Connect Locks
Get started with SmartThings Hubs + Smart Locks
Sandbox & Sample Data
Seam Hub API for ZWave
For Device Manufacturers
Creating a Seam-Compatible Intercom API
Workspaces encapsulate all sub-resources and settings. Sandboxes are a special type of workspace that contains simulated devices for testing purposes.
The top-level resource in Seam is a workspace. All other resources (Devices, Connected Accounts, settings...etc) are organized under workspaces.
When you sign up for Seam, we create two workspaces for you:
This is a special type of workspace. It contains simulated devices, handy for testing your code without needing real devices.
This is for when you're ready to control real devices!
Of course, you are not limited to these two. You can create as many workspaces as you need.
To make a request to a device in a workspace, you must first get an API key for that workspace. A workspace can have one or more API keys. However, a key cannot be used across multiple workspaces.
To create or edit a workspace API keys, go to the Seam dashboard. Select the right workspace. Go to the API key tab. Create/edit keys as you need.
Sandbox workspaces are for you to test your code. We seed each Sandbox with simulated devices and user accounts that own them.
These simulated devices behave like their real counterparts. This lets you test your application against multiple device brands,
without needing to actually own each device!
We own a lot of locks so that you don't have to!
You can always reset a sandbox workspace to return it to its starting state. This is handy if you need to run continuous integration! We are also working on letting you edit the initial seed state.
Aside from sharing your API key, you can also share access to a workspace with your team. This allows multiple people to manage a workspace and its resources from the Seam Dashboard.
Core Concepts - Previous
Next - Core Concepts