Learn how to connect and control your 2N intercom with the Seam API. Connect devices like 2N Verso, Solo, or IP Style, and use Seam to unlock the door, edit residents, list events & more.
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 2N intercom 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.
2N devices are currently required to be connected to the My2N cloud service to be controlled via Seam. If you are unable or do not wish to connect your 2N device to My2N, please contact us to discuss alternative options.
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 device, use a non-sandbox workspace and API key.
2 — Link My2N Account with Seam
To control your 2N intercom via the Seam API, you must first authorize your Seam workspace against your My2N account. To do so, Seam provides Connect Webviews: pre-built UX flows that walk you through authorizing your application to control your 2N intercom.
Request a Connect Webview
from seam import Seam
seam = Seam()
webview = seam.connect_webviews.create(accepted_providers=["my_2n"])
assert webview.login_successful is False
# Send the webview URL to your user
print(webview.url)
import { Seam } from 'seam'
const seam = new Seam()
const connectWebview = await seam.connectWebviews.create({
accepted_providers: ['my_2n'],
})
console.log(connectWebview.login_successful) // false
// Send the webview URL to your user
console.log(connectWebview.url)
require "seam"
seam = Seam.new(api_key: "MY_API_KEY")
webview = seam.connect_webviews.create(
accepted_providers: ["my_2n"]
)
puts webview.login_successful # false
# Send the webview URL to your user
puts webview.url
use Seam\SeamClient;
$seam = new SeamClient("YOUR_API_KEY");
$webview = $seam->connect_webviews->create(
accepted_providers: ["my_2n"]
);
echo json_encode($webview)
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 My2N sandbox test account credentials below:
email: jane@example.com
password: 1234
After entering the credentials for My2N, you'll have to enter the credentials of an existing HTTP user on each device you want to connect. All sandbox devices have a single HTTP user with the credentials:
username: jane
password: 1234
Confirm the Connect Webview was successful by querying its status:
use Seam\SeamClient;
$seam = new SeamClient('YOUR_API_KEY');
$locks = $seam->locks->list();
echo json_encode($locks);
4 — Locking & Unlocking a Door
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 door
seam.locks.lock_door(device_id: some_lock.device_id)
updated_lock = seam.locks.get(device_id: some_lock.device_id)
assert updated_lock.properties["locked"] is True
# Now unlock the door
seam.locks.unlock_door(device_id: some_lock.device_id)
updated_lock = seam.locks.get(device_id: some_lock.device_id)
assert updated_lock.properties["locked"] is False
// 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
# lock the door
seam.locks.lock_door(device_id: some_lock.device_id)
updated_lock = seam.locks.get(device_id: some_lock.device_id)
puts updated_lock.properties.locked # true
# unlock the door
seam.locks.unlock_door(device_id: some_lock.device_id)
updated_lock = seam.locks.get(device_id: some_lock.device_id)
puts updated_lock.properties.locked # false
use Seam\SeamClient;
$seam = new SeamClient('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 — Creating Access Codes on 2N Intercoms
2N devices have a directory with residents. These residents can be assigned PIN codes to unlock the door.
Seam maps these residents to access codes and allows you to create and manage them through the Seam API.
# create an ongoing code
seam.access_codes.create(
device=some_lock, code="123456", name="Personal Access Code"
)
# create a timebound code
seam.access_codes.create(
device=some_lock,
code="888888",
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" parameter
seam.access_codes.list(device=some_lock)
# [
# AccessCode(
# access_code_id='af5272b1-2a49-4eb5-9388-2447fc7b5bd1',
# type='ongoing',
# code='123459'
# ),
# AccessCode(
# access_code_id='8c2db4da-b137-4c08-a2c3-d611e6ff91b3',
# type='timebound',
# code='888888',
# starts_at='2028-08-12T19:24:00.000Z',
# ends_at='2028-08-13T19:24:00.000Z',
# )
# ]
Now that you've completed this guide, you can try to connect a real 2N 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: