-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5a5be17
commit 0c8293d
Showing
2 changed files
with
25 additions
and
102 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,118 +1,41 @@ | ||
--- | ||
description: Seam makes it easy to integrate IoT devices with your applications! | ||
description: >- | ||
Seam makes it easy to integrate IoT devices and systems with your | ||
applications! | ||
--- | ||
|
||
# Seam Documentation | ||
|
||
We have integrated many door locks, thermostats, and other device brands, and we have created simple application programming interfaces (APIs) for interacting with these devices. | ||
Connect your IoT devices and systems using Seam! From smart locks and thermostats, to whole building access control systems, Seam integrates hundreds of device types and puts them behind a standardized, intuitive API. | ||
|
||
To get started quickly with Seam, follow the [Quick Start](quickstart.md) to create an API key and then connect and control your first device. | ||
Unlock doors. Create access codes. Set temperatures. Grant access. Get started with Seam! | ||
|
||
## Getting Started | ||
|
||
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Get</strong> <strong>API Key</strong> (free)</td><td>Sign up for the Seam Console and get your API keys. →</td><td></td><td><a href=".gitbook/assets/seam-api-key.png">seam-api-key.png</a></td><td><a href="https://console.seam.co/">https://console.seam.co/</a></td></tr><tr><td><strong>Quick Start</strong> (5 mins)</td><td>Learn how to connect a device and issue your first API call. →</td><td></td><td><a href=".gitbook/assets/seam-quick-start-light.png">seam-quick-start-light.png</a></td><td><a href="quickstart.md">quickstart.md</a></td></tr></tbody></table> | ||
|
||
{% tabs %} | ||
{% tab title="Smart Locks and Access Codes API" %} | ||
{% embed url="https://youtu.be/99ZpSq2Z1-8" %} | ||
You can control your smart locks easily with the Seam API. In this video, learn how to get started! | ||
{% endembed %} | ||
{% endtab %} | ||
|
||
{% tab title="Thermostats API" %} | ||
{% embed url="https://www.youtube.com/watch?amp;ab_channel=Seam&t=102s&v=3CYvoJtAGNc" %} | ||
You can control your thermostats easily with the Seam API. In this video, learn how to get started! | ||
{% endembed %} | ||
{% endtab %} | ||
{% endtabs %} | ||
|
||
## Install an SDK | ||
|
||
Use one of the following methods to install the Seam software development kit (SDK) in the programming language of your choice: | ||
|
||
* JavaScript / TypeScript ([npm](https://www.npmjs.com/package/seam), [GitHub](https://github.com/seamapi/javascript)) | ||
* Python ([pip](https://pypi.org/project/seam/), [GitHub](https://github.com/seamapi/python)) | ||
* Ruby Gem ([rubygem](https://rubygems.org/gems/seam), [GitHub](https://github.com/seamapi/ruby)) | ||
* PHP ([packagist](https://packagist.org/packages/seamapi/seam), [GitHub](https://github.com/seamapi/php)) | ||
* Java ([GitHub](https://github.com/seamapi/java)) | ||
* C# ([nuget](https://www.nuget.org/packages/Seam), [GitHub](https://github.com/seamapi/csharp)) | ||
* Go ([GitHub](https://github.com/seamapi/go)) | ||
|
||
{% tabs %} | ||
{% tab title="JavaScript" %} | ||
```bash | ||
npm i seam | ||
``` | ||
{% endtab %} | ||
|
||
{% tab title="Python" %} | ||
```bash | ||
pip install seam | ||
# For some development environments, use pip3 in this command instead of pip. | ||
``` | ||
{% endtab %} | ||
|
||
{% tab title="Ruby" %} | ||
```bash | ||
bundle add seam | ||
``` | ||
{% endtab %} | ||
|
||
{% tab title="PHP" %} | ||
```bash | ||
composer require seamapi/seam | ||
``` | ||
{% endtab %} | ||
|
||
{% tab title="Java" %} | ||
**Gradle:** | ||
|
||
```gradle | ||
// build.gradle | ||
dependencies { | ||
implementation 'io.github.seamapi:java:0.x.x' | ||
} | ||
``` | ||
|
||
**Maven:** | ||
|
||
```xml | ||
<!-- pom.xml --> | ||
<dependency> | ||
<groupId>io.github.seamapi</groupId> | ||
<artifactId>java</artifactId> | ||
<version>0.x.x</version> | ||
</dependency> | ||
``` | ||
{% endtab %} | ||
|
||
{% tab title="C#" %} | ||
Install using [nuget](https://www.nuget.org/packages/Seam). | ||
{% endtab %} | ||
|
||
{% tab title="Go" %} | ||
```bash | ||
go get github.com/seamapi/go | ||
``` | ||
{% endtab %} | ||
{% endtabs %} | ||
|
||
## Create and Export Your Seam API Key | ||
|
||
[Create your Seam API key](core-concepts/authentication/api-keys.md#create-an-api-key) using the [Seam Console](https://console.seam.co/). Then, make sure to export this key so that the installed SDK can use it. | ||
|
||
```bash | ||
$ export SEAM_API_KEY=seam_test2ZTo_0mEYQW2TvNDCxG5Atpj85Ffw | ||
``` | ||
|
||
## Device APIs | ||
|
||
Explore our device API guides to start connecting and controlling specific device categories. | ||
|
||
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden><select></select></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Door Locks API</strong></td><td>Get started →</td><td><a href=".gitbook/assets/smart-locks-16-9.png">smart-locks-16-9.png</a></td><td></td><td><a href="products/smart-locks/">smart-locks</a></td></tr><tr><td><strong>Thermostats API</strong></td><td>Get started →</td><td></td><td></td><td><a href="products/thermostats/">thermostats</a></td></tr><tr><td><strong>Noise</strong> <strong>Sensors API</strong></td><td>Get started →</td><td><a href=".gitbook/assets/sensors-16-9.png">sensors-16-9.png</a></td><td></td><td><a href="products/noise-sensors/">noise-sensors</a></td></tr></tbody></table> | ||
|
||
## Brand Guides | ||
|
||
Explore our in-depth guides to get started with specific devices or brands. | ||
|
||
*** | ||
|
||
## Getting Started | ||
|
||
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Quick Start</strong> (5 mins)</td><td>Learn how to connect a device and issue your first API call. →</td><td></td><td><a href=".gitbook/assets/seam-quick-start-light.png">seam-quick-start-light.png</a></td><td><a href="quickstart.md">quickstart.md</a></td></tr><tr><td><strong>Get an API Key</strong> (free)</td><td>Sign up for the Seam Console and get your API key. →</td><td></td><td><a href=".gitbook/assets/seam-api-key.png">seam-api-key.png</a></td><td><a href="https://console.seam.co/">https://console.seam.co/</a></td></tr><tr><td><strong>Install a Seam SDK</strong> (free)</td><td>Develop your IoT apps in your favorite language. →</td><td></td><td><a href=".gitbook/assets/Seam-SDKs.png">Seam-SDKs.png</a></td><td><a href="api-clients/installation.md">installation.md</a></td></tr></tbody></table> | ||
|
||
*** | ||
|
||
## Device and System APIs | ||
|
||
Explore our device API guides to start connecting and controlling specific device and system categories. | ||
|
||
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden><select></select></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Door Locks API</strong></td><td>Get started →</td><td><a href=".gitbook/assets/smart-locks-16-9.png">smart-locks-16-9.png</a></td><td></td><td><a href="products/smart-locks/">smart-locks</a></td></tr><tr><td><strong>Thermostats API</strong></td><td>Get started →</td><td><a href=".gitbook/assets/thermostats-cover.png">thermostats-cover.png</a></td><td></td><td><a href="products/thermostats/">thermostats</a></td></tr><tr><td><strong>Noise</strong> <strong>Sensors API</strong></td><td>Get started →</td><td><a href=".gitbook/assets/sensors-16-9.png">sensors-16-9.png</a></td><td></td><td><a href="products/noise-sensors/">noise-sensors</a></td></tr><tr><td><strong>Access Control Systems API</strong></td><td>Get started →</td><td><a href=".gitbook/assets/acs-cover.png">acs-cover.png</a></td><td></td><td><a href="products/access-systems/">access-systems</a></td></tr></tbody></table> | ||
|
||
*** | ||
|
||
## Device and System Integration Guides | ||
|
||
Explore our in-depth guides to get started with specific devices or systems. | ||
|
||
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-type="content-ref"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>August Locks</strong></td><td>Connect and control August locks. →</td><td><a href=".gitbook/assets/august-getting-started-guide-cover.jpg">august-getting-started-guide-cover.jpg</a></td><td><a href="device-guides/get-started-with-august-locks.md">get-started-with-august-locks.md</a></td><td><a href="device-guides/get-started-with-august-locks.md">get-started-with-august-locks.md</a></td></tr><tr><td><strong>Yale Locks</strong></td><td>Connect and control Yale locks. →</td><td><a href=".gitbook/assets/yale-getting-started-guide-cover.jpg">yale-getting-started-guide-cover.jpg</a></td><td><a href="device-guides/get-started-with-yale-locks.md">get-started-with-yale-locks.md</a></td><td><a href="device-guides/get-started-with-yale-locks.md">get-started-with-yale-locks.md</a></td></tr><tr><td><strong>Schlage Locks</strong></td><td>Connect and control Schlage locks. →</td><td><a href=".gitbook/assets/schlage-getting-started-guide-cover.jpg">schlage-getting-started-guide-cover.jpg</a></td><td><a href="device-guides/get-started-with-schlage-locks.md">get-started-with-schlage-locks.md</a></td><td><a href="device-guides/get-started-with-schlage-locks.md">get-started-with-schlage-locks.md</a></td></tr><tr><td><strong>Kwikset Locks</strong></td><td>Connect and control Kwikset locks. →</td><td><a href=".gitbook/assets/guides/kwikset-getting-started-guide-cover.jpg">kwikset-getting-started-guide-cover.jpg</a></td><td><a href="device-guides/get-started-with-kwikset-wifi-locks.md">get-started-with-kwikset-wifi-locks.md</a></td><td><a href="device-guides/get-started-with-kwikset-wifi-locks.md">get-started-with-kwikset-wifi-locks.md</a></td></tr><tr><td><strong>Salto Locks</strong></td><td>Connect and control Salto locks and devices. →</td><td><a href=".gitbook/assets/salto-getting-started-guide-cover.jpg">salto-getting-started-guide-cover.jpg</a></td><td><a href="device-guides/get-started-with-salto-locks.md">get-started-with-salto-locks.md</a></td><td><a href="device-guides/get-started-with-salto-locks.md">get-started-with-salto-locks.md</a></td></tr><tr><td><strong>TTLock</strong></td><td>Connect and control TTLock devices. →</td><td><a href=".gitbook/assets/ttlock_get-started-cover_light.png">ttlock_get-started-cover_light.png</a></td><td><a href="device-guides/get-started-with-ttlock-devices.md">get-started-with-ttlock-devices.md</a></td><td><a href="device-guides/get-started-with-ttlock-devices.md">get-started-with-ttlock-devices.md</a></td></tr><tr><td><strong>Nuki Locks</strong></td><td>Connect and control Nuki devices. →</td><td><a href=".gitbook/assets/guides/nuki-getting-seo-cover.jpg">nuki-getting-seo-cover.jpg</a></td><td><a href="device-guides/get-started-with-nuki-locks.md">get-started-with-nuki-locks.md</a></td><td><a href="device-guides/get-started-with-nuki-locks.md">get-started-with-nuki-locks.md</a></td></tr><tr><td><strong>Minut Sensors</strong></td><td>Connect and control Minut sensors. →</td><td><a href=".gitbook/assets/guides/minut-getting-seo-cover.jpg">minut-getting-seo-cover.jpg</a></td><td><a href="device-guides/get-started-with-minut-sensors.md">get-started-with-minut-sensors.md</a></td><td><a href="device-guides/get-started-with-minut-sensors.md">get-started-with-minut-sensors.md</a></td></tr><tr><td><strong>NoiseAware Sensors</strong></td><td>Connect and control NoiseAware sensors. →</td><td><a href=".gitbook/assets/guides/noiseaware-getting-seo-cover.jpg">noiseaware-getting-seo-cover.jpg</a></td><td><a href="device-guides/get-started-with-noiseaware-sensors.md">get-started-with-noiseaware-sensors.md</a></td><td><a href="device-guides/get-started-with-noiseaware-sensors.md">get-started-with-noiseaware-sensors.md</a></td></tr><tr><td><strong>2N Intercom</strong></td><td>Connect and control 2N devices. →</td><td><a href=".gitbook/assets/guides/2n-getting-started-seo-cover.png">2n-getting-started-seo-cover.png</a></td><td><a href="device-guides/get-started-with-2n-intercoms.md">get-started-with-2n-intercoms.md</a></td><td><a href="device-guides/get-started-with-2n-intercoms.md">get-started-with-2n-intercoms.md</a></td></tr><tr><td><strong>ecobee Thermostats</strong></td><td>Connect and control ecobee thermostats. →</td><td><a href=".gitbook/assets/ecobee-getting-seo-cover (1).png">ecobee-getting-seo-cover (1).png</a></td><td></td><td></td></tr><tr><td><strong>igloohome Locks</strong></td><td>Connect and control igloohome locks. →</td><td><a href=".gitbook/assets/guides/igloo-getting-seo-cover.png">igloo-getting-seo-cover.png</a></td><td></td><td><a href="device-guides/get-started-with-igloo-locks.md">get-started-with-igloo-locks.md</a></td></tr></tbody></table> |