Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 43 additions & 5 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ redirects:
core-concepts/workspaces/personal-access-tokens: core-concepts/authentication/personal-access-tokens.md
core-concepts/workspaces/client-session-tokens: core-concepts/authentication/client-session-tokens/README.md
core-concepts/workspaces/client-session-tokens/implementing-client-sessions-for-device-management-in-the-backend: core-concepts/authentication/client-session-tokens/implementing-client-sessions-for-device-management-in-the-backend.md
products/access-systems/user-management: capability-guides/access-systems/user-management.md
capability-guides/access-systems/managing-credentials: capability-guides/access-systems/managing-credentials.md
capability-guides/access-systems/assigning-credentials-to-users: capability-guides/access-systems/managing-credentials/assigning-credentials-to-users.md
products/access-systems/suspending-and-unsuspending-users: capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md
products/access-systems/user-management: low-level-apis/access-systems/user-management.md
capability-guides/access-systems/managing-credentials: low-level-apis/access-systems/managing-credentials.md
capability-guides/access-systems/assigning-credentials-to-users: low-level-apis/access-systems/managing-credentials/assigning-credentials-to-users.md
products/access-systems/suspending-and-unsuspending-users: low-level-apis/access-systems/user-management/suspending-and-unsuspending-users.md
products/seam-bridge-in-development: capability-guides/seam-bridge.md
core-concepts/connect-webviews: core-concepts/connect-webviews/README.md
capability-guides/access-systems/understanding-acs-differences: capability-guides/access-systems/README.md
capability-guides/access-systems/understanding-acs-differences: low-level-apis/access-systems/README.md
capability-guides/thermostats/creating-and-managing-climate-schedules: capability-guides/thermostats/creating-and-managing-thermostat-schedules.md
capability-guides/access-grants: use-cases/granting-access/README.md
capability-guides/access-grants/access-grant-quick-start: use-cases/granting-access/access-grant-quick-start.md
Expand All @@ -33,3 +33,41 @@ redirects:
capability-guides/access-grants/updating-an-access-grant: use-cases/granting-access/updating-an-access-grant.md
capability-guides/access-grants/revoking-an-access-method: use-cases/granting-access/revoking-an-access-method.md
capability-guides/access-grants/deleting-an-access-grant: use-cases/granting-access/deleting-an-access-grant.md
capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start: low-level-apis/access-systems/acs-quick-starts/encodable-key-card-quick-start.md
capability-guides/access-systems/acs-quick-starts/mobile-key-quick-start: low-level-apis/access-systems/acs-quick-starts/mobile-key-quick-start.md
capability-guides/access-systems/acs-quick-starts/pin-code-quick-start: low-level-apis/access-systems/acs-quick-starts/pin-code-quick-start.md
capability-guides/access-systems/acs-quick-starts: low-level-apis/access-systems/acs-quick-starts/README.md
capability-guides/access-systems/connect-an-acs-to-seam: low-level-apis/access-systems/connect-an-acs-to-seam/README.md
capability-guides/access-systems/managing-credentials/assigning-credentials-to-users: low-level-apis/access-systems/managing-credentials/assigning-credentials-to-users.md
capability-guides/access-systems/managing-credentials/listing-credentials-and-associated-entrances: low-level-apis/access-systems/managing-credentials/listing-credentials-and-associated-entrances.md
capability-guides/access-systems/retrieving-entrance-details: low-level-apis/access-systems/retrieving-entrance-details.md
capability-guides/access-systems/troubleshooting-your-access-control-system: low-level-apis/access-systems/troubleshooting-your-access-control-system.md
capability-guides/access-systems/user-management/assigning-users-to-access-groups: low-level-apis/access-systems/user-management/assigning-users-to-access-groups.md
capability-guides/access-systems/user-management/suspending-and-unsuspending-users: low-level-apis/access-systems/user-management/suspending-and-unsuspending-users.md
capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods: low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md
capability-guides/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards: low-level-apis/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards.md
capability-guides/smart-locks/access-codes/access-code-requirements-for-door-locks: low-level-apis/smart-locks/access-codes/access-code-requirements-for-door-locks.md
capability-guides/smart-locks/access-codes/accommodating-manufacturer-mobile-apps: low-level-apis/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md
capability-guides/smart-locks/access-codes/backup-access-codes: low-level-apis/smart-locks/access-codes/backup-access-codes.md
capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints: low-level-apis/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md
capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes: low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md
capability-guides/smart-locks/access-codes/deleting-access-codes: low-level-apis/smart-locks/access-codes/deleting-access-codes.md
capability-guides/smart-locks/access-codes/lifecycle-of-access-codes: low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes.md
capability-guides/smart-locks/access-codes/migrating-existing-access-codes: low-level-apis/smart-locks/access-codes/migrating-existing-access-codes.md
capability-guides/smart-locks/access-codes/modifying-access-codes: low-level-apis/smart-locks/access-codes/modifying-access-codes.md
capability-guides/smart-locks/access-codes/retrieving-access-codes: low-level-apis/smart-locks/access-codes/retrieving-access-codes.md
capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues: low-level-apis/smart-locks/access-codes/troubleshooting-access-code-issues.md
capability-guides/smart-locks/access-codes: low-level-apis/smart-locks/access-codes/README.md
capability-guides/smart-locks/lock-and-unlock: low-level-apis/smart-locks/lock-and-unlock.md
capability-guides/smart-locks: low-level-apis/smart-locks/README.md

capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources: low-level-apis/access-systems/connect-an-acs-to-seam/access-control-system-resources.md
capability-guides/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details: low-level-apis/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md
capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences: low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md
capability-guides/access-systems/user-management: low-level-apis/access-systems/user-management.md
capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials: low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md
capability-guides/access-systems/working-with-card-encoders-and-scanners: low-level-apis/access-systems/working-with-card-encoders-and-scanners/README.md
capability-guides/access-systems: low-level-apis/access-systems/README.md
capability-guides/smart-locks/access-codes/creating-access-codes: low-level-apis/smart-locks/access-codes/creating-access-codes/README.md
capability-guides/smart-locks/access-codes/offline-access-codes: low-level-apis/smart-locks/access-codes/offline-access-codes.md
capability-guides/smart-locks/get-started-with-smartlocks-api: low-level-apis/smart-locks/get-started-with-smartlocks-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ $seam->locks->lock_door($lock->device_id);

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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) and allows you to create and manage them through the Seam API.
Seam maps these residents to [access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) and allows you to create and manage them through the Seam API.

{% tabs %}
{% tab title="JavaScript" %}
Expand Down
4 changes: 2 additions & 2 deletions docs/brand-guides/33-lock-devices/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ For detailed information about the 33 Lock devices that Seam supports, see our [

We support the following features:

* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock)
* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)
* [Triggering web lock and unlock actions](https://docs.seam.co/latest/low-level-apis/smart-locks/lock-and-unlock)
* [Programming access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes)

***

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,7 @@ True

Next, you can use the Seam API to control your lock.

Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock), [programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), and so on. Seam's intuitive and granular [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide.
Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](https://docs.seam.co/latest/low-level-apis/smart-locks/lock-and-unlock), [programming access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes), and so on. Seam's intuitive and granular [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide.

Try out the following actions on your 33 Lock device:

Expand Down Expand Up @@ -1010,9 +1010,9 @@ Now that you have successfully unlocked your lock, you can use the [Lock Door](h

### Program access codes on your lock

You can use the Seam API to program [online access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on 33 Lock devices. These devices have an integrated keypad. Lock users can then enter these access codes using the keypad to unlock the lock.
You can use the Seam API to program [online access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) on 33 Lock devices. These devices have an integrated keypad. Lock users can then enter these access codes using the keypad to unlock the lock.

The Seam API makes it easy to program both [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes) online access codes.
The Seam API makes it easy to program both [ongoing](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes#time-bound-access-codes) online access codes.

{% tabs %}
{% tab title="JavaScript" %}
Expand Down Expand Up @@ -1400,7 +1400,7 @@ Now that you've completed this getting started guide for 33 Lock devices, you ca
* [ ] **Use webhooks**\
Learn how to use [webhooks](https://docs.seam.co/latest/developer-tools/webhooks) as an efficient way to receive device events.
* [ ] **Find out more**\
Explore the other types of devices and systems that you can control with Seam, including [access control systems](https://docs.seam.co/latest/capability-guides/access-systems), [thermostats](https://docs.seam.co/latest/capability-guides/thermostats), and [noise sensors](https://docs.seam.co/latest/capability-guides/noise-sensors).
Explore the other types of devices and systems that you can control with Seam, including [access control systems](https://docs.seam.co/latest/low-level-apis/access-systems), [thermostats](https://docs.seam.co/latest/capability-guides/thermostats), and [noise sensors](https://docs.seam.co/latest/capability-guides/noise-sensors).
* [ ] **Develop for mobile access**\
Learn about Seam's [mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access).

Expand Down
4 changes: 2 additions & 2 deletions docs/brand-guides/4suites-locks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ For detailed information about the 4SUITES devices that Seam supports, see our [

We support the following features:

* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock)
* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)
* [Triggering web lock and unlock actions](https://docs.seam.co/latest/low-level-apis/smart-locks/lock-and-unlock)
* [Programming access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes)

***

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -675,7 +675,7 @@ True

Next, you can use the Seam API to control your lock.

Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock), [programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), and so on. Seam's intuitive and granular [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide.
Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](https://docs.seam.co/latest/low-level-apis/smart-locks/lock-and-unlock), [programming access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes), and so on. Seam's intuitive and granular [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide.

Try out the following actions on your 4SUITES lock:

Expand Down Expand Up @@ -1018,7 +1018,7 @@ Now that you've completed this getting started guide for 4SUITES devices, you ca
* [ ] **Use webhooks**\
Learn how to use [webhooks](https://docs.seam.co/latest/developer-tools/webhooks) as an efficient way to receive device events.
* [ ] **Find out more**\
Explore the other types of devices and systems that you can control with Seam, including [access control systems](https://docs.seam.co/latest/capability-guides/access-systems), [thermostats](https://docs.seam.co/latest/capability-guides/thermostats), and [noise sensors](https://docs.seam.co/latest/capability-guides/noise-sensors).
Explore the other types of devices and systems that you can control with Seam, including [access control systems](https://docs.seam.co/latest/low-level-apis/access-systems), [thermostats](https://docs.seam.co/latest/capability-guides/thermostats), and [noise sensors](https://docs.seam.co/latest/capability-guides/noise-sensors).
* [ ] **Develop for mobile access**\
Learn about Seam's [mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access).

Expand Down
4 changes: 2 additions & 2 deletions docs/brand-guides/akiles-locks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ For detailed information about the Akiles devices that Seam supports, see our [A

We support the following features:

* [Triggering web unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock)
* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on devices that have an integrated keypad or Akiles Pinpad
* [Triggering web unlock actions](https://docs.seam.co/latest/low-level-apis/smart-locks/lock-and-unlock)
* [Programming access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) on devices that have an integrated keypad or Akiles Pinpad

***

Expand Down
Loading
Loading