https://github.com/seamapi/php
PHP SDK for using Seam Connect to control door locks and other IoT devices
https://github.com/seamapi/php
maintained
Last synced: 2 days ago
JSON representation
PHP SDK for using Seam Connect to control door locks and other IoT devices
- Host: GitHub
- URL: https://github.com/seamapi/php
- Owner: seamapi
- Created: 2022-09-12T17:59:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-12-12T03:13:09.000Z (6 days ago)
- Last Synced: 2025-12-13T10:13:32.730Z (5 days ago)
- Topics: maintained
- Language: PHP
- Homepage:
- Size: 1 MB
- Stars: 4
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Seam PHP SDK
Control locks, lights and other internet of things devices with Seam's simple API.
Check out [the documentation](https://docs.seam.co) or the usage below.
## Usage
```php
$seam = new Seam\SeamClient("YOUR_API_KEY");
# Create a Connect Webview to login to a provider
$connect_webview = $seam->connect_webviews->create(
accepted_providers: ["august"]
);
print "Please Login at this url: " . $connect_webview->url;
# Poll until connect webview is completed
while (true) {
$connect_webview = $seam->connect_webviews->get(
$connect_webview->connect_webview_id
);
if ($connect_webview->status == "authorized") {
break;
} else {
sleep(1);
}
}
$connected_account = $seam->connected_accounts->get(
$connect_webview->connected_account_id
);
print "Looks like you connected with " .
json_encode($connected_account->user_identifier);
$devices = $seam->devices->list(
connected_account_id: $connected_account->connected_account_id
);
print "You have " . count($devices) . " devices";
$device_id = $devices[0]->device_id;
# Lock a Door
$seam->locks->lock_door($device_id);
$updated_device = $seam->devices->get($device_id);
$updated_device->properties->locked; // true
# Unlock a Door
$seam->locks->unlock_door($device_id);
$updated_device->properties->locked; // false
# Create an access code on a device
$access_code = $seam->access_codes->create(
device_id: $device_id,
code: "1234",
name: "Test Code"
);
# Check the status of an access code
$access_code->status; // 'setting' (it will go to 'set' when active on the device)
$seam->access_codes->delete($access_code->access_code_id);
```
### Pagination
Some Seam API endpoints that return lists of resources support pagination.
Use the `Paginator` class to fetch and process resources across multiple pages.
#### Manually fetch pages with the next_page_cursor
```php
$pages = $seam->createPaginator(
fn($params) => $seam->connected_accounts->list(...$params),
["limit" => 2]
);
[$connectedAccounts, $pagination] = $pages->firstPage();
if ($pagination->has_next_page) {
[$moreConnectedAccounts] = $pages->nextPage($pagination->next_page_cursor);
}
```
#### Resume pagination
Get the first page on initial load:
```php
$params = ["limit" => 20];
$pages = $seam->createPaginator(
fn($p) => $seam->connected_accounts->list(...$p),
$params
);
[$connectedAccounts, $pagination] = $pages->firstPage();
// Store pagination state for later use
file_put_contents(
"/tmp/seam_connected_accounts_list.json",
json_encode([$params, $pagination])
);
```
Get the next page at a later time:
```php
$stored_data = json_decode(
file_get_contents("/tmp/seam_connected_accounts_list.json") ?: "[]",
false
);
$params = $stored_data[0] ?? [];
$pagination =
$stored_data[1] ??
(object) ["has_next_page" => false, "next_page_cursor" => null];
if ($pagination->has_next_page) {
$pages = $seam->createPaginator(
fn($p) => $seam->connected_accounts->list(...$p),
$params
);
[$moreConnectedAccounts] = $pages->nextPage($pagination->next_page_cursor);
}
```
#### Iterate over all resources
```php
$pages = $seam->createPaginator(
fn($p) => $seam->connected_accounts->list(...$p),
["limit" => 20]
);
foreach ($pages->flatten() as $connectedAccount) {
print $connectedAccount->account_type_display_name . "\n";
}
```
#### Return all resources across all pages as an array
```php
$pages = $seam->createPaginator(
fn($p) => $seam->connected_accounts->list(...$p),
["limit" => 20]
);
$connectedAccounts = $pages->flattenToArray();
```
## Installation
To install the latest version of the automatically generated SDK, run:
`composer require seamapi/seam`
If you want to install our previous handwritten version, run:
`composer require seamapi/seam:1.1`
## Development Setup
1. Run `yarn install` to get prettier installed for formatting
2. Install [composer](https://getcomposer.org/).
3. Run `composer install` in this directory
4. Run `composer exec phpunit tests`
> To run a specific test file, do `composer exec phpunit tests/MyTest.php`
### Running Tests
You'll need to export `SEAM_API_KEY` to a sandbox workspace API key.