Skip to content

Commit 4b3b680

Browse files
dawnhogitbook-bot
authored andcommitted
GITBOOK-1: No subject
1 parent a80b0f4 commit 4b3b680

101 files changed

Lines changed: 596 additions & 1765 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
29.7 KB
Loading
410 KB
Loading
147 KB
Loading
281 KB
Loading
413 KB
Loading
4.13 MB
Loading
1.05 MB
Loading
7.09 KB
Loading

docs/brand-guides/2n-intercom-systems/2n-system-set-up-instructions.md

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -27,22 +27,17 @@ Repeat the following steps for each 2N device you want to control through Seam.
2727

2828
1. **Open device configuration**
2929
* In My2N, go to **Devices** in the left sidebar.
30-
* Click the **three-dot icon** next to your device and choose **Open configuration**.\\
31-
32-
<figure><img src="../../.gitbook/assets/Screenshot 2025-10-31 at 4.56.29 PM.png" alt=""><figcaption></figcaption></figure>
30+
* Click the **three-dot icon** next to your device and choose **Open configuration**.\\
3331
* When prompted, log in with the device’s credentials:
3432
* Default username: `Admin`
3533
* Default password: `2n`
3634
* (Use custom credentials if they were changed during installation.)
37-
2. **Enable HTTP API services**
38-
39-
* In the device dashboard, click **Services**.
40-
* From the sidebar, select **HTTP API**.
41-
* On the **Services** tab, make sure all of the APIs are enabled, with
35+
2. **Enable HTTP API services**
36+
* In the device dashboard, click **Services**.
37+
* From the sidebar, select **HTTP API**.
38+
* On the **Services** tab, make sure all of the APIs are enabled, with
4239

43-
**Connection Type** set to **Secure (TLS)** and **Authentication** set to **Digest.**
44-
45-
<figure><img src="../../.gitbook/assets/Screenshot 2025-10-31 at 9.44.42 AM (1).png" alt=""><figcaption></figcaption></figure>
40+
**Connection Type** set to **Secure (TLS)** and **Authentication** set to **Digest.**
4641
3. **Create API credentials**
4742
* In the top toolbar, click on **Account 1**, or another available account.
4843
* Enable the account.
@@ -54,8 +49,6 @@ Repeat the following steps for each 2N device you want to control through Seam.
5449
**Note**: the **Username** and **Password** created in this step will be used when connecting your device to Seam, please log and remember them.
5550
{% endhint %}
5651

57-
<figure><img src="../../.gitbook/assets/Screenshot 2025-10-31 at 9.45.19 AM.png" alt=""><figcaption></figcaption></figure>
58-
5952
***
6053

6154
## Connect Webview Instructions
@@ -66,23 +59,16 @@ This connection lets Seam manage and update your 2N intercom devices.
6659

6760
1. **Select My2N**\
6861
In the Seam Connect Webview, select **My2N** from the list of brands available.
69-
2. **Enter your Company Admin credentials**
70-
71-
* Enter the Company Admin My2N email and password for your property’s My2N account, then click **Submit**.
72-
* **Note:** Use an account with multi-factor authentication (MFA) turned off. If your main admin account requires MFA, create a separate account without MFA for this connection.
73-
74-
<figure><img src="../../.gitbook/assets/Screenshot 2025-10-31 at 11.36.44 AM.png" alt="" width="411"><figcaption></figcaption></figure>
62+
2. **Enter your Company Admin credentials**
63+
* Enter the Company Admin My2N email and password for your property’s My2N account, then click **Submit**.
64+
* **Note:** Use an account with multi-factor authentication (MFA) turned off. If your main admin account requires MFA, create a separate account without MFA for this connection.
7565
3. **Choose which devices to connect**\
7666
The Webview will show all 2N devices under your My2N company.
7767

7868
If a device doesn’t appear, check that it’s been added and that the HTTP API is enabled.
7969

8070
Select the devices you want to link to Seam, then click **Submit**.
81-
82-
<figure><img src="../../.gitbook/assets/Screenshot 2025-10-31 at 5.43.46 PM.png" alt="" width="304"><figcaption></figcaption></figure>
8371
4. **Authorize device access**\
8472
For each selected device, enter the **Username** and **Password** you created in the [Enable HTTP API for Each Device](2n-system-set-up-instructions.md#enable-http-api-for-each-device) section.
8573

8674
This step confirms that Seam can securely communicate with your 2N devices to perform actions like unlocking doors or managing access codes.
87-
88-
<figure><img src="../../.gitbook/assets/Screenshot 2025-10-31 at 5.46.00 PM.png" alt="" width="319"><figcaption></figcaption></figure>

docs/brand-guides/2n-intercom-systems/get-started-with-2n-intercoms.md

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ description: >-
77

88
# Get started with 2N Intercoms
99

10-
<figure><img src="../../.gitbook/assets/guides/2n-getting-started-seo-cover.png" alt=""><figcaption><p>2N Intercoms</p></figcaption></figure>
11-
1210
## Overview
1311

1412
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](https://www.seam.co/manufacturers/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](https://www.seam.co/supported-devices-and-systems).
@@ -29,36 +27,31 @@ Seam provides client libraries for many languages, such as JavaScript, Python, R
2927

3028
{% tabs %}
3129
{% tab title="JavaScript" %}
32-
3330
```bash
3431
npm i seam
3532
```
3633
{% endtab %}
3734

3835
{% tab title="Python" %}
39-
4036
```bash
4137
pip install seam
4238
# For some development environments, use pip3 in this command instead of pip.
4339
```
4440
{% endtab %}
4541

4642
{% tab title="Ruby" %}
47-
4843
```bash
4944
bundle add seam
5045
```
5146
{% endtab %}
5247

5348
{% tab title="PHP" %}
54-
5549
```bash
5650
composer require seamapi/seam
5751
```
5852
{% endtab %}
5953

6054
{% tab title="C#" %}
61-
6255
Install using [nuget](https://www.nuget.org/packages/Seam).
6356
{% endtab %}
6457
{% endtabs %}
@@ -81,7 +74,6 @@ To control your 2N intercom via the Seam API, you must first authorize your Seam
8174

8275
{% tabs %}
8376
{% tab title="JavaScript" %}
84-
8577
```javascript
8678
import { Seam } from 'seam'
8779

@@ -99,7 +91,6 @@ console.log(connectWebview.url)
9991
{% endtab %}
10092

10193
{% tab title="Python" %}
102-
10394
```python
10495
from seam import Seam
10596

@@ -115,7 +106,6 @@ print(webview.url)
115106
{% endtab %}
116107

117108
{% tab title="Ruby" %}
118-
119109
```ruby
120110
require "seam"
121111

@@ -133,7 +123,6 @@ puts webview.url
133123
{% endtab %}
134124

135125
{% tab title="PHP" %}
136-
137126
```php
138127
use Seam\SeamClient;
139128

@@ -160,13 +149,10 @@ After entering the credentials for My2N, you'll have to enter the credentials of
160149
* **username:** jane
161150
* **password:** 1234
162151

163-
<figure><img src="../../.gitbook/assets/guides/2n-connect-flow-screens.png" alt=""><figcaption><p>Seam Connect Webview flow to connect My2N account with Seam</p></figcaption></figure>
164-
165152
Confirm the Connect Webview was successful by querying its status:
166153

167154
{% tabs %}
168155
{% tab title="JavaScript" %}
169-
170156
```javascript
171157
const updatedWebview = await seam.connectWebviews.get(
172158
connectWebview.connect_webview_id,
@@ -177,7 +163,6 @@ console.log(updatedWebview.login_successful) // true
177163
{% endtab %}
178164

179165
{% tab title="Python" %}
180-
181166
```python
182167
updated_webview = seam.connect_webviews.get(connect_webview_id: webview.connect_webview_id)
183168

@@ -186,7 +171,6 @@ assert updated_webview.login_successful # true
186171
{% endtab %}
187172

188173
{% tab title="Ruby" %}
189-
190174
```ruby
191175
updated_webview = seam.connect_webviews.get(connect_webview_id: webview.connect_webview_id)
192176

@@ -195,7 +179,6 @@ puts updated_webview.login_successful # true
195179
{% endtab %}
196180

197181
{% tab title="PHP" %}
198-
199182
```php
200183
$webview = $seam->connect_webviews->get($webview->id);
201184
echo json_encode($webview);
@@ -209,8 +192,6 @@ After a My2N account is linked with Seam, you can retrieve devices for this My2N
209192

210193
{% tabs %}
211194
{% tab title="JavaScript" %}
212-
213-
214195
```javascript
215196
const allLocks = await seam.locks.list()
216197

@@ -248,7 +229,6 @@ console.log(someLock)
248229
{% endtab %}
249230

250231
{% tab title="Python" %}
251-
252232
```python
253233
all_locks = seam.locks.list()
254234

@@ -283,8 +263,6 @@ print(some_lock)
283263
{% endtab %}
284264

285265
{% tab title="Ruby" %}
286-
287-
288266
```ruby
289267
some_lock = seam.locks.list.first
290268

@@ -316,8 +294,6 @@ puts some_lock.inspect
316294
{% endtab %}
317295

318296
{% tab title="PHP" %}
319-
320-
321297
```php
322298
use Seam\SeamClient;
323299

@@ -350,8 +326,6 @@ Next, you can perform the basic action of locking and unlocking the door.
350326

351327
{% tabs %}
352328
{% tab title="JavaScript" %}
353-
354-
355329
```javascript
356330
// lock the door
357331
await seam.locks.lockDoor(someLock.device_id)
@@ -366,8 +340,6 @@ console.log(updatedLock.properties.locked) // false
366340
{% endtab %}
367341

368342
{% tab title="Python" %}
369-
370-
371343
```python
372344
# lock the door
373345
seam.locks.lock_door(device_id: some_lock.device_id)
@@ -382,8 +354,6 @@ assert updated_lock.properties["locked"] is False
382354
{% endtab %}
383355

384356
{% tab title="Ruby" %}
385-
386-
387357
```ruby
388358
# lock the door
389359
seam.locks.lock_door(device_id: some_lock.device_id)
@@ -398,8 +368,6 @@ puts updated_lock.properties.locked # false
398368
{% endtab %}
399369

400370
{% tab title="PHP" %}
401-
402-
403371
```php
404372
use Seam\SeamClient;
405373

@@ -423,8 +391,6 @@ Seam maps these residents to [access codes](https://docs.seam.co/latest/capabili
423391

424392
{% tabs %}
425393
{% tab title="JavaScript" %}
426-
427-
428394
```javascript
429395
// create an ongoing code
430396
await seam.accessCodes.create({
@@ -469,8 +435,6 @@ await seam.accessCodes.list({
469435
{% endtab %}
470436

471437
{% tab title="Python" %}
472-
473-
474438
```python
475439
# create an ongoing code
476440
seam.access_codes.create(
@@ -507,8 +471,6 @@ seam.access_codes.list(device=some_lock)
507471
{% endtab %}
508472

509473
{% tab title="Ruby" %}
510-
511-
512474
```ruby
513475
# create an ongoing code
514476
seam.access_codes.create(
@@ -557,8 +519,6 @@ seam.access_codes.list(device_id: some_lock.device_id)
557519
{% endtab %}
558520

559521
{% tab title="PHP" %}
560-
561-
562522
```
563523
564524
php

0 commit comments

Comments
 (0)