Skip to main content

​
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 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. 
npm i seam
Once installed, sign-up for Seam to get your API key, and export it as an environment variable: 
$ export SEAM_API_KEY=seam_test2ZTo_0mEYQW2TvNDCxG5Atpj85Ffw
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.
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

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)

​
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: 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: 
const updatedWebview = await seam.connectWebviews.get(
  connectWebview.connect_webview_id,
)

console.log(updatedWebview.login_successful) // true

​
3 — Retrieve My2N Devices

After a My2N account is linked with Seam, you can retrieve devices for this My2N account. 2N devices are represented as locks. 
const allLocks = await seam.locks.list()

const someLock = allLocks[0]

console.log(someLock.properties.online) // true
console.log(someLock.properties.locked) // true

console.log(someLock)
/_
{
device_id: 'f0c074d6-34d0-4910-a16a-dfe078d5d178',
device_type: 'two_n_intercom',
capabilities_supported: [ 'access_code', 'lock' ],
properties: {
locked: true,
online: true,
manufacturer: 'two_n',
serial_number: '4c0e6e72-81da-48af-8825-ed92a6fb8186',
two_n_metadata: { device_id: 1, device_name: 'Device 0' },
supported_code_lengths: [ 4, 5, 6, 7, 8 ],
name: 'Device 0',
image_url: 'http://localhost:3020/assets/images/devices/unknown-lock.png',
image_alt_text: 'Placeholder Lock Image'
},
location: null,
connected_account_id: '273b8072-c2c0-48ba-be17-2ec112276fca',
workspace_id: 'e13ac83b-7150-4bf7-9229-6affd885c1d9',
created_at: '2023-05-03T20:58:28.520Z',
errors: [],
warnings: []
}
_/

​
4 — Locking & Unlocking a Door

Next, you can perform the basic action of locking and unlocking the door.
POST /locks/lock_door See the API Reference for details.

​
Unlock a door

POST https://connect.getseam.com/locks/unlock_door Request Body
NameTypeDescription
device_idString
// 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

​
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
await seam.accessCodes.create({
  device_id: someLock.device_id,
  code: '123456',
  name: 'Personal Access Code',
})

// create a timebound code
await seam.accessCodes.create({
device_id: someLock.device_id,
code: '888888',
name: 'My Temp Access Code',
starts_at: '2028-11-12T19:23:42+0000',
ends_at: '2028-11-13T19:23:42+0000',
})

// use a device_id as the "device_id" parameter
await seam.accessCodes.list({
device_id: someLock.device_id,
})

/_
[
{
code: '1988',
type: 'ongoing',
status: 'setting',
created_at: '2022-08-26T12:50:17.858Z',
access_code_id: '26d6138c-6524-4f3c-ac96-43cc3bea0a8d'
},
{
type: 'timebound',
code: '888888',
starts_at: '2028-08-12T19:24:00.000Z',
ends_at: '2028-08-13T19:24:00.000Z',
access_code_id: '8c2db4da-b137-4c08-a2c3-d611e6ff91b3',
}
]
_/

​
Next Steps

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: If you have any questions or want to report an issue, email us at support@seam.co.