This repository has been archived by the owner on Nov 15, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
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
Showing
1 changed file
with
2 additions
and
123 deletions.
There are no files selected for viewing
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,123 +1,2 @@ | ||
# Javascript / Typescript Seam API Library & CLI | ||
|
||
Control locks, lights and other internet of things devices with Seam's simple API! | ||
|
||
Check out [the generated typescript docs](./docs/modules.md) or some examples: | ||
- [Getting Started Guide with Examples](https://docs.seam.co/github-seam-api-docs/device-guides/get-started-with-august-locks) | ||
- [CLI Usage](#cli-usage) | ||
- [Library Usage](#library-usage) | ||
- [Receiving Webhooks](#receiving-webhooks) | ||
|
||
## Usage | ||
|
||
This package contains both a library and a CLI tool. | ||
|
||
### CLI Usage | ||
|
||
Install with `yarn global add seamapi` or `npm install -g seamapi`. | ||
|
||
Then: | ||
```bash | ||
export SEAM_API_KEY=<your api key> # you can also pass this as an argument to the CLI | ||
|
||
seam workspaces list | ||
``` | ||
|
||
### Library Usage | ||
|
||
Install with `yarn add seamapi` or `npm install seamapi -s`. | ||
|
||
Then: | ||
```ts | ||
// Replace with | ||
// const { Seam } = require("seamapi") | ||
// if not using ES6 modules and/or TypeScript. | ||
import Seam from "seamapi"; | ||
|
||
// Seam will automatically use the SEAM_API_KEY environment variable if you | ||
// don't provide an apiKey to `new Seam()` | ||
const seam = new Seam(); | ||
|
||
const myLock = await seam.locks.get({ name: "My Lock" }); | ||
const myLockId = myLock.device_id | ||
await seam.locks.lockDoor(myLockId); | ||
|
||
console.log(await seam.locks.list()) | ||
/* | ||
[ | ||
{ | ||
device_id: '1815b031-e531-432a-9ae6-b3f2cfb77cab', | ||
device_type: 'smartthings_lock', | ||
capabilities_supported: [ 'access_code', 'lock' ], | ||
properties: { | ||
locked: true, | ||
online: true, | ||
name: 'My Lock' | ||
}, | ||
connected_account_id: '1696fff5-b791-4e30-b039-d8110c78231c', | ||
workspace_id: '2ff17969-b283-426f-9e8f-045323615eee', | ||
created_at: '2022-02-25T08:47:56.486Z' | ||
} | ||
] | ||
*/ | ||
|
||
await seam.accessCodes.create({ | ||
name: "Some Access Code", | ||
code: "1234", | ||
device_id: someLockId, | ||
}); | ||
|
||
console.log(await seam.accessCodes.list({ device_id: myLockId })) | ||
/* | ||
[ | ||
{ | ||
access_code_id: '6a556ffe-3253-4c31-804e-2c0a32d9015f', | ||
code: '1234', | ||
name: 'Some Access Code', | ||
type: 'ongoing', | ||
status: 'set', | ||
created_at: '2022-02-25T18:46:20.318Z' | ||
} | ||
] | ||
*/ | ||
``` | ||
|
||
### Receiving Webhooks | ||
|
||
Although you don't need to use this package when receiving webhooks, we **strongly** recommend that you do. Using the included helper class will verify payloads (preventing malicious requests) and return a well-typed event. | ||
|
||
`SeamWebhook` is a thin wrapper around the `Webhook` class from the [Svix library](https://docs.svix.com/receiving/verifying-payloads/how). | ||
|
||
Example for Express: | ||
|
||
```ts | ||
// Replace with | ||
// const { SeamWebhook } = require("seamapi") | ||
// if not using ES6 modules and/or TypeScript. | ||
import { SeamWebhook } from "seamapi"; | ||
|
||
import bodyParser from "body-parser"; | ||
|
||
// Get this from the Seam dashboard | ||
const secret = "sample-secret"; | ||
|
||
app.post('/webhook', bodyParser.raw({type: 'application/json'}), (req, res) => { | ||
const payload = req.body; | ||
const headers = req.headers; | ||
|
||
const wh = new SeamWebhook(secret); | ||
let msg; | ||
try { | ||
msg = wh.verify(payload, headers); | ||
} catch (err) { | ||
res.status(400).json({}); | ||
} | ||
|
||
// Do something with the message... | ||
|
||
res.json({}); | ||
}); | ||
``` | ||
|
||
For examples using other frameworks, see the [Svix docs](https://docs.svix.com/receiving/verifying-payloads/how#framework-specific-examples). | ||
|
||
This package has moved to [seam](https://www.npmjs.com/package/seam). | ||
Please refer to the [migration guide](https://github.com/seamapi/javascript/releases/tag/v1.0.0). |