diff --git a/.gitbook.yaml b/.gitbook.yaml index 14ba18a89..555c00977 100644 --- a/.gitbook.yaml +++ b/.gitbook.yaml @@ -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 @@ -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 diff --git a/docs/brand-guides/2n-intercom-systems/get-started-with-2n-intercoms.md b/docs/brand-guides/2n-intercom-systems/get-started-with-2n-intercoms.md index bcae4a999..f02bc6490 100644 --- a/docs/brand-guides/2n-intercom-systems/get-started-with-2n-intercoms.md +++ b/docs/brand-guides/2n-intercom-systems/get-started-with-2n-intercoms.md @@ -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" %} diff --git a/docs/brand-guides/33-lock-devices/README.md b/docs/brand-guides/33-lock-devices/README.md index fa0ae13f0..efa23c2e1 100644 --- a/docs/brand-guides/33-lock-devices/README.md +++ b/docs/brand-guides/33-lock-devices/README.md @@ -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) *** diff --git a/docs/brand-guides/33-lock-devices/get-started-with-33-lock-devices.md b/docs/brand-guides/33-lock-devices/get-started-with-33-lock-devices.md index 83b9510ad..cb1e36958 100644 --- a/docs/brand-guides/33-lock-devices/get-started-with-33-lock-devices.md +++ b/docs/brand-guides/33-lock-devices/get-started-with-33-lock-devices.md @@ -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: @@ -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" %} @@ -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). diff --git a/docs/brand-guides/4suites-locks/README.md b/docs/brand-guides/4suites-locks/README.md index 0146191eb..8cc90893d 100644 --- a/docs/brand-guides/4suites-locks/README.md +++ b/docs/brand-guides/4suites-locks/README.md @@ -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) *** diff --git a/docs/brand-guides/4suites-locks/get-started-with-4suites-locks.md b/docs/brand-guides/4suites-locks/get-started-with-4suites-locks.md index b9b617606..2df0f9408 100644 --- a/docs/brand-guides/4suites-locks/get-started-with-4suites-locks.md +++ b/docs/brand-guides/4suites-locks/get-started-with-4suites-locks.md @@ -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: @@ -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). diff --git a/docs/brand-guides/akiles-locks/README.md b/docs/brand-guides/akiles-locks/README.md index 0b486e23f..813c925fc 100644 --- a/docs/brand-guides/akiles-locks/README.md +++ b/docs/brand-guides/akiles-locks/README.md @@ -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 *** diff --git a/docs/brand-guides/akiles-locks/get-started-with-akiles-locks.md b/docs/brand-guides/akiles-locks/get-started-with-akiles-locks.md index d45ca7b4b..b634860b9 100644 --- a/docs/brand-guides/akiles-locks/get-started-with-akiles-locks.md +++ b/docs/brand-guides/akiles-locks/get-started-with-akiles-locks.md @@ -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 Akiles lock: @@ -987,9 +987,9 @@ False ### 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 Akiles locks that have an integrated keypad or an Akiles Pinpad. Lock users can then enter these access codes using the keypad or Pinpad 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 Akiles locks that have an integrated keypad or an Akiles Pinpad. Lock users can then enter these access codes using the keypad or Pinpad 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" %} @@ -1377,7 +1377,7 @@ Now that you've completed this getting started guide for Akiles devices, you can * [ ] **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). diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/README.md index a9e5b3d8c..9463aa8f1 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/README.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/README.md @@ -22,8 +22,8 @@ For detailed information about the ASSA ABLOY Visionline devices that Seam suppo We support the following features: -* [Managing access systems](https://docs.seam.co/latest/capability-guides/access-systems) -* [Issuing plastic card credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#create-a-key-card-based-credential) +* [Managing access systems](https://docs.seam.co/latest/low-level-apis/access-systems) +* [Issuing plastic card credentials](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials#create-a-key-card-based-credential) * [Issuing mobile access credentials](https://docs.seam.co/latest/capability-guides/mobile-access) *** @@ -36,7 +36,7 @@ To create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect- ## Troubleshooting -For information about Visionline ACS-related errors, including issues related to the connection between your ACS and Seam, see [Troubleshooting Your ACS](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system). +For information about Visionline ACS-related errors, including issues related to the connection between your ACS and Seam, see [Troubleshooting Your ACS](https://docs.seam.co/latest/low-level-apis/access-systems/troubleshooting-your-access-control-system). *** diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md index 9805bb242..828eebb34 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md @@ -10,7 +10,7 @@ This guide describes how to issue guest and staff mobile credentials on the Visi ## Access Permission Assignment for Visionline -Visionline is a [credential-based access control system](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-access-control-systems). That is, you create ACS users and credentials. Within these credentials, you specify the set of entrances to which you want to grant access and the schedules for this access. +Visionline is a [credential-based access control system](https://docs.seam.co/latest/low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-access-control-systems). That is, you create ACS users and credentials. Within these credentials, you specify the set of entrances to which you want to grant access and the schedules for this access. ### Credential Types for Visionline @@ -29,7 +29,7 @@ Seam currently only supports issuing guest mobile credentials and plastic cards. Use the following basic process to grant access in a Visionline ACS: 1. Set up the mobile user account by creating a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -2. Associate the user identity with an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems#what-is-a-user). +2. Associate the user identity with an [ACS user](https://docs.seam.co/latest/low-level-apis/access-systems#what-is-a-user). 3. Gather the entrances to which the credential should have access. 4. Create the [guest](./#issuing-guest-mobile-credentials) mobile credential. diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md index beb7a0398..c15036c9f 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/revoking-mobile-credentials.md @@ -4,7 +4,7 @@ description: Learn how to delete mobile credentials. # Revoking Mobile Credentials -To revoke a mobile credential, [delete the credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#delete-a-credential). Seam issues a discard command for the Visionline card. If you are deleting a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials), Seam discards all of the credentials that were created underneath it. +To revoke a mobile credential, [delete the credential](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials#delete-a-credential). Seam issues a discard command for the Visionline card. If you are deleting a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials), Seam discards all of the credentials that were created underneath it. {% tabs %} {% tab title="JavaScript" %} diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md index e76a23bbe..21d32b6bc 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md @@ -6,8 +6,8 @@ description: Learn how to create a card-based credential for Visionline. To create a credential to encode onto a plastic key card for a Visionline ACS: -1. Set up an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -2. Create a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#create-a-card-based-credential) with the `access_method` set to `card` and the appropriate [`visionline_metadata`](mobile-credential-related-properties.md#acs_credential.visionline_metadata-properties), such as the card format. +1. Set up an [ACS user](https://docs.seam.co/latest/low-level-apis/access-systems/user-management). +2. Create a [credential](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials#create-a-card-based-credential) with the `access_method` set to `card` and the appropriate [`visionline_metadata`](mobile-credential-related-properties.md#acs_credential.visionline_metadata-properties), such as the card format. * To issue the first credential for a reservation—that is, an "override" credential—make sure to set `visionline_metadata.override` to `true`. * To issue subsequent credentials for a reservation, set the `visionline_metadata.joiner_acs_credential_ids`. @@ -15,11 +15,11 @@ To create a credential to encode onto a plastic key card for a Visionline ACS: For more information about Visionline credential types, see [Credential Types for Visionline](configuring-visionline-mobile-credentials/#credential-types-for-visionline) and [Guest Mobile Credential Types](configuring-visionline-mobile-credentials/#guest-mobile-credential-types). 3. Encode the credential onto a plastic card. 1. Use the `/acs/encoders/list` endpoint to retrieve a list of available encoders. Then, choose the encoder that you want to use to write the credential to the card.\ - See [Retrieve Encoders](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-2.-retrieve-encoders). + See [Retrieve Encoders](https://docs.seam.co/latest/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-2.-retrieve-encoders). 2. Use the `/acs/encoders/encode_credential` endpoint to encode the credential onto the card, using the encoder that you have chosen.\ - See [Encode the Card](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-3.-encode-the-card). + See [Encode the Card](https://docs.seam.co/latest/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-3.-encode-the-card). 3. Confirm that the card was encoded successfully using polling or a [webhook](https://docs.seam.co/latest/developer-tools/webhooks).\ - See [Confirm Successful Encoding](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-4.-confirm-successful-encoding). Also, see a list of [common encoding errors](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#common-encoding-errors). + See [Confirm Successful Encoding](https://docs.seam.co/latest/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-4.-confirm-successful-encoding). Also, see a list of [common encoding errors](https://docs.seam.co/latest/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#common-encoding-errors). The following example shows how to create a card-based override credential for Visionline and encode it onto a plastic card: @@ -479,4 +479,4 @@ $seam->action_attempts->get( ## Next Steps -You can use an encoder to scan a plastic key card to read its encoded parameters. The scan result includes the card's properties, such as its card number, serial number, and other useful details. For more information, see [Scanning Encoded Cards](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards). \ No newline at end of file +You can use an encoder to scan a plastic key card to read its encoded parameters. The scan result includes the card's properties, such as its card number, serial number, and other useful details. For more information, see [Scanning Encoded Cards](https://docs.seam.co/latest/low-level-apis/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards). \ No newline at end of file diff --git a/docs/brand-guides/august-locks/README.md b/docs/brand-guides/august-locks/README.md index c3326470c..90e69780d 100644 --- a/docs/brand-guides/august-locks/README.md +++ b/docs/brand-guides/august-locks/README.md @@ -28,8 +28,8 @@ For detailed information about the August devices that Seam supports, see our [A 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) on locks that have an installed August Smart Keypad +* [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) on locks that have an installed August Smart Keypad *** diff --git a/docs/brand-guides/august-locks/get-started-with-august-locks.md b/docs/brand-guides/august-locks/get-started-with-august-locks.md index df14ecdb9..f90f99cb0 100644 --- a/docs/brand-guides/august-locks/get-started-with-august-locks.md +++ b/docs/brand-guides/august-locks/get-started-with-august-locks.md @@ -700,7 +700,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 August lock: @@ -1016,9 +1016,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 August locks that have an integrated or accessory 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 August locks that have an integrated or accessory 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" %} @@ -1406,7 +1406,7 @@ Now that you've completed this getting started guide for August devices, you can * [ ] **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). diff --git a/docs/brand-guides/avigilon-alta-access-system/README.md b/docs/brand-guides/avigilon-alta-access-system/README.md index dd821426e..3559d71e8 100644 --- a/docs/brand-guides/avigilon-alta-access-system/README.md +++ b/docs/brand-guides/avigilon-alta-access-system/README.md @@ -24,7 +24,7 @@ For detailed information about the Avigilon Alta-connected devices that Seam sup We support the following features: -* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/low-level-apis/smart-locks/lock-and-unlock) *** diff --git a/docs/brand-guides/brivo-access/README.md b/docs/brand-guides/brivo-access/README.md index 2400600a5..277e7ff8c 100644 --- a/docs/brand-guides/brivo-access/README.md +++ b/docs/brand-guides/brivo-access/README.md @@ -12,7 +12,7 @@ Seam integrates with Brivo, which produces an access control platform for applic ## Supported Devices -This integration supports all [readers](https://www.brivo.com/products/smart-readers/), [control panels](https://www.brivo.com/products/control-panels/), and [wireless smart locks](https://www.brivo.com/capability-guides/smart-locks/) connected to the Brivo Access platform. Brivo control panels also integrate with any Wiegand or Open Supervised Device Protocol (OSDP) readers. +This integration supports all [readers](https://www.brivo.com/products/smart-readers/), [control panels](https://www.brivo.com/products/control-panels/), and [wireless smart locks](https://www.brivo.com/low-level-apis/smart-locks/) connected to the Brivo Access platform. Brivo control panels also integrate with any Wiegand or Open Supervised Device Protocol (OSDP) readers. The Brivo Access platform supports the following wireless locks: @@ -26,9 +26,9 @@ For detailed information about the Brivo-connected devices that Seam supports, s 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) for readers and locks that have a keypad -* [Managing access systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [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) for readers and locks that have a keypad +* [Managing access systems](https://docs.seam.co/latest/low-level-apis/access-systems) *** diff --git a/docs/brand-guides/dormakaba-oracode-locks/README.md b/docs/brand-guides/dormakaba-oracode-locks/README.md index 2e609f5cb..79f4ba0aa 100644 --- a/docs/brand-guides/dormakaba-oracode-locks/README.md +++ b/docs/brand-guides/dormakaba-oracode-locks/README.md @@ -26,7 +26,7 @@ For detailed information about the dormakaba Oracode devices that Seam supports, We support the following features: -* [Programming offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) +* [Programming offline access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes) *** diff --git a/docs/brand-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md b/docs/brand-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md index f0d5d0a58..a48e596e9 100644 --- a/docs/brand-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md +++ b/docs/brand-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md @@ -7,15 +7,15 @@ hidden: true # Creating dormakaba Oracode Offline Access Codes -The Seam integration for dormakaba Oracode enables you to manage [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for dormakaba Oracode locks. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. +The Seam integration for dormakaba Oracode enables you to manage [offline access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes) for dormakaba Oracode locks. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. -To learn about the special requirements regarding offline access codes for dormakaba Oracode locks, see [Offline Access Code Requirements](creating-dormakaba-oracode-offline-access-codes.md#offline-access-code-requirements). For more information about using offline access codes, see [Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes) and [Managing Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). +To learn about the special requirements regarding offline access codes for dormakaba Oracode locks, see [Offline Access Code Requirements](creating-dormakaba-oracode-offline-access-codes.md#offline-access-code-requirements). For more information about using offline access codes, see [Offline Access Codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes#offline-access-codes) and [Managing Offline Access Codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes). *** ## Offline Access Code Requirements -Seam supports daily-bound and hourly-bound [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for dormakaba Oracode locks. Note the following dormakaba Oracode-specific restrictions and requirements for offline access codes: +Seam supports daily-bound and hourly-bound [offline access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes) for dormakaba Oracode locks. Note the following dormakaba Oracode-specific restrictions and requirements for offline access codes: ### Duration @@ -93,7 +93,7 @@ You can create hourly- and daily-bound offline access codes for dormakaba Oracod ### Hourly-Bound Offline Access Codes -To [create an hourly-bound offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes), issue an access code creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the dormakaba Oracode offline access code server. +To [create an hourly-bound offline access code](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes), issue an access code creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the dormakaba Oracode offline access code server. #### 1. Create an Hourly-Bound Offline Access Code @@ -370,7 +370,7 @@ if (device.CanProgramOfflineAccessCodes == true) { #### 2. Verify Successful Time-Bound Code Registration -The [lifecycle of a time-bound access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes) is marked by distinct phases: +The [lifecycle of a time-bound access code](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes) is marked by distinct phases: 1. `Unset`: When initially created on Seam, the offline access code remains in an `unset` state, indicating that it is not yet available for use on the lock due to a configured future activation time. 2. `Setting`: As the scheduled `starts_at` time approaches, Seam initiates the process of readying the code for use on the lock, transitioning the `status` of the offline code to `setting`. @@ -378,14 +378,14 @@ The [lifecycle of a time-bound access code](https://docs.seam.co/latest/capabili There are two methods to verify that an time-bound offline access code has been registered in the offline access code server that the device manufacturer maintains: -* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes#polling-method-1). -* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes#webhook-events-method-1). +* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/creating-access-codes#polling-method-1). +* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/creating-access-codes#webhook-events-method-1). *** ### Daily-Bound Offline Access Codes -To [create a daily-bound offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes), first issue a creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the dormakaba Oracode offline access code server. +To [create a daily-bound offline access code](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes), first issue a creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the dormakaba Oracode offline access code server. #### 1. Create a Daily-Bound Access Code @@ -670,7 +670,7 @@ if (device.CanProgramOfflineAccessCodes == true) { #### 2. Verify Successful Time-Bound Code Registration -The [lifecycle of a time-bound access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes) is marked by distinct phases: +The [lifecycle of a time-bound access code](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes) is marked by distinct phases: 1. `Unset`: When initially created on Seam, the offline access code remains in an `unset` state, indicating that it is not yet available for use on the lock due to a configured future activation time. 2. `Setting`: As the scheduled `starts_at` time approaches, Seam initiates the process of readying the code for use on the lock, transitioning the `status` of the offline code to `setting`. @@ -678,5 +678,5 @@ The [lifecycle of a time-bound access code](https://docs.seam.co/latest/capabili There are two methods to verify that an time-bound offline access code has been registered in the offline access code server that the device manufacturer maintains: -* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes#polling-method-1). -* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes#webhook-events-method-1). +* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/creating-access-codes#polling-method-1). +* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/creating-access-codes#webhook-events-method-1). diff --git a/docs/brand-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md b/docs/brand-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md index c2d23ca70..cd81b3fe5 100644 --- a/docs/brand-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md +++ b/docs/brand-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md @@ -4,7 +4,7 @@ Dormakaba Oracode locks use offline access codes (PIN codes) that are generated ### Understanding Oracode offline access codes -[**Offline access codes**](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) are PIN codes generated by Seam that work on the lock without an internet connection. Dormakaba maintains a server-based registry of synchronized encryption keys that enable these codes to work offline. +[**Offline access codes**](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes) are PIN codes generated by Seam that work on the lock without an internet connection. Dormakaba maintains a server-based registry of synchronized encryption keys that enable these codes to work offline. Once generated, you can share these codes with guests through messaging or your property management system—guests don't need to install any special app to unlock the door. diff --git a/docs/brand-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.md b/docs/brand-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.md index fb24f467c..fc4ead375 100644 --- a/docs/brand-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.md +++ b/docs/brand-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.md @@ -1865,7 +1865,7 @@ Now that you've completed this getting started guide for ecobee devices, you can * [ ] **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 [smart locks](https://docs.seam.co/latest/capability-guides/smart-locks), [access control systems](https://docs.seam.co/latest/capability-guides/access-systems), 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 [smart locks](https://docs.seam.co/latest/low-level-apis/smart-locks), [access control systems](https://docs.seam.co/latest/low-level-apis/access-systems), 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). diff --git a/docs/brand-guides/google-nest-thermostats/get-started-with-nest-thermostats.md b/docs/brand-guides/google-nest-thermostats/get-started-with-nest-thermostats.md index 017b422de..11573a851 100644 --- a/docs/brand-guides/google-nest-thermostats/get-started-with-nest-thermostats.md +++ b/docs/brand-guides/google-nest-thermostats/get-started-with-nest-thermostats.md @@ -1863,7 +1863,7 @@ Now that you've completed this getting started guide for Google Nest thermostats * [ ] **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 [smart locks](https://docs.seam.co/latest/capability-guides/smart-locks), [access control systems](https://docs.seam.co/latest/capability-guides/access-systems), 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 [smart locks](https://docs.seam.co/latest/low-level-apis/smart-locks), [access control systems](https://docs.seam.co/latest/low-level-apis/access-systems), 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). diff --git a/docs/brand-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md b/docs/brand-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md index 3f47531e3..18a46983c 100644 --- a/docs/brand-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md +++ b/docs/brand-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md @@ -1863,7 +1863,7 @@ Now that you've completed this getting started guide for Honeywell Resideo devic * [ ] **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 [smart locks](https://docs.seam.co/latest/capability-guides/smart-locks), [access control systems](https://docs.seam.co/latest/capability-guides/access-systems), 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 [smart locks](https://docs.seam.co/latest/low-level-apis/smart-locks), [access control systems](https://docs.seam.co/latest/low-level-apis/access-systems), 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). diff --git a/docs/brand-guides/igloohome-locks/README.md b/docs/brand-guides/igloohome-locks/README.md index 078fc4a02..bc7f6e6c4 100644 --- a/docs/brand-guides/igloohome-locks/README.md +++ b/docs/brand-guides/igloohome-locks/README.md @@ -32,9 +32,9 @@ Each igloohome Bridge supports up to five compatible igloohome locks. We support the following features: -* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) for igloohome smart locks connected through the igloohome Bridge -* [Programming online access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) -* [Programming offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/low-level-apis/smart-locks/lock-and-unlock) for igloohome smart locks connected through the igloohome Bridge +* [Programming online access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) +* [Programming offline access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes) {% hint style="info" %} We support customizable access codes for igloohome locks connected through the igloohome Bridge. We support offline algoPIN codes for all igloohome locks, without the need for a bridge. diff --git a/docs/brand-guides/igloohome-locks/creating-igloohome-offline-access-codes.md b/docs/brand-guides/igloohome-locks/creating-igloohome-offline-access-codes.md index 8945f8b01..803e216da 100644 --- a/docs/brand-guides/igloohome-locks/creating-igloohome-offline-access-codes.md +++ b/docs/brand-guides/igloohome-locks/creating-igloohome-offline-access-codes.md @@ -6,15 +6,15 @@ description: >- # Creating igloohome Offline Access Codes -In addition to supporting [online access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), the Seam integration for igloohome supports the generation of offline access codes (that is, igloohome [algoPIN™](https://www.igloohome.co/en-US/how-it-works) codes) for all igloohome lock models, without the need for a bridge. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. +In addition to supporting [online access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes), the Seam integration for igloohome supports the generation of offline access codes (that is, igloohome [algoPIN™](https://www.igloohome.co/en-US/how-it-works) codes) for all igloohome lock models, without the need for a bridge. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. -To learn about the special requirements regarding offline access codes for igloohome locks, see [Offline Access Code Requirements](creating-igloohome-offline-access-codes.md#offline-access-code-requirements). For more information about using offline access codes, see [Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes) and [Managing Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). +To learn about the special requirements regarding offline access codes for igloohome locks, see [Offline Access Code Requirements](creating-igloohome-offline-access-codes.md#offline-access-code-requirements). For more information about using offline access codes, see [Offline Access Codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes#offline-access-codes) and [Managing Offline Access Codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes). *** ## Offline Access Code Requirements -Seam supports the following types of [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for igloohome locks: +Seam supports the following types of [offline access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes) for igloohome locks: * [Hourly-bound](creating-igloohome-offline-access-codes.md#hourly-bound-offline-access-codes) * [Daily-bound](creating-igloohome-offline-access-codes.md#daily-bound-offline-access-codes) @@ -63,7 +63,7 @@ You can create hourly-bound, daily-bound, and one-time-use offline access codes ### Hourly-Bound Offline Access Codes -To [create an hourly-bound offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes), issue an access code creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the igloohome offline access code server. +To [create an hourly-bound offline access code](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes), issue an access code creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the igloohome offline access code server. #### 1. Create an Hourly-Bound Offline Access Code @@ -322,7 +322,7 @@ if (device.CanProgramOfflineAccessCodes == true) { #### 2. Verify Successful Time-Bound Code Registration -The [lifecycle of a time-bound access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes) is marked by distinct phases: +The [lifecycle of a time-bound access code](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes) is marked by distinct phases: 1. `Unset`: When initially created on Seam, the offline access code remains in an `unset` state, indicating that it is not yet available for use on the lock due to a configured future activation time. 2. `Setting`: As the scheduled `starts_at` time approaches, Seam initiates the process of readying the code for use on the lock, transitioning the `status` of the offline code to `setting`. @@ -330,14 +330,14 @@ The [lifecycle of a time-bound access code](https://docs.seam.co/latest/capabili There are two methods to verify that an time-bound offline access code has been registered in the offline access code server that the device manufacturer maintains: -* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes#polling-method-1). -* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes#webhook-events-method-1). +* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/creating-access-codes#polling-method-1). +* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/creating-access-codes#webhook-events-method-1). *** ### Daily-Bound Offline Access Codes -To [create a daily-bound offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes), first issue a creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the igloohome offline access code server. +To [create a daily-bound offline access code](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes), first issue a creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the igloohome offline access code server. #### 1. Create a Daily-Bound Access Code @@ -606,7 +606,7 @@ if (device.CanProgramOfflineAccessCodes == true) { #### 2. Verify Successful Time-Bound Code Registration -The [lifecycle of a time-bound access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes) is marked by distinct phases: +The [lifecycle of a time-bound access code](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes) is marked by distinct phases: 1. `Unset`: When initially created on Seam, the offline access code remains in an `unset` state, indicating that it is not yet available for use on the lock due to a configured future activation time. 2. `Setting`: As the scheduled `starts_at` time approaches, Seam initiates the process of readying the code for use on the lock, transitioning the `status` of the offline code to `setting`. @@ -614,11 +614,11 @@ The [lifecycle of a time-bound access code](https://docs.seam.co/latest/capabili There are two methods to verify that an time-bound offline access code has been registered in the offline access code server that the device manufacturer maintains: -* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes#polling-method-1). -* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes#webhook-events-method-1). +* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/creating-access-codes#polling-method-1). +* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/creating-access-codes#webhook-events-method-1). *** ### One-Time-Use Offline Access Codes -igloohome one-time-use offline access codes are valid for 24 hours from the `starts_at` timestamp that you configure. These codes expire after a single use. For detailed instructions, see [Creating One-Time-Use Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-one-time-use-offline-access-codes). +igloohome one-time-use offline access codes are valid for 24 hours from the `starts_at` timestamp that you configure. These codes expire after a single use. For detailed instructions, see [Creating One-Time-Use Offline Access Codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes#creating-one-time-use-offline-access-codes). diff --git a/docs/brand-guides/igloohome-locks/get-started-with-igloo-locks.md b/docs/brand-guides/igloohome-locks/get-started-with-igloo-locks.md index f327cd65f..2812c5488 100644 --- a/docs/brand-guides/igloohome-locks/get-started-with-igloo-locks.md +++ b/docs/brand-guides/igloohome-locks/get-started-with-igloo-locks.md @@ -346,7 +346,7 @@ $seam->locks->lock_door($lock->device_id); Most Igloohome locks come with a keypad built-in to program access codes. These codes can then be entered to unlock a Igloohome lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on an Igloohome lock. You can find out more about Igloohome lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on an Igloohome lock. You can find out more about Igloohome lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) {% hint style="info" %} Igloohome pins have to be 4-6 digits long, and for time bound access codes, start date can't be on the past. diff --git a/docs/brand-guides/kwikset-locks/README.md b/docs/brand-guides/kwikset-locks/README.md index f84d061fb..c54d15202 100644 --- a/docs/brand-guides/kwikset-locks/README.md +++ b/docs/brand-guides/kwikset-locks/README.md @@ -22,11 +22,11 @@ For detailed information about the Kwikset 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) {% hint style="info" %} -Seam does not support [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) for Kwikset. +Seam does not support [unmanaged access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) for Kwikset. {% endhint %} *** diff --git a/docs/brand-guides/kwikset-locks/get-started-with-kwikset-wifi-locks.md b/docs/brand-guides/kwikset-locks/get-started-with-kwikset-wifi-locks.md index b1b08537f..dce4c977a 100644 --- a/docs/brand-guides/kwikset-locks/get-started-with-kwikset-wifi-locks.md +++ b/docs/brand-guides/kwikset-locks/get-started-with-kwikset-wifi-locks.md @@ -361,7 +361,7 @@ If you're connected through Wi-Fi and not Bluetooth, the Kwikset app _only_ show Some Kwikset locks have a keypad paired to them to program access codes. These codes can then be entered to unlock a Kwikset lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Kwikset lock. You can find out more about Kwikset lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Kwikset lock. You can find out more about Kwikset lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) **Access Code Constraints** diff --git a/docs/brand-guides/latch-access-control-system/README.md b/docs/brand-guides/latch-access-control-system/README.md index 47d473390..b59ec8d17 100644 --- a/docs/brand-guides/latch-access-control-system/README.md +++ b/docs/brand-guides/latch-access-control-system/README.md @@ -6,7 +6,7 @@ description: Guide for using the Latch Access Control System with Seam ## Overview -Seam integrates seamlessly with the [Latch](https://www.latch.com/) management platform. Property managers and owners use the Latch [access control system](https://docs.seam.co/latest/capability-guides/access-systems) (ACS) to control access across their properties. Latch enables them to manage who has access to which spaces and when, view access history, and set up and manage multiple users and guests. +Seam integrates seamlessly with the [Latch](https://www.latch.com/) management platform. Property managers and owners use the Latch [access control system](https://docs.seam.co/latest/low-level-apis/access-systems) (ACS) to control access across their properties. Latch enables them to manage who has access to which spaces and when, view access history, and set up and manage multiple users and guests. The Seam integration for Latch enables you to automate the creation of residents and the issuing of credentials to these residents. Within these credentials, you specify the entrances to which the residents have access and the access schedules. @@ -16,7 +16,7 @@ Latch enables you to install wireless door locks and intercom systems in your bu ## Latch ACS Resources -The Seam ACS schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Latch ACS in a logical, efficient manner. Latch is a [credential-based ACS](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-access-control-systems), so you [create ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management#create-an-acs-user) and then grant them access permissions using credentials. When you create a credential, you specify the ACS user to which to assign the credential, as well as the allowed entrances and the start and end times for the access schedule. +The Seam ACS schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Latch ACS in a logical, efficient manner. Latch is a [credential-based ACS](https://docs.seam.co/latest/low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-access-control-systems), so you [create ACS users](https://docs.seam.co/latest/low-level-apis/access-systems/user-management#create-an-acs-user) and then grant them access permissions using credentials. When you create a credential, you specify the ACS user to which to assign the credential, as well as the allowed entrances and the start and end times for the access schedule. The following diagram shows the Seam resources for a Latch ACS and the relationships between these resources: @@ -28,8 +28,8 @@ For more information about managing your Latch ACS through Seam, see the followi * [Programming Code-Based Latch Credentials](programming-code-based-latch-credentials.md) * [Programming Latch ACS Mobile Credentials](programming-latch-acs-mobile-credentials.md) -* [Credential-based ACS](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-acs) -* [Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Credential-based ACS](https://docs.seam.co/latest/low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-acs) +* [Access Control Systems](https://docs.seam.co/latest/low-level-apis/access-systems) * [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access) *** @@ -44,7 +44,7 @@ This integration supports all wireless locks and readers connected to the Latch We support the following features: -* [Managing access systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Managing access systems](https://docs.seam.co/latest/low-level-apis/access-systems) * [Issuing mobile access credentials](https://docs.seam.co/latest/capability-guides/mobile-access) *** @@ -66,7 +66,7 @@ Note the following restrictions on using Seam to manage your Latch ACS: ## Troubleshooting -For information about Latch ACS-related errors, including issues related to the connection between your ACS and Seam, see [Troubleshooting Your ACS](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system). +For information about Latch ACS-related errors, including issues related to the connection between your ACS and Seam, see [Troubleshooting Your ACS](https://docs.seam.co/latest/low-level-apis/access-systems/troubleshooting-your-access-control-system). *** diff --git a/docs/brand-guides/latch-access-control-system/programming-code-based-latch-credentials.md b/docs/brand-guides/latch-access-control-system/programming-code-based-latch-credentials.md index c1853b4f1..a88bda598 100644 --- a/docs/brand-guides/latch-access-control-system/programming-code-based-latch-credentials.md +++ b/docs/brand-guides/latch-access-control-system/programming-code-based-latch-credentials.md @@ -16,10 +16,10 @@ Alternately, you can update entrances manually using the [Latch Manager App](htt To use the Seam API to program codes for users in a [Latch ACS](./): -1. Create an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +1. Create an [ACS user](https://docs.seam.co/latest/low-level-apis/access-systems/user-management). * Specify the `acs_system_id` of the Latch ACS in the building to which you want to grant the new user access. * Specify the details of the new ACS user, such as their `full_name`, `email_address`, and so on. -2. Create an [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). +2. Create an [ACS credential](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials). * Specify the `acs_user_id` of the user that you just created. * Specify the ID of the entrance to which you want to grant access.\ @@ -397,10 +397,10 @@ foreach (AcsEntrance entrance in entrances) To learn more about using the Seam API with your Latch ACS, see the following topics: * [Programming Latch ACS Mobile Keys for App Users](programming-latch-acs-mobile-credentials.md) -* [Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems) -* [Credential-based ACS](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-acs) -* [Managing ACS Users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) -* [Managing Credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) +* [Access Control Systems](https://docs.seam.co/latest/low-level-apis/access-systems) +* [Credential-based ACS](https://docs.seam.co/latest/low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-acs) +* [Managing ACS Users](https://docs.seam.co/latest/low-level-apis/access-systems/user-management) +* [Managing Credentials](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials) * [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access) * [Access Control Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference * [User Identities](https://docs.seam.co/latest/api/user_identities/) in the Seam API reference diff --git a/docs/brand-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md b/docs/brand-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md index 99c9d2dc7..6675d3165 100644 --- a/docs/brand-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md +++ b/docs/brand-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md @@ -11,12 +11,12 @@ To use the Seam API to create mobile credentials for mobile app users in a Latch 1. Create a [user identity](https://docs.seam.co/latest/api/user_identities/) that corresponds to your user's app account. Seam [user identities](https://docs.seam.co/latest/api/user_identities/) enable you to match your own mobile app users to ACS users that you create using the Seam API. -2. Create an [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) on the Latch access system or assign an existing access system user to the user identity.\ +2. Create an [access system user](https://docs.seam.co/latest/low-level-apis/access-systems/user-management) on the Latch access system or assign an existing access system user to the user identity.\ The resources that you create for the access system user are available under the associated user identity. * In the access system user creation command, set the `user_identity_id` property for a new access system user. Alternately, use the `add_acs_user` command for user identities to assign an existing access system user to a user identity. * If you choose to create a new access system user, specify the `acs_system_id` of the Latch access system in the building to which you want to grant the new user access. * Specify the details of the access system user, such as their `full_name`, `email_address`, and so on. -3. Create a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to represent the mobile key. +3. Create a [credential](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials) to represent the mobile key. * Specify the `acs_user_id`. * Set [`is_multi_phone_sync_credential`](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials) to `true`. @@ -466,10 +466,10 @@ seam.CredentialsAcs.ListAccessibleEntrances( To learn more about using the Seam API with your Latch ACS, see the following topics: * [Programming PIN Codes for Latch ACS Users](programming-code-based-latch-credentials.md) -* [Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems) -* [Credential-based ACS](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-acs) -* [Managing ACS Users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) -* [Managing Credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) +* [Access Control Systems](https://docs.seam.co/latest/low-level-apis/access-systems) +* [Credential-based ACS](https://docs.seam.co/latest/low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-acs) +* [Managing ACS Users](https://docs.seam.co/latest/low-level-apis/access-systems/user-management) +* [Managing Credentials](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials) * [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access) * [Access Control Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference * [User Identities](https://docs.seam.co/latest/api/user_identities/) in the Seam API reference diff --git a/docs/brand-guides/lockly-locks/creating-lockly-offline-access-codes.md b/docs/brand-guides/lockly-locks/creating-lockly-offline-access-codes.md index 1d5e033c3..c2b36eb01 100644 --- a/docs/brand-guides/lockly-locks/creating-lockly-offline-access-codes.md +++ b/docs/brand-guides/lockly-locks/creating-lockly-offline-access-codes.md @@ -6,20 +6,20 @@ description: >- # Creating Lockly Offline Access Codes -In addition to supporting [online access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), the Seam integration for Lockly supports the generation of offline access codes for all Lockly lock models that have a keypad. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. +In addition to supporting [online access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes), the Seam integration for Lockly supports the generation of offline access codes for all Lockly lock models that have a keypad. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. -For Lockly locks with keypads, you can program [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes) and [one-time-use](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-one-time-use-offline-access-codes) offline access codes. To define the validity period for each Lockly offline access code, specify the desired `starts_at` and `ends_at` timestamp. You can create as many offline access codes as you'd like, up to the limits of your device memory capacity and your Lockly subscription. You can verify your Lockly subscription in the [Lockly Access Portal](https://lap.lockly.com/lap/index.html#/login). +For Lockly locks with keypads, you can program [time-bound](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes) and [one-time-use](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes#creating-one-time-use-offline-access-codes) offline access codes. To define the validity period for each Lockly offline access code, specify the desired `starts_at` and `ends_at` timestamp. You can create as many offline access codes as you'd like, up to the limits of your device memory capacity and your Lockly subscription. You can verify your Lockly subscription in the [Lockly Access Portal](https://lap.lockly.com/lap/index.html#/login). {% hint style="info" %} It is important to inform your Lockly lock users that the mechanism for entering offline access codes on Lockly devices is different from the mechanism for entering online access codes on these devices. For instructions, see [https://www.support.lockly.com/faq/how-to-use-oac/](https://www.support.lockly.com/faq/how-to-use-oac/). {% endhint %} -For more information about using offline access codes, see [Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes) and [Managing Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). +For more information about using offline access codes, see [Offline Access Codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes#offline-access-codes) and [Managing Offline Access Codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes). *** ## Programming Lockly Offline Access Codes -For detailed instructions for creating time-bound offline access codes for Lockly locks, see [Creating Time-Bound Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes). +For detailed instructions for creating time-bound offline access codes for Lockly locks, see [Creating Time-Bound Offline Access Codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes#creating-time-bound-offline-access-codes). -For detailed instructions for creating one-time-use offline access codes for Lockly locks, see [Creating One-Time-Use Offline Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes#creating-one-time-use-offline-access-codes). +For detailed instructions for creating one-time-use offline access codes for Lockly locks, see [Creating One-Time-Use Offline Access Codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/offline-access-codes#creating-one-time-use-offline-access-codes). diff --git a/docs/brand-guides/nuki-locks/README.md b/docs/brand-guides/nuki-locks/README.md index a031f1f30..240ca23cf 100644 --- a/docs/brand-guides/nuki-locks/README.md +++ b/docs/brand-guides/nuki-locks/README.md @@ -32,8 +32,8 @@ For detailed information about the Nuki devices that Seam supports, see our [Nuk 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) on locks and openers that have an installed Nuki Keypad +* [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) on locks and openers that have an installed Nuki Keypad {% hint style="info" %} Nuki does not allow the use of zeros in PIN codes. diff --git a/docs/brand-guides/nuki-locks/get-started-with-nuki-locks.md b/docs/brand-guides/nuki-locks/get-started-with-nuki-locks.md index 8421311ae..27d6e5fa3 100644 --- a/docs/brand-guides/nuki-locks/get-started-with-nuki-locks.md +++ b/docs/brand-guides/nuki-locks/get-started-with-nuki-locks.md @@ -342,7 +342,7 @@ $seam->locks->lock_door($lock->device_id); Some Nuki locks also have a keypad paired to them to program access codes. These codes can then be entered to unlock a Nuki lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Nuki lock. You can find out more about Nuki lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Nuki lock. You can find out more about Nuki lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) {% hint style="info" %} Nuki does not let you create a code starting with the digits "12". Codes cannot contain the digit 0. diff --git a/docs/brand-guides/pti-storlogix-cloud/README.md b/docs/brand-guides/pti-storlogix-cloud/README.md index e7f576cff..de4c8c054 100644 --- a/docs/brand-guides/pti-storlogix-cloud/README.md +++ b/docs/brand-guides/pti-storlogix-cloud/README.md @@ -6,7 +6,7 @@ description: Guide for using the PTI Storlogix Cloud with Seam ## Overview -This integration uses [Storlogix Cloud](https://ptisecurity.com/products/storlogixcloudplatform/) to create [users](https://docs.seam.co/latest/capability-guides/access-systems#what-is-a-user), [generate PIN codes](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#create-a-pin-code-based-credential), and [grant users access](https://docs.seam.co/latest/capability-guides/access-systems#what-is-an-access-group) to different access areas within storage rental unit facilities. +This integration uses [Storlogix Cloud](https://ptisecurity.com/products/storlogixcloudplatform/) to create [users](https://docs.seam.co/latest/low-level-apis/access-systems#what-is-a-user), [generate PIN codes](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials#create-a-pin-code-based-credential), and [grant users access](https://docs.seam.co/latest/low-level-apis/access-systems#what-is-an-access-group) to different access areas within storage rental unit facilities. *** @@ -22,12 +22,12 @@ For detailed information about the PTI devices that Seam supports, see our [PTI We support the following features: -* [**User Management**](https://docs.seam.co/latest/capability-guides/access-systems/user-management) +* [**User Management**](https://docs.seam.co/latest/low-level-apis/access-systems/user-management) - You can administer individual [users](https://docs.seam.co/latest/capability-guides/access-systems#what-is-a-user) and add them to [access groups](https://docs.seam.co/latest/capability-guides/access-systems#what-is-an-access-group) as needed. + You can administer individual [users](https://docs.seam.co/latest/low-level-apis/access-systems#what-is-a-user) and add them to [access groups](https://docs.seam.co/latest/low-level-apis/access-systems#what-is-an-access-group) as needed. - To authorize a user, [add the user to a `pti_access_level` access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups). If you wish to document that a user has rented a specific unit, include them in a `pti_unit` access group using the same endpoint. Note that certain access levels mandate a user be part of a `pti_unit` linked to that access area before they can enter those zones. -* [**Manage ACS Credentials**](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) + To authorize a user, [add the user to a `pti_access_level` access group](https://docs.seam.co/latest/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). If you wish to document that a user has rented a specific unit, include them in a `pti_unit` access group using the same endpoint. Note that certain access levels mandate a user be part of a `pti_unit` linked to that access area before they can enter those zones. +* [**Manage ACS Credentials**](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials) You can create PIN code-based and key card-based ACS credentials. Note that you can assign a unique PIN code to each user, thereby facilitating secure site access. @@ -79,9 +79,9 @@ The PIN code value must be an integer in the range 1-4294967296. ## Assigning Access Permissions to Users -For PTI Storlogix Cloud, you must add the [users](https://docs.seam.co/latest/capability-guides/access-systems#what-is-a-user) to `pti_access_level` and `pti_unit` [access groups](https://docs.seam.co/latest/capability-guides/access-systems#what-is-an-access-group) to give them access to their storage unit. +For PTI Storlogix Cloud, you must add the [users](https://docs.seam.co/latest/low-level-apis/access-systems#what-is-a-user) to `pti_access_level` and `pti_unit` [access groups](https://docs.seam.co/latest/low-level-apis/access-systems#what-is-an-access-group) to give them access to their storage unit. -For example, you could assign them to the "Building A - 3/F" access level and give them access to the "A301" unit. For details, see [Assigning Users to Access Groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups). +For example, you could assign them to the "Building A - 3/F" access level and give them access to the "A301" unit. For details, see [Assigning Users to Access Groups](https://docs.seam.co/latest/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). *** diff --git a/docs/brand-guides/salto-ks-access-control-system/README.md b/docs/brand-guides/salto-ks-access-control-system/README.md index 0da77a5d9..f25fed027 100644 --- a/docs/brand-guides/salto-ks-access-control-system/README.md +++ b/docs/brand-guides/salto-ks-access-control-system/README.md @@ -14,7 +14,7 @@ The Seam integration for Salto KS enables you to create ACS users and assign acc ## Salto KS Resources -The Seam ACS schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Salto KS ACS in a logical, efficient manner. Salto KS is an [access group-based ACS](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems), so you [create ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management#create-an-acs-user) and then assign them to access groups to specify the entrances to which these users have access. You can also configure access schedules for ACS users. +The Seam ACS schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Salto KS ACS in a logical, efficient manner. Salto KS is an [access group-based ACS](https://docs.seam.co/latest/low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems), so you [create ACS users](https://docs.seam.co/latest/low-level-apis/access-systems/user-management#create-an-acs-user) and then assign them to access groups to specify the entrances to which these users have access. You can also configure access schedules for ACS users. The following diagram shows the Seam resources for a Salto KS ACS and the relationships between these resources: @@ -26,8 +26,8 @@ For more information about managing your Salto KS ACS through Seam, see the foll * [Programming Salto KS PIN Code Credentials](programming-code-based-salto-ks-credentials.md) * [Programming Salto KS Mobile Credentials](programming-salto-ks-mobile-credentials.md) -* [Access Group-Based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems) -* [Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Access Group-Based Access Control Systems](https://docs.seam.co/latest/low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems) +* [Access Control Systems](https://docs.seam.co/latest/low-level-apis/access-systems) * [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access) *** @@ -42,7 +42,7 @@ This integration supports all Salto locks connected to the Salto KS ACS. We support the following features: -* [Managing access systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Managing access systems](https://docs.seam.co/latest/low-level-apis/access-systems) * [Issuing code-based credentials](programming-code-based-salto-ks-credentials.md) * [Issuing mobile access credentials](https://docs.seam.co/latest/capability-guides/mobile-access) @@ -105,7 +105,7 @@ Unit door locks within a Salto KS access system must first be woken up, and then ## Troubleshooting -For information about Salto KS ACS-related errors, see [Troubleshooting Your ACS](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system). +For information about Salto KS ACS-related errors, see [Troubleshooting Your ACS](https://docs.seam.co/latest/low-level-apis/access-systems/troubleshooting-your-access-control-system). *** diff --git a/docs/brand-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md b/docs/brand-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md index b3b6d48f3..38f589a21 100644 --- a/docs/brand-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md +++ b/docs/brand-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md @@ -6,11 +6,11 @@ description: Learn how to create Salto KS PIN codes. To use the Seam API to program codes for users in a [Salto KS ACS](./): -1. Create an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +1. Create an [ACS user](https://docs.seam.co/latest/low-level-apis/access-systems/user-management). * For Salto KS, you can specify the `access_schedule` for the new ACS user. An `access_schedule` consists of `starts_at` and `ends_at` times. In this case, a Salto KS ACS user appears as "unsubscribed" in the ACS until the `starts_at` time. Once the start time arrives, Seam switches the ACS user to "subscribed," which activates their access. -2. Assign access permissions to the ACS user by assigning them to one or more [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups). +2. Assign access permissions to the ACS user by assigning them to one or more [access groups](https://docs.seam.co/latest/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). * Each access group is preconfigured with specific entrances and schedules. -3. Create an [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). +3. Create an [ACS credential](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials). * Specify the ID of the ACS user. * Set the `access_method` to `code`. @@ -320,10 +320,10 @@ echo json_encode($pin_code, JSON_PRETTY_PRINT); To learn more about using the Seam API with your Salto KS ACS, see the following topics: -* [Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems) -* [Access Group-Based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems) -* [Managing ACS Users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) -* [Managing Credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) +* [Access Control Systems](https://docs.seam.co/latest/low-level-apis/access-systems) +* [Access Group-Based Access Control Systems](https://docs.seam.co/latest/low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems) +* [Managing ACS Users](https://docs.seam.co/latest/low-level-apis/access-systems/user-management) +* [Managing Credentials](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials) * [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access) * [Access Control Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference * [User Identities](https://docs.seam.co/latest/api/user_identities/) in the Seam API reference diff --git a/docs/brand-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md b/docs/brand-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md index e0def1bb5..93e945978 100644 --- a/docs/brand-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md +++ b/docs/brand-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md @@ -11,12 +11,12 @@ To use the Seam API to create mobile credentials for mobile app users in a Salto 1. Create a [user identity](https://docs.seam.co/latest/api/user_identities/). Seam user identities enable you to match your own mobile app users to ACS users that you create using the Seam API. -2. Create an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) on the Salto KS ACS or assign an existing ACS user to the user identity.\ +2. Create an [ACS user](https://docs.seam.co/latest/low-level-apis/access-systems/user-management) on the Salto KS ACS or assign an existing ACS user to the user identity.\ The resources that you create for the ACS user are available under the associated user identity. * For Salto KS, you can specify the `access_schedule` for the ACS user. The `access_schedule` consists of `starts_at` and `ends_at` times. In this case, a Salto KS ACS user appears as "unsubscribed" in the ACS until the `starts_at` time. Once the start time arrives, Seam switches the ACS user to "subscribed," which activates their access. -3. Assign the ACS user to one or more [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups). +3. Assign the ACS user to one or more [access groups](https://docs.seam.co/latest/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). * Each access group is preconfigured with the allowed entrances. -4. Create an [ACS credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to represent the mobile key. +4. Create an [ACS credential](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials) to represent the mobile key. * Specify the ID of the ACS user. * Set [`is_multi_phone_sync_credential`](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials) to `true`. * Set the `access_method` to `mobile_key`. @@ -478,10 +478,10 @@ echo json_encode($reservation_mobile_key, JSON_PRETTY_PRINT); To learn more about using the Seam API with your Salto KS ACS, see the following topics: * [Programming Code-Based Salto KS Credentials](programming-code-based-salto-ks-credentials.md) -* [Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems) -* [Credential-based ACS](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-acs) -* [Managing ACS Users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) -* [Managing Credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) +* [Access Control Systems](https://docs.seam.co/latest/low-level-apis/access-systems) +* [Credential-based ACS](https://docs.seam.co/latest/low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#credential-based-acs) +* [Managing ACS Users](https://docs.seam.co/latest/low-level-apis/access-systems/user-management) +* [Managing Credentials](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials) * [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access) * [Access Control Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference * [User Identities](https://docs.seam.co/latest/api/user_identities/) in the Seam API reference diff --git a/docs/brand-guides/salto-locks/README.md b/docs/brand-guides/salto-locks/README.md index 9dcfb3fa5..7499243a3 100644 --- a/docs/brand-guides/salto-locks/README.md +++ b/docs/brand-guides/salto-locks/README.md @@ -27,7 +27,7 @@ For detailed information about the Salto devices that Seam supports, see our [Sa We support the following features: * [Triggering web unlock actions](https://docs.seam.co/latest/api/locks/unlock_door) -* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on door locks and card readers that have a PIN pad +* [Programming access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) on door locks and card readers that have a PIN pad *** diff --git a/docs/brand-guides/salto-locks/get-started-with-salto-locks.md b/docs/brand-guides/salto-locks/get-started-with-salto-locks.md index d41f24b6a..794389ef4 100644 --- a/docs/brand-guides/salto-locks/get-started-with-salto-locks.md +++ b/docs/brand-guides/salto-locks/get-started-with-salto-locks.md @@ -464,7 +464,7 @@ $seam->locks->lock_door($lock->device_id); Some Salto locks and access points will have a keypad available to program access codes. These codes can then be entered to unlock the door. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on an Salto lock. You can find out more about Salto lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on an Salto lock. You can find out more about Salto lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) {% hint style="info" %} Salto does not let you specify a code for an access code. Instead Salto generates a 6-digit code, which the Seam API returns. diff --git a/docs/brand-guides/salto-proaccess-space-access-system/README.md b/docs/brand-guides/salto-proaccess-space-access-system/README.md index f4ddc2275..c9b806a6b 100644 --- a/docs/brand-guides/salto-proaccess-space-access-system/README.md +++ b/docs/brand-guides/salto-proaccess-space-access-system/README.md @@ -16,7 +16,7 @@ This integration requires [Seam Bridge](https://docs.seam.co/latest/capability-g ## Salto Space Resources -The Seam access system schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Salto Space access system in a logical, efficient manner. Salto Space is an [access group-based access system](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems), so you [create access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management#create-an-acs-user) and then assign them to access groups to specify the entrances to which these users have access. +The Seam access system schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Salto Space access system in a logical, efficient manner. Salto Space is an [access group-based access system](https://docs.seam.co/latest/low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems), so you [create access system users](https://docs.seam.co/latest/low-level-apis/access-systems/user-management#create-an-acs-user) and then assign them to access groups to specify the entrances to which these users have access. The following diagram shows the Seam resources for a Salto Space access system and the relationships between these resources: @@ -28,8 +28,8 @@ For more information about managing your Salto Space access system through Seam, * [Programming Salto Space Card-based Credentials](programming-salto-space-card-based-credentials.md) * [Programming Salto Space Mobile Credentials](programming-salto-space-mobile-credentials.md) -* [Access Group-Based Access Systems](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems) -* [Access Systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Access Group-Based Access Systems](https://docs.seam.co/latest/low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems) +* [Access Systems](https://docs.seam.co/latest/low-level-apis/access-systems) * [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access) *** @@ -44,7 +44,7 @@ This integration supports all Salto locks connected to the Salto Space ACS. We support the following features: -* [Managing access systems](https://docs.seam.co/latest/capability-guides/access-systems) +* [Managing access systems](https://docs.seam.co/latest/low-level-apis/access-systems) * [Issuing card-based credentials](programming-salto-space-card-based-credentials.md) * [Issuing mobile access credentials](https://docs.seam.co/latest/capability-guides/mobile-access) @@ -81,7 +81,7 @@ To enable or disable far opening: ## Troubleshooting -For information about Salto Space access system-related errors, see [Troubleshooting Your Access System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system). +For information about Salto Space access system-related errors, see [Troubleshooting Your Access System](https://docs.seam.co/latest/low-level-apis/access-systems/troubleshooting-your-access-control-system). *** diff --git a/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md b/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md index d70d73757..5f9c46c57 100644 --- a/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md +++ b/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md @@ -8,10 +8,10 @@ For each access system user in a [Salto Space access system](./), you can create To use the Seam API to create card credentials for a Salto Space access system: -1. Create an [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -2. Assign access permissions to the user by assigning them to one or more [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups). +1. Create an [access system user](https://docs.seam.co/latest/low-level-apis/access-systems/user-management). +2. Assign access permissions to the user by assigning them to one or more [access groups](https://docs.seam.co/latest/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). * Each access group is preconfigured with specific entrances. -3. Create a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). +3. Create a [credential](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials). * Specify the ID of the access system user. * Set the `access_method` to `card`. * Choose whether to assign a new card to the user or update the user's existing card. Use the Boolean `salto_space_metadata.assign_new_key` parameter when creating the credential. @@ -26,11 +26,11 @@ To use the Seam API to create card credentials for a Salto Space access system: \{% hint style="info" %\} Make sure that each of your Salto Space sites is equipped with a supported card encoder. The [NCoder card encoder](https://saltosystems.com/en-us/products/ncoder/) is compatible with the Seam integration. \{% endhint %\} 1. Use the `/acs/encoders/list` endpoint to retrieve a list of available encoders. Then, choose the encoder that you want to use to write the credential to the card.\ - See [Retrieve Encoders](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-2.-retrieve-encoders). + See [Retrieve Encoders](https://docs.seam.co/latest/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-2.-retrieve-encoders). 2. Use the `/acs/encoders/encode_credential` endpoint to encode the credential onto the card, using the encoder that you have chosen.\ - See [Encode the Card](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-3.-encode-the-card). + See [Encode the Card](https://docs.seam.co/latest/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-3.-encode-the-card). 3. Confirm that the card was encoded successfully using polling or a [webhook](https://docs.seam.co/latest/developer-tools/webhooks).\ - See [Confirm Successful Encoding](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-4.-confirm-successful-encoding). Also, see a list of [common encoding errors](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#common-encoding-errors). + See [Confirm Successful Encoding](https://docs.seam.co/latest/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#id-4.-confirm-successful-encoding). Also, see a list of [common encoding errors](https://docs.seam.co/latest/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials#common-encoding-errors). The following example walks you through this process: @@ -548,7 +548,7 @@ $seam->action_attempts->get( ## Next Steps -You can use an encoder to scan a plastic key card to read its encoded parameters. The scan result includes the card's properties, such as its card number, serial number, and other useful details. For more information, see [Scanning Encoded Cards](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards). +You can use an encoder to scan a plastic key card to read its encoded parameters. The scan result includes the card's properties, such as its card number, serial number, and other useful details. For more information, see [Scanning Encoded Cards](https://docs.seam.co/latest/low-level-apis/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards). *** @@ -556,9 +556,9 @@ You can use an encoder to scan a plastic key card to read its encoded parameters To find out more about using the Seam API with your Salto Space access system, see the following topics: -* [Access Systems](https://docs.seam.co/latest/capability-guides/access-systems) -* [Access Group-Based Access Systems](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems) -* [Managing Access System Users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) -* [Managing Credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) -* [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) +* [Access Systems](https://docs.seam.co/latest/low-level-apis/access-systems) +* [Access Group-Based Access Systems](https://docs.seam.co/latest/low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems) +* [Managing Access System Users](https://docs.seam.co/latest/low-level-apis/access-systems/user-management) +* [Managing Credentials](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials) +* [Working with Card Encoders and Scanners](https://docs.seam.co/latest/low-level-apis/access-systems/working-with-card-encoders-and-scanners) * [Access Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference diff --git a/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md b/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md index b23e7fea2..1df800956 100644 --- a/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md +++ b/docs/brand-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md @@ -11,11 +11,11 @@ To use the Seam API to create mobile credentials for mobile app users in a Salto 1. Create a [user identity](https://docs.seam.co/latest/api/user_identities/). Seam user identities enable you to match your own mobile app users to access system users that you create using the Seam API. -2. Create an [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) on the Salto Space access system or assign an existing access system user to the user identity.\ +2. Create an [access system user](https://docs.seam.co/latest/low-level-apis/access-systems/user-management) on the Salto Space access system or assign an existing access system user to the user identity.\ The resources that you create for the access system user are available under the associated user identity. -3. Assign the access system user to one or more [access groups](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups). +3. Assign the access system user to one or more [access groups](https://docs.seam.co/latest/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). * Each access group is preconfigured with the allowed entrances. -4. Create a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to represent the mobile key. +4. Create a [credential](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials) to represent the mobile key. * Specify the ID of the access system user. * Set [`is_multi_phone_sync_credential`](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials) to `true`. * Set the `access_method` to `mobile_key`. @@ -365,10 +365,10 @@ $mobile_key = $seam->acs->credentials->create( To find out more about using the Seam API with your Salto Space access system, see the following topics: * [Programming Salto Space Card-based Credentials](programming-salto-space-card-based-credentials.md) -* [Access Systems](https://docs.seam.co/latest/capability-guides/access-systems) -* [Access Group-Based Access Systems](https://docs.seam.co/latest/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems) -* [Managing Access System Users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) -* [Managing Credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) +* [Access Systems](https://docs.seam.co/latest/low-level-apis/access-systems) +* [Access Group-Based Access Systems](https://docs.seam.co/latest/low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences#access-group-based-access-control-systems) +* [Managing Access System Users](https://docs.seam.co/latest/low-level-apis/access-systems/user-management) +* [Managing Credentials](https://docs.seam.co/latest/low-level-apis/access-systems/managing-credentials) * [Mobile Access](https://docs.seam.co/latest/capability-guides/mobile-access) * [Access Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference * [User Identities](https://docs.seam.co/latest/api/user_identities/) in the Seam API reference diff --git a/docs/brand-guides/schlage-locks/README.md b/docs/brand-guides/schlage-locks/README.md index 77167718d..b4158fc4a 100644 --- a/docs/brand-guides/schlage-locks/README.md +++ b/docs/brand-guides/schlage-locks/README.md @@ -26,8 +26,8 @@ For detailed information about the Schlage 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 online access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on locks that have a connected keypad +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/low-level-apis/smart-locks/lock-and-unlock) +* [Programming online access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) on locks that have a connected keypad *** diff --git a/docs/brand-guides/schlage-locks/get-started-with-schlage-locks.md b/docs/brand-guides/schlage-locks/get-started-with-schlage-locks.md index 36b382eb6..892503881 100644 --- a/docs/brand-guides/schlage-locks/get-started-with-schlage-locks.md +++ b/docs/brand-guides/schlage-locks/get-started-with-schlage-locks.md @@ -258,7 +258,7 @@ puts updated_lock.properties.locked # false All Schlage wifi locks come with a keypad built-in to program access codes. These codes can then be entered to unlock a Schlage lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Schlage lock. You can find out more about Schlage lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Schlage lock. You can find out more about Schlage lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) {% tabs %} {% tab title="JavaScript" %} diff --git a/docs/brand-guides/sensi-thermostats/get-started-with-sensi-thermostats.md b/docs/brand-guides/sensi-thermostats/get-started-with-sensi-thermostats.md index 78b193544..fb2852aaa 100644 --- a/docs/brand-guides/sensi-thermostats/get-started-with-sensi-thermostats.md +++ b/docs/brand-guides/sensi-thermostats/get-started-with-sensi-thermostats.md @@ -1846,7 +1846,7 @@ Now that you've completed this getting started guide for Sensi devices, you can * [ ] **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 [smart locks](https://docs.seam.co/latest/capability-guides/smart-locks), [access control systems](https://docs.seam.co/latest/capability-guides/access-systems), 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 [smart locks](https://docs.seam.co/latest/low-level-apis/smart-locks), [access control systems](https://docs.seam.co/latest/low-level-apis/access-systems), 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). diff --git a/docs/brand-guides/smartthings-hubs-+-devices/README.md b/docs/brand-guides/smartthings-hubs-+-devices/README.md index 38ea9a647..67a77f0f5 100644 --- a/docs/brand-guides/smartthings-hubs-+-devices/README.md +++ b/docs/brand-guides/smartthings-hubs-+-devices/README.md @@ -22,8 +22,8 @@ For detailed information about the SmartThings devices that Seam supports, see o We support the following features: -* [Triggering web lock and unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock) on smart locks -* [Programming online access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on smart locks that have a connected keypad +* [Triggering web lock and unlock actions](https://docs.seam.co/latest/low-level-apis/smart-locks/lock-and-unlock) on smart locks +* [Programming online access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) on smart locks that have a connected keypad * [Configuring current thermostat settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) on thermostats * [Creating and managing climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on thermostats * [Creating and managing thermostat schedules](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) on thermostats diff --git a/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md b/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md index e308416d9..ec131159f 100644 --- a/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md +++ b/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md @@ -697,7 +697,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 SmartThings-connected lock: @@ -1013,9 +1013,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 SmartThings-connected locks that have an integrated or accessory 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 SmartThings-connected locks that have an integrated or accessory 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" %} @@ -1403,7 +1403,7 @@ Now that you've completed this getting started guide for SmartThings-connected d * [ ] **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). diff --git a/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md b/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md index 2da6b77a5..373b0a219 100644 --- a/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md +++ b/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md @@ -1856,7 +1856,7 @@ Now that you've completed this getting started guide for SmartThings-connected d * [ ] **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 [smart locks](https://docs.seam.co/latest/capability-guides/smart-locks), [access control systems](https://docs.seam.co/latest/capability-guides/access-systems), 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 [smart locks](https://docs.seam.co/latest/low-level-apis/smart-locks), [access control systems](https://docs.seam.co/latest/low-level-apis/access-systems), 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). diff --git a/docs/brand-guides/tedee-locks/README.md b/docs/brand-guides/tedee-locks/README.md index 3769324de..90c272e88 100644 --- a/docs/brand-guides/tedee-locks/README.md +++ b/docs/brand-guides/tedee-locks/README.md @@ -26,8 +26,8 @@ For detailed information about the Tedee devices that Seam supports, see our [Te 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) on locks and openers that have an installed Tedee keypad +* [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) on locks and openers that have an installed Tedee keypad *** diff --git a/docs/brand-guides/tedee-locks/get-started-with-tedee-locks.md b/docs/brand-guides/tedee-locks/get-started-with-tedee-locks.md index 5fcbad938..082daef3f 100644 --- a/docs/brand-guides/tedee-locks/get-started-with-tedee-locks.md +++ b/docs/brand-guides/tedee-locks/get-started-with-tedee-locks.md @@ -369,7 +369,7 @@ $seam->locks->lock_door($lock->device_id); Some Tedee locks also have a keypad paired to them to program access codes. These codes can then be entered to unlock a Tedee lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Tedee lock. You can find out more about Tedee lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Tedee lock. You can find out more about Tedee lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) {% hint style="info" %} For Tedee-specific access code restrictions, see [Access (PIN) Code Requirements](./#access-pin-code-requirements). diff --git a/docs/brand-guides/ttlock-locks/README.md b/docs/brand-guides/ttlock-locks/README.md index f0aa571d9..5f4423a2a 100644 --- a/docs/brand-guides/ttlock-locks/README.md +++ b/docs/brand-guides/ttlock-locks/README.md @@ -18,8 +18,8 @@ For detailed information about the TTLock devices that Seam supports, see our [T 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) on door locks and card readers that have a PIN pad +* [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) on door locks and card readers that have a PIN pad *** diff --git a/docs/brand-guides/ttlock-locks/get-started-with-ttlock-devices.md b/docs/brand-guides/ttlock-locks/get-started-with-ttlock-devices.md index ec04a0843..694710a72 100644 --- a/docs/brand-guides/ttlock-locks/get-started-with-ttlock-devices.md +++ b/docs/brand-guides/ttlock-locks/get-started-with-ttlock-devices.md @@ -695,7 +695,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 TTLock lock: @@ -1012,9 +1012,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 TTLock locks that have an integrated or accessory 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 TTLock locks that have an integrated or accessory 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" %} @@ -1402,7 +1402,7 @@ Now that you've completed this getting started guide for TTLock devices, you can * [ ] **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). diff --git a/docs/brand-guides/ultraloq-locks/configuring-ultraloq-device-timezones.md b/docs/brand-guides/ultraloq-locks/configuring-ultraloq-device-timezones.md index efe663e1b..050994123 100644 --- a/docs/brand-guides/ultraloq-locks/configuring-ultraloq-device-timezones.md +++ b/docs/brand-guides/ultraloq-locks/configuring-ultraloq-device-timezones.md @@ -1232,6 +1232,6 @@ Now that you understand timezone configuration, you can: * **Create time-bound access codes:** See [Creating Ultraloq Access Codes](creating-ultraloq-access-codes.md) * **Review the setup guide:** See [Ultraloq Setup Guide](ultraloq-setup-guide.md) -* **Learn about access code constraints:** See [Understanding Code Constraints](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints) +* **Learn about access code constraints:** See [Understanding Code Constraints](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/creating-access-codes/understanding-code-constraints) *** diff --git a/docs/brand-guides/ultraloq-locks/creating-ultraloq-access-codes.md b/docs/brand-guides/ultraloq-locks/creating-ultraloq-access-codes.md index 2e5b4cb79..7b4708fcf 100644 --- a/docs/brand-guides/ultraloq-locks/creating-ultraloq-access-codes.md +++ b/docs/brand-guides/ultraloq-locks/creating-ultraloq-access-codes.md @@ -873,7 +873,7 @@ For complete API documentation, see: ## Next Steps * **Learn about timezone configuration:** See [Configuring Ultraloq Device Timezones](configuring-ultraloq-device-timezones.md) -* **Understand code constraints:** See [Understanding Code Constraints](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints) +* **Understand code constraints:** See [Understanding Code Constraints](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes/creating-access-codes/understanding-code-constraints) * **Review the setup guide:** See [Ultraloq Setup Guide](ultraloq-setup-guide.md) * **Explore access code webhooks:** See [Webhooks](https://docs.seam.co/latest/developer-tools/webhooks) diff --git a/docs/brand-guides/ultraloq-locks/ultraloq-setup-guide.md b/docs/brand-guides/ultraloq-locks/ultraloq-setup-guide.md index b4eede7ad..b3683bea6 100644 --- a/docs/brand-guides/ultraloq-locks/ultraloq-setup-guide.md +++ b/docs/brand-guides/ultraloq-locks/ultraloq-setup-guide.md @@ -1499,8 +1499,8 @@ if (!device.getWarnings().isEmpty()) { * **[Creating Ultraloq Access Codes](creating-ultraloq-access-codes.md)** - Detailed guide on permanent and time-bound access codes * **[Configuring Ultraloq Device Timezones](configuring-ultraloq-device-timezones.md)** - Complete timezone configuration reference -* **[Lock and Unlock Operations](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock)** - General smart lock control documentation -* **[Access Codes Overview](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)** - Understanding access code management +* **[Lock and Unlock Operations](https://docs.seam.co/latest/low-level-apis/smart-locks/lock-and-unlock)** - General smart lock control documentation +* **[Access Codes Overview](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes)** - Understanding access code management *** diff --git a/docs/brand-guides/wyze-locks/README.md b/docs/brand-guides/wyze-locks/README.md index 553be3849..378482829 100644 --- a/docs/brand-guides/wyze-locks/README.md +++ b/docs/brand-guides/wyze-locks/README.md @@ -28,8 +28,8 @@ For detailed information about the Wyze devices that Seam supports, see our [Wyz 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) on locks that have an installed Wyze Lock Keypad +* [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) on locks that have an installed Wyze Lock Keypad {% hint style="info" %} The Seam platform cannot determine the PIN codes for access codes that were created outside of the Seam platform. diff --git a/docs/brand-guides/wyze-locks/get-started-with-wyze-locks.md b/docs/brand-guides/wyze-locks/get-started-with-wyze-locks.md index b5327af2c..08505c5b3 100644 --- a/docs/brand-guides/wyze-locks/get-started-with-wyze-locks.md +++ b/docs/brand-guides/wyze-locks/get-started-with-wyze-locks.md @@ -330,7 +330,7 @@ $seam->locks->lock_door($lock->device_id); ## 5 — Programming Access Code on a Wyze Lock -The Seam API lets you create access codes on Wyze locks with a gateway. These codes can then be entered to unlock the door. You can find out more info about how Seam access codes in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) +The Seam API lets you create access codes on Wyze locks with a gateway. These codes can then be entered to unlock the door. You can find out more info about how Seam access codes in our [core concept section on access codes.](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) {% hint style="info" %} Wyze does not allow pin code values to be seen after the code is created. If you create a code through Seam, avoid changing the pin code through the app and instead use Seam to change any information about the code! diff --git a/docs/brand-guides/yale-locks/README.md b/docs/brand-guides/yale-locks/README.md index 3a907a5c2..25ad271d3 100644 --- a/docs/brand-guides/yale-locks/README.md +++ b/docs/brand-guides/yale-locks/README.md @@ -37,7 +37,7 @@ For detailed information about the Yale devices that Seam supports, see our [Yal We support the following features: * [Triggering web unlock actions](https://docs.seam.co/latest/api/locks/unlock_door) -* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on door locks that have a keypad +* [Programming access codes](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) on door locks that have a keypad *** diff --git a/docs/brand-guides/yale-locks/get-started-with-yale-locks.md b/docs/brand-guides/yale-locks/get-started-with-yale-locks.md index f866e96cd..c9c340b6f 100644 --- a/docs/brand-guides/yale-locks/get-started-with-yale-locks.md +++ b/docs/brand-guides/yale-locks/get-started-with-yale-locks.md @@ -312,7 +312,7 @@ puts updated_lock.properties.locked # false Most Yale locks come with a keypad built-in to program access codes. These codes can then be entered to unlock a Yale lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Yale lock. You can find out more about Yale lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Yale lock. You can find out more about Yale lock access code in our [core concept section on access codes.](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) {% tabs %} {% tab title="JavaScript" %} diff --git a/docs/guides/README.md b/docs/guides/README.md index f72a4f0de..3f9ecf19b 100644 --- a/docs/guides/README.md +++ b/docs/guides/README.md @@ -10,10 +10,6 @@ Connect your IoT devices and systems using Seam! From smart locks and thermostat Grant access. Unlock doors. Set temperatures. Monitor noise. Get started with Seam! -{% 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 %} - {% 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 %} @@ -34,7 +30,7 @@ With the Seam API, you can grant users access to entrances controlled by a varie Explore our device API guides to start connecting and controlling specific device and system categories. -
Grant AccessGrant access to any space with Access Grants →access-grant-using-spaces.pnguse-cases/granting-access/README.md
Door Locks APIGet started →smart-locks-16-9.pngsmart-locks
Thermostats APIGet started →thermostats-cover.pngthermostats
Noise Sensors APIGet started →sensors-16-9.pngnoise-sensors
Access Control Systems APIGet started →acs-cover.pngaccess-systems
+
Grant AccessGrant access to any space with Access Grants →access-grant-using-spaces.pnguse-cases/granting-access/README.md
Door Locks APIGet started →smart-locks-16-9.pngsmart-locks
Thermostats APIGet started →thermostats-cover.pngthermostats
Noise Sensors APIGet started →sensors-16-9.pngnoise-sensors
Access Control Systems APIGet started →acs-cover.pngaccess-systems
*** diff --git a/docs/guides/SUMMARY.md b/docs/guides/SUMMARY.md index 0dfa693dc..6752aa1e8 100644 --- a/docs/guides/SUMMARY.md +++ b/docs/guides/SUMMARY.md @@ -57,44 +57,6 @@ ## Capability Guides * [Device and System Capabilities](capability-guides/device-and-system-capabilities.md) -* [Smart Locks](capability-guides/smart-locks/README.md) - * [Get started with Smart Locks](capability-guides/smart-locks/get-started-with-smartlocks-api.md) - * [Locking and Unlocking Smart Locks](capability-guides/smart-locks/lock-and-unlock.md) - * [Creating and Managing Smart Lock Access Codes](capability-guides/smart-locks/access-codes/README.md) - * [Creating Access Codes](capability-guides/smart-locks/access-codes/creating-access-codes/README.md) - * [Understanding Code Constraints](capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md) - * [Retrieving Access Codes](capability-guides/smart-locks/access-codes/retrieving-access-codes.md) - * [Modifying Access Codes](capability-guides/smart-locks/access-codes/modifying-access-codes.md) - * [Deleting Access Codes](capability-guides/smart-locks/access-codes/deleting-access-codes.md) - * [Lifecycle of Access Codes](capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md) - * [Access Code Requirements for Door Locks](capability-guides/smart-locks/access-codes/access-code-requirements-for-door-locks.md) - * [Streamlining Access Code Management from the Manufacturer App](capability-guides/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md) - * [Troubleshooting Access Codes](capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues.md) - * [Managing Backup Access Codes](capability-guides/smart-locks/access-codes/backup-access-codes.md) - * [Managing Offline Access Codes](capability-guides/smart-locks/access-codes/offline-access-codes.md) - * [Creating and Updating Multiple Linked Access Codes](capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md) - * [Migrating Existing Unmanaged Access Codes](capability-guides/smart-locks/access-codes/migrating-existing-access-codes.md) -* [Access Control Systems](capability-guides/access-systems/README.md) - * [Access System Quick Starts](capability-guides/access-systems/acs-quick-starts/README.md) - * [PIN Code Quick Start](capability-guides/access-systems/acs-quick-starts/pin-code-quick-start.md) - * [Encodable Key Card Quick Start](capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start.md) - * [Mobile Key Quick Start](capability-guides/access-systems/acs-quick-starts/mobile-key-quick-start.md) - * [Connect an Access System to Seam](capability-guides/access-systems/connect-an-acs-to-seam/README.md) - * [Retrieving ACS System Details](capability-guides/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md) - * [Access Control System Resources](capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md) - * [Understanding Access Control System Differences](capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md) - * [Managing ACS Users](capability-guides/access-systems/user-management.md) - * [Suspending and Unsuspending ACS Users](capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md) - * [Assigning ACS Users to Access Groups](capability-guides/access-systems/user-management/assigning-users-to-access-groups.md) - * [Retrieving Entrance Details](capability-guides/access-systems/retrieving-entrance-details.md) - * [Managing Credentials](capability-guides/access-systems/managing-credentials.md) - * [Assigning Credentials to ACS Users](capability-guides/access-systems/managing-credentials/assigning-credentials-to-users.md) - * [Listing Credentials and Associated Entrances](capability-guides/access-systems/managing-credentials/listing-credentials-and-associated-entrances.md) - * [Working with Card Encoders and Scanners](capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) - * [Creating and Encoding Card-based Credentials](capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md) - * [Creating and Encoding Card Access Methods](capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md) - * [Scanning Encoded Cards](capability-guides/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards.md) - * [Troubleshooting Your Access Control System](capability-guides/access-systems/troubleshooting-your-access-control-system.md) * [Mobile Access](capability-guides/mobile-access/README.md) * [Prepare your Workspace](capability-guides/mobile-access/mobile-access-setup.md) * [Managing Mobile App User Accounts with User Identities](capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md) @@ -195,3 +157,44 @@ * [Creating Intercom CRUD Endpoints](device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-intercom-crud-endpoints.md) * [Creating Access Code CRUD Endpoints](device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-access-code-crud-endpoints.md) * [Creating the Health Endpoint](device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-the-health-endpoint.md) + +## Low-Level APIs + +* [Smart Locks](low-level-apis/smart-locks/README.md) + * [Get started with Smart Locks](low-level-apis/smart-locks/get-started-with-smartlocks-api.md) + * [Locking and Unlocking Smart Locks](low-level-apis/smart-locks/lock-and-unlock.md) + * [Creating and Managing Smart Lock Access Codes](low-level-apis/smart-locks/access-codes/README.md) + * [Creating Access Codes](low-level-apis/smart-locks/access-codes/creating-access-codes/README.md) + * [Understanding Code Constraints](low-level-apis/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md) + * [Retrieving Access Codes](low-level-apis/smart-locks/access-codes/retrieving-access-codes.md) + * [Modifying Access Codes](low-level-apis/smart-locks/access-codes/modifying-access-codes.md) + * [Deleting Access Codes](low-level-apis/smart-locks/access-codes/deleting-access-codes.md) + * [Lifecycle of Access Codes](low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes.md) + * [Access Code Requirements for Door Locks](low-level-apis/smart-locks/access-codes/access-code-requirements-for-door-locks.md) + * [Streamlining Access Code Management from the Manufacturer App](low-level-apis/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md) + * [Troubleshooting Access Codes](low-level-apis/smart-locks/access-codes/troubleshooting-access-code-issues.md) + * [Managing Backup Access Codes](low-level-apis/smart-locks/access-codes/backup-access-codes.md) + * [Managing Offline Access Codes](low-level-apis/smart-locks/access-codes/offline-access-codes.md) + * [Creating and Updating Multiple Linked Access Codes](low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md) + * [Migrating Existing Unmanaged Access Codes](low-level-apis/smart-locks/access-codes/migrating-existing-access-codes.md) +* [Access Control Systems](low-level-apis/access-systems/README.md) + * [Access System Quick Starts](low-level-apis/access-systems/acs-quick-starts/README.md) + * [PIN Code Quick Start](low-level-apis/access-systems/acs-quick-starts/pin-code-quick-start.md) + * [Encodable Key Card Quick Start](low-level-apis/access-systems/acs-quick-starts/encodable-key-card-quick-start.md) + * [Mobile Key Quick Start](low-level-apis/access-systems/acs-quick-starts/mobile-key-quick-start.md) + * [Connect an Access System to Seam](low-level-apis/access-systems/connect-an-acs-to-seam/README.md) + * [Retrieving ACS System Details](low-level-apis/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md) + * [Access Control System Resources](low-level-apis/access-systems/connect-an-acs-to-seam/access-control-system-resources.md) + * [Understanding Access Control System Differences](low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md) + * [Managing ACS Users](low-level-apis/access-systems/user-management.md) + * [Suspending and Unsuspending ACS Users](low-level-apis/access-systems/user-management/suspending-and-unsuspending-users.md) + * [Assigning ACS Users to Access Groups](low-level-apis/access-systems/user-management/assigning-users-to-access-groups.md) + * [Retrieving Entrance Details](low-level-apis/access-systems/retrieving-entrance-details.md) + * [Managing Credentials](low-level-apis/access-systems/managing-credentials.md) + * [Assigning Credentials to ACS Users](low-level-apis/access-systems/managing-credentials/assigning-credentials-to-users.md) + * [Listing Credentials and Associated Entrances](low-level-apis/access-systems/managing-credentials/listing-credentials-and-associated-entrances.md) + * [Working with Card Encoders and Scanners](low-level-apis/access-systems/working-with-card-encoders-and-scanners/README.md) + * [Creating and Encoding Card-based Credentials](low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md) + * [Creating and Encoding Card Access Methods](low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md) + * [Scanning Encoded Cards](low-level-apis/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards.md) + * [Troubleshooting Your Access Control System](low-level-apis/access-systems/troubleshooting-your-access-control-system.md) diff --git a/docs/guides/capability-guides/device-and-system-capabilities.md b/docs/guides/capability-guides/device-and-system-capabilities.md index f53e43a6d..fe92cb873 100644 --- a/docs/guides/capability-guides/device-and-system-capabilities.md +++ b/docs/guides/capability-guides/device-and-system-capabilities.md @@ -6,7 +6,7 @@ description: Learn about device and system capabilities, as well as capability f
In the Seam API, capability flags inform your application about what features and behaviors each device supports.
-Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For example, some devices support [remote unlock actions](../capability-guides/smart-locks/lock-and-unlock.md), while others support [programming access codes](../capability-guides/smart-locks/access-codes/). Some devices support both of these capabilities. When developing your application, it is imperative to be able to identify the capabilities of each device. +Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For example, some devices support [remote unlock actions](../low-level-apis/smart-locks/lock-and-unlock.md), while others support [programming access codes](../low-level-apis/smart-locks/access-codes/). Some devices support both of these capabilities. When developing your application, it is imperative to be able to identify the capabilities of each device. For example, if a device supports programming online access codes, your app can present the [`CreateAccessCodeForm` Seam Component](../ui-components/overview/react-components/create-access-code-form.md) to your user. On the other hand, if a connected device does not support the remote unlock action, you'll likely want to disable or not display the unlock functionality for your app user. @@ -26,17 +26,17 @@ All capability flags share the following behavior: Reasons why a capability flag might be `false` could include that a required hardware accessory is not connected to the device. For example, if a lock needs a Wi-Fi bridge for connectivity and is currently not connected to a bridge, the lock cannot be remotely unlocked. If a lock is missing an accessory keypad, access codes cannot be programmed on the lock. -With respect to the ability to program online access codes, as long as a lock has the required hardware, Seam assumes that any offline status is temporary and will be resolved before [it's time to set the access code on the device](../capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md). Consequently, in this case, Seam maintains `can_program_online_access_codes` as `true`. +With respect to the ability to program online access codes, as long as a lock has the required hardware, Seam assumes that any offline status is temporary and will be resolved before [it's time to set the access code on the device](../low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes.md). Consequently, in this case, Seam maintains `can_program_online_access_codes` as `true`.
Capability flags help you to understand why a device cannot currently perform an action.

Capability flags help you to understand why a device cannot currently perform an action.

-Seam recommends adding capability checks before performing specific actions in your app. For example, before performing a [remote unlock](../capability-guides/smart-locks/lock-and-unlock.md#unlocking-a-door) operation, you can check to make sure that the target device supports remote unlocking. For details and code samples, see the corresponding capability guides. +Seam recommends adding capability checks before performing specific actions in your app. For example, before performing a [remote unlock](../low-level-apis/smart-locks/lock-and-unlock.md#unlocking-a-door) operation, you can check to make sure that the target device supports remote unlocking. For details and code samples, see the corresponding capability guides. {% hint style="info" %} In addition to viewing the capabilities for a specific device, you can also view the capabilities for a provider using [List Device Providers](https://docs.seam.co/latest/api/devices/list_device_providers). If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`. {% endhint %} -
PropertyTypeDescription
device.can_remotely_unlockBoolean
Optional		Indicates whether the device can perform a remote unlock operation.
device.can_remotely_lockBoolean
Optional		Indicates whether the device can perform a remote lock operation.
device.can_program_online_access_codesBoolean
Optional		Indicates whether the device can program online access codes.
If true, it is currently possible to create new online access codes for the device, and Seam programs the device the next time it's online.
device.can_program_offline_access_codesBoolean
Optional		Indicates whether the device can program offline access codes.
When this flag is true, Seam can generate an offline code for this device, regardless of the current online status of the device.
device.can_hvac_heatBoolean
Optional		Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat mode.
When this flag is true, you can set the thermostat to heat mode.
device.can_hvac_coolBoolean
Optional		Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports cool mode.
When this flag is true, you can set the thermostat to cool mode.
device.can_hvac_heat_coolBoolean
Optional		Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat-cool (auto) mode.
When this flag is true, you can set the thermostat to heat-cool mode.
device.can_turn_off_hvacBoolean
Optional		Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports off mode.
When this flag is true, you can set the thermostat to "off" mode, which turns off both the heating and cooling systems for the space.
+
PropertyTypeDescription
device.can_remotely_unlockBoolean
Optional		Indicates whether the device can perform a remote unlock operation.
device.can_remotely_lockBoolean
Optional		Indicates whether the device can perform a remote lock operation.
device.can_program_online_access_codesBoolean
Optional		Indicates whether the device can program online access codes.
If true, it is currently possible to create new online access codes for the device, and Seam programs the device the next time it's online.
device.can_program_offline_access_codesBoolean
Optional		Indicates whether the device can program offline access codes.
When this flag is true, Seam can generate an offline code for this device, regardless of the current online status of the device.
device.can_hvac_heatBoolean
Optional		Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat mode.
When this flag is true, you can set the thermostat to heat mode.
device.can_hvac_coolBoolean
Optional		Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports cool mode.
When this flag is true, you can set the thermostat to cool mode.
device.can_hvac_heat_coolBoolean
Optional		Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat-cool (auto) mode.
When this flag is true, you can set the thermostat to heat-cool mode.
device.can_turn_off_hvacBoolean
Optional		Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports off mode.
When this flag is true, you can set the thermostat to "off" mode, which turns off both the heating and cooling systems for the space.
{% hint style="info" %} Seam is actively developing additional capability flags to provide you with even more robust capability checking abilities for your app. If you would like us to add a specific capability flag, contact [support@seam.co](mailto:support@seam.co). @@ -48,8 +48,8 @@ Seam is actively developing additional capability flags to provide you with even To learn about the actions that you can perform using the Seam API, see the Seam capability guides. These guides provide helpful tutorials and code samples, categorized by capability types. -* [Smart locks](../capability-guides/smart-locks/), including [locking/unlocking](../capability-guides/smart-locks/lock-and-unlock.md) and [managing access codes](../capability-guides/smart-locks/access-codes/) -* [Access control systems](../capability-guides/access-systems/) +* [Smart locks](../low-level-apis/smart-locks/), including [locking/unlocking](../low-level-apis/smart-locks/lock-and-unlock.md) and [managing access codes](../low-level-apis/smart-locks/access-codes/) +* [Access control systems](../low-level-apis/access-systems/) * [Thermostats](../capability-guides/thermostats/) * [Noise sensors](../capability-guides/noise-sensors/) * [Mobile access](mobile-access/) diff --git a/docs/guides/capability-guides/mobile-access/README.md b/docs/guides/capability-guides/mobile-access/README.md index d46b76b19..c6b2787e8 100644 --- a/docs/guides/capability-guides/mobile-access/README.md +++ b/docs/guides/capability-guides/mobile-access/README.md @@ -10,7 +10,7 @@ description: >- ## Managing Mobile Credentials -Mobile access is the use of a mobile device, such as a smartphone, tablet, or wearable, to gain access to secured doors, gates, services, and more. This functionality is incorporated in [access control systems](../../capability-guides/access-systems/) (ACSs) of diverse types and levels of complexity. +Mobile access is the use of a mobile device, such as a smartphone, tablet, or wearable, to gain access to secured doors, gates, services, and more. This functionality is incorporated in [access control systems](../../low-level-apis/access-systems/) (ACSs) of diverse types and levels of complexity. The Seam mobile access solution makes it easy to issue and retrieve mobile credentials across a wide variety of access control systems. This guide provides an overview of these basic operations and introduces the basic terminology related to mobile access. @@ -19,7 +19,7 @@ The Seam mobile access solution makes it easy to issue and retrieve mobile crede ## Applicable Lock and Access Platforms The Seam mobile access solution is primarily focused on electronic locks and access hardware that support Bluetooth® or near-field communication (NFC) wireless technology. These groups of devices include a vast array of modern electronic door locks, turnstiles, and gate systems. Before implementation, it is important to verify that the existing hardware can communicate with smartphones through one of these wireless technologies.\ -If you aim to enable mobile access with Wi-Fi or Z-Wave locks, see [Smart Locks](../../capability-guides/smart-locks/). This section describes API endpoints that you can use directly in your mobile application. +If you aim to enable mobile access with Wi-Fi or Z-Wave locks, see [Smart Locks](../../low-level-apis/smart-locks/). This section describes API endpoints that you can use directly in your mobile application. *** diff --git a/docs/guides/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md b/docs/guides/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md index 8fc9efa86..1bcd6af9b 100644 --- a/docs/guides/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md +++ b/docs/guides/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md @@ -12,7 +12,7 @@ Seam user identities are a feature for tracking and managing user accounts in yo ### User Identities Can Be Connected to Users in Multiple Access Control Systems -User identities can be linked to one [ACS user](../../capability-guides/access-systems/#what-is-a-user) in each access control system. Any mobile credentials issued to these ACS users are consolidated under the user identity. Consequently, a user's mobile app account has access to these credentials through the user identity. +User identities can be linked to one [ACS user](../../low-level-apis/access-systems/#what-is-a-user) in each access control system. Any mobile credentials issued to these ACS users are consolidated under the user identity. Consequently, a user's mobile app account has access to these credentials through the user identity.
A user identity can be connected to an ACS user in each ACS.
diff --git a/docs/guides/core-concepts/connect-webviews/connect-webview-process.md b/docs/guides/core-concepts/connect-webviews/connect-webview-process.md index 20a3e870b..ba04c148e 100644 --- a/docs/guides/core-concepts/connect-webviews/connect-webview-process.md +++ b/docs/guides/core-concepts/connect-webviews/connect-webview-process.md @@ -317,8 +317,8 @@ Continue using the Seam API to control your users' connected devices or ACS. For To learn about the actions that you can perform using the Seam API, see the Seam [capability guides](../../capability-guides/device-and-system-capabilities.md). These guides provide helpful tutorials and code samples, categorized by capability types. -* [Smart locks](../../capability-guides/smart-locks/), including [locking/unlocking](../../capability-guides/smart-locks/lock-and-unlock.md) and [managing access codes](../../capability-guides/smart-locks/access-codes/) -* [Access control systems](../../capability-guides/access-systems/) +* [Smart locks](../../low-level-apis/smart-locks/), including [locking/unlocking](../../low-level-apis/smart-locks/lock-and-unlock.md) and [managing access codes](../../low-level-apis/smart-locks/access-codes/) +* [Access control systems](../../low-level-apis/access-systems/) * [Thermostats](../../capability-guides/thermostats/) * [Noise sensors](../../capability-guides/noise-sensors/) * [Mobile access](../../capability-guides/mobile-access/) diff --git a/docs/guides/core-concepts/providers/README.md b/docs/guides/core-concepts/providers/README.md index af14b3de4..7c74ffc26 100644 --- a/docs/guides/core-concepts/providers/README.md +++ b/docs/guides/core-concepts/providers/README.md @@ -6,7 +6,7 @@ description: Learn how to find out information about the providers that Seam sup Seam maintains a list of supported providers that you can access using the [List Device Providers](https://docs.seam.co/latest/api/devices/list_device_providers) endpoint. For a provider, this endpoint returns a subset of the following information, depending on the capabilities of the provider's devices: -
PropertyTypeDescription
device_provider_nameString

Name of the device provider.

For example: august

display_nameString

Formatted version of the device_provider_name.

For example: August

image_urlStringImage URL for the provider logo.
provider_categoriesArray

Array of associated categories for the provider.

Supported categories:

  • stable
  • consumer_smartlocks
  • thermostats
  • noise_sensors
can_remotely_unlockBooleanIndicates whether at least one supported device from the provider can perform a remote unlock operation. See Capability Flags.
can_remotely_lockBooleanIndicates whether at least one supported device from the provider can perform a remote lock operation. See Capability Flags.
can_program_online_access_codesBooleanIndicates whether at least one supported device from the provider can program online access codes. See Capability Flags.
can_program_offline_access_codesBooleanIndicates whether at least one supported device from the provider can program offline access codes. See Capability Flags.
can_simulate_connectionBooleanIndicates whether at least one supported device from the provider can simulate device connection. See Capability Flags.
can_simulate_disconnectionBooleanIndicates whether at least one supported device from the provider can simulate device disconnection. See Capability Flags.
can_simulate_removalBooleanIndicates whether at least one supported device from the provider can simulate device removal. See Capability Flags.
can_hvac_coolBooleanIndicates whether at least one supported device from the provider can be set to cool mode. See Capability Flags.
can_hvac_heatBooleanIndicates whether at least one supported device from the provider can be set to heat mode. See Capability Flags.
can_hvac_heat_coolBooleanIndicates whether at least one supported device from the provider can be set to heat-cool mode. See Capability Flags.
can_turn_off_hvacBooleanIndicates whether at least one supported device from the provider can be set to off mode. See Capability Flags.
+
PropertyTypeDescription
device_provider_nameString

Name of the device provider.

For example: august

display_nameString

Formatted version of the device_provider_name.

For example: August

image_urlStringImage URL for the provider logo.
provider_categoriesArray

Array of associated categories for the provider.

Supported categories:

  • stable
  • consumer_smartlocks
  • thermostats
  • noise_sensors
can_remotely_unlockBooleanIndicates whether at least one supported device from the provider can perform a remote unlock operation. See Capability Flags.
can_remotely_lockBooleanIndicates whether at least one supported device from the provider can perform a remote lock operation. See Capability Flags.
can_program_online_access_codesBooleanIndicates whether at least one supported device from the provider can program online access codes. See Capability Flags.
can_program_offline_access_codesBooleanIndicates whether at least one supported device from the provider can program offline access codes. See Capability Flags.
can_simulate_connectionBooleanIndicates whether at least one supported device from the provider can simulate device connection. See Capability Flags.
can_simulate_disconnectionBooleanIndicates whether at least one supported device from the provider can simulate device disconnection. See Capability Flags.
can_simulate_removalBooleanIndicates whether at least one supported device from the provider can simulate device removal. See Capability Flags.
can_hvac_coolBooleanIndicates whether at least one supported device from the provider can be set to cool mode. See Capability Flags.
can_hvac_heatBooleanIndicates whether at least one supported device from the provider can be set to heat mode. See Capability Flags.
can_hvac_heat_coolBooleanIndicates whether at least one supported device from the provider can be set to heat-cool mode. See Capability Flags.
can_turn_off_hvacBooleanIndicates whether at least one supported device from the provider can be set to off mode. See Capability Flags.
The following example shows a `device_provider`: diff --git a/docs/guides/core-concepts/seam-console/README.md b/docs/guides/core-concepts/seam-console/README.md index e458383a4..080aff775 100644 --- a/docs/guides/core-concepts/seam-console/README.md +++ b/docs/guides/core-concepts/seam-console/README.md @@ -12,7 +12,7 @@ Seam Console enables you to manage all resources associated with your Seam accou * Create and manage [workspaces](../workspaces/). * Create and manage [API keys](../authentication/api-keys.md). * Add and manage [devices](../devices/). -* Add and manage [access control systems](../../capability-guides/access-systems/). +* Add and manage [access control systems](../../low-level-apis/access-systems/). * Create, customize, and manage [Connect Webviews](../connect-webviews/). * Add and manage [webhooks](../../developer-tools/webhooks.md). * Use the [Seam Online CLI](seam-online-cli.md). diff --git a/docs/guides/core-concepts/seam-console/seam-online-cli.md b/docs/guides/core-concepts/seam-console/seam-online-cli.md index 96d355276..305bc1296 100644 --- a/docs/guides/core-concepts/seam-console/seam-online-cli.md +++ b/docs/guides/core-concepts/seam-console/seam-online-cli.md @@ -72,7 +72,7 @@ Interact with the Seam CLI using any combination of interactive and typed comman The Seam CLI supports the following command stubs: -
Command StubDescription
seamAccess all Seam CLI commands in an interactive manner.
seam access-codesManage access codes.
seam acsManage Access Control Systems (ACSs), including associated objects, such as systems, users, access groups, and credentials.
seam action-attemptsList and get action attempts to poll the status of attempted actions, such as unlock and create access code.
seam client-sessionsManage client sessions that enable you to restrict users' interactions to include only the devices that they own.
seam connect-webviewsManage Connect Webviews that enable users to connect their devices to Seam.
seam connected-accountsManage connected accounts that represent external, third-party accounts to which users have authorized Seam to access.
seam devicesManage devices, including both "managed" and "unmanaged" devices.
seam eventsRetrieve events.
seam locksRetrieve, lock, and unlock smart locks.
seam loginLog back in to the Seam CLI or change your authorization to use a different API key or Personal Access Token.
seam logoutLog out of the Seam CLI.
seam noise-sensorsManage noise thresholds for noise sensors and simulate triggering noise threshold alerts.
seam selectSelect the desired workspace or server.
seam thermostatsManage thermostats, including current climate settings.
seam user-identitiesManage user identities that enable you to issue and manage mobile credentials and access permissions for users.
seam webhooksManage webhook endpoints that enable you to receive notifications of Seam-related events.
seam workspacesManage your workspaces, including creating new workspaces, retrieving existing workspaces, and resetting your sandbox workspaces.
+
Command StubDescription
seamAccess all Seam CLI commands in an interactive manner.
seam access-codesManage access codes.
seam acsManage Access Control Systems (ACSs), including associated objects, such as systems, users, access groups, and credentials.
seam action-attemptsList and get action attempts to poll the status of attempted actions, such as unlock and create access code.
seam client-sessionsManage client sessions that enable you to restrict users' interactions to include only the devices that they own.
seam connect-webviewsManage Connect Webviews that enable users to connect their devices to Seam.
seam connected-accountsManage connected accounts that represent external, third-party accounts to which users have authorized Seam to access.
seam devicesManage devices, including both "managed" and "unmanaged" devices.
seam eventsRetrieve events.
seam locksRetrieve, lock, and unlock smart locks.
seam loginLog back in to the Seam CLI or change your authorization to use a different API key or Personal Access Token.
seam logoutLog out of the Seam CLI.
seam noise-sensorsManage noise thresholds for noise sensors and simulate triggering noise threshold alerts.
seam selectSelect the desired workspace or server.
seam thermostatsManage thermostats, including current climate settings.
seam user-identitiesManage user identities that enable you to issue and manage mobile credentials and access permissions for users.
seam webhooksManage webhook endpoints that enable you to receive notifications of Seam-related events.
seam workspacesManage your workspaces, including creating new workspaces, retrieving existing workspaces, and resetting your sandbox workspaces.
## Copying and Pasting in the Seam CLI diff --git a/docs/guides/industry-guides/hospitality-industry-guide/granting-access-using-encoded-plastic-key-cards.md b/docs/guides/industry-guides/hospitality-industry-guide/granting-access-using-encoded-plastic-key-cards.md index 795457399..aa15bea92 100644 --- a/docs/guides/industry-guides/hospitality-industry-guide/granting-access-using-encoded-plastic-key-cards.md +++ b/docs/guides/industry-guides/hospitality-industry-guide/granting-access-using-encoded-plastic-key-cards.md @@ -415,7 +415,7 @@ As a final step in creating a plastic key card, use the Seam API to encode the a First, list the available card encoders within the access system and identify the encoder that the person encoding the card should use. Then, initiate the encoding action. The Seam API returns an [action attempt](../../core-concepts/action-attempts.md) so that your app can track the status of the encoding. When the encoding completes successfully, the action attempt payload includes information about the encoded card, such as the card number and the date and time at which the card was issued (that is, encoded). If the encoding fails, the action attempt reports any encoding errors. -For more details about card encoding, see [Creating and Encoding Card Access Methods](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md). +For more details about card encoding, see [Creating and Encoding Card Access Methods](../../low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md). {% tabs %} {% tab title="JavaScript" %} @@ -684,7 +684,7 @@ Pay special attention to the following parts of the returned payload: * `action_attempt.result.acs_credential_on_seam` lists the properties of the access method as stored on the access system server. * `action_attempt.result.acs_credential_on_encoder` lists the properties of the access method as stored on the card. -For more details, see [Scanning Encoded Cards](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards.md). +For more details, see [Scanning Encoded Cards](../../low-level-apis/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards.md). {% tabs %} {% tab title="JavaScript" %} diff --git a/docs/guides/industry-guides/hospitality-industry-guide/seam-api-overview.md b/docs/guides/industry-guides/hospitality-industry-guide/seam-api-overview.md index 7388fdf23..5eac3628e 100644 --- a/docs/guides/industry-guides/hospitality-industry-guide/seam-api-overview.md +++ b/docs/guides/industry-guides/hospitality-industry-guide/seam-api-overview.md @@ -10,7 +10,7 @@ If you want the easiest, most efficient way to grant access, use the [Access Gra This unified approach means that you can build access workflows once and rely on them to work everywhere. -If you need more granular control, the Seam API provides lower-level API resources and endpoints as well. In this case, use the Seam [access control system](../../capability-guides/access-systems/) (ACS) API. +If you need more granular control, the Seam API provides lower-level API resources and endpoints as well. In this case, use the Seam [access control system](../../low-level-apis/access-systems/) (ACS) API. *** diff --git a/docs/guides/capability-guides/access-systems/README.md b/docs/guides/low-level-apis/access-systems/README.md similarity index 55% rename from docs/guides/capability-guides/access-systems/README.md rename to docs/guides/low-level-apis/access-systems/README.md index cd65fac61..584da3924 100644 --- a/docs/guides/capability-guides/access-systems/README.md +++ b/docs/guides/low-level-apis/access-systems/README.md @@ -6,6 +6,10 @@ description: >- # Access Control Systems +{% hint style="warning" %} +**This is a low-level API.** For granting access through your access control system, use [Access Grants](../../use-cases/granting-access/README.md)—the default and recommended way to grant access to any physical space. We don't recommend building on the ACS API directly unless you have discussed your use case with the Seam team at [support@seam.co](mailto:support@seam.co). See [Which API should I use to grant access?](../../use-cases/granting-access/README.md#which-api-should-i-use-to-grant-access) +{% endhint %} +
With Seam, you can manage your ACS system, granting users access to multiple entrances using credentials.

With Seam, you can manage your access control system, granting users access to multiple entrances using credentials.

Use the Seam access control system (ACS) API to grant and manage access to apartment buildings, hotels, commercial offices, warehouses, special-purpose facilities, and much more. Seam integrates with multiple ACS systems and brands, and the Seam API standardizes key functions. @@ -38,7 +42,7 @@ Seam enables you to manage your ACS in a logical, efficient manner. ### Seam's API Handles ACS Differences -Seam's universal API provides the flexibility to manage a variety of [access control systems](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md), each of which may have manufacturer-specific differences. For example, depending on your ACS, you configure access permissions by [assigning ACS users to access groups](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems) or by [specifying access permissions for each ACS user or credential](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-access-control-systems). +Seam's universal API provides the flexibility to manage a variety of [access control systems](../../low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md), each of which may have manufacturer-specific differences. For example, depending on your ACS, you configure access permissions by [assigning ACS users to access groups](../../low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems) or by [specifying access permissions for each ACS user or credential](../../low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-access-control-systems). For details specific to your access control system, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. @@ -46,9 +50,9 @@ For details specific to your access control system, see the [system integration ## **Getting Started** -Create your first credentials! See the [ACS Quick Starts](../../capability-guides/access-systems/acs-quick-starts/). +Create your first credentials! See the [ACS Quick Starts](../../low-level-apis/access-systems/acs-quick-starts/). -
Create your first PIN code credential. →pin-code.pngpin-code-quick-start.md
Create your first encodable key card credential. →key-card.pngencodable-key-card-quick-start.md
Create your first mobile key credential. →mobile-key.pngmobile-key-quick-start.md
+
Create your first PIN code credential. →pin-code.pngpin-code-quick-start.md
Create your first encodable key card credential. →key-card.pngencodable-key-card-quick-start.md
Create your first mobile key credential. →mobile-key.pngmobile-key-quick-start.md
*** @@ -57,18 +61,18 @@ Create your first credentials! See the [ACS Quick Starts](../../capability-guide Find out more about using Seam to manage access control system resources. See the following guides: 1. Connect your ACS to Seam. - * [Connect an ACS to Seam](../../capability-guides/access-systems/connect-an-acs-to-seam/) + * [Connect an ACS to Seam](../../low-level-apis/access-systems/connect-an-acs-to-seam/) 2. Learn about ACS concepts. - * [Access Control System Resources](../../capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md) - * [Understanding ACS Differences](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md) + * [Access Control System Resources](../../low-level-apis/access-systems/connect-an-acs-to-seam/access-control-system-resources.md) + * [Understanding ACS Differences](../../low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md) 3. Get your ACS system ID. - * [Retrieving ACS System Details](../../capability-guides/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md) + * [Retrieving ACS System Details](../../low-level-apis/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md) 4. Create ACS users. * [Managing ACS Users](user-management.md) 5. For relevant access control systems, assign ACS users to access groups. - * [Assigning ACS Users to Access Groups](../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md) + * [Assigning ACS Users to Access Groups](../../low-level-apis/access-systems/user-management/assigning-users-to-access-groups.md) 6. Learn about available entrances. - * [Retrieving Entrance Details](../../capability-guides/access-systems/retrieving-entrance-details.md) + * [Retrieving Entrance Details](../../low-level-apis/access-systems/retrieving-entrance-details.md) 7. Create credentials for ACS users. - * [Managing Credentials](../../capability-guides/access-systems/managing-credentials.md) + * [Managing Credentials](../../low-level-apis/access-systems/managing-credentials.md) 8. See the Seam [Access Control Systems API reference](https://docs.seam.co/latest/api/acs/). diff --git a/docs/guides/capability-guides/access-systems/acs-quick-starts/README.md b/docs/guides/low-level-apis/access-systems/acs-quick-starts/README.md similarity index 82% rename from docs/guides/capability-guides/access-systems/acs-quick-starts/README.md rename to docs/guides/low-level-apis/access-systems/acs-quick-starts/README.md index fb8bdab2c..2a3b455e5 100644 --- a/docs/guides/capability-guides/access-systems/acs-quick-starts/README.md +++ b/docs/guides/low-level-apis/access-systems/acs-quick-starts/README.md @@ -7,6 +7,10 @@ description: >- # Access System Quick Starts +{% hint style="success" %} +**Granting access?** [Access Grants](../../../use-cases/granting-access/README.md) are the default and recommended way to grant access—they manage the underlying codes and credentials for you, across standalone smart locks and access systems alike. +{% endhint %} + * [PIN Code Quick Start](pin-code-quick-start.md)\ Create your first PIN code credential to grant an access system user scheduled access to a virtual entrance that has a keypad. * [Encodable Key Card Quick Start](encodable-key-card-quick-start.md)\ diff --git a/docs/guides/capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start.md b/docs/guides/low-level-apis/access-systems/acs-quick-starts/encodable-key-card-quick-start.md similarity index 98% rename from docs/guides/capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start.md rename to docs/guides/low-level-apis/access-systems/acs-quick-starts/encodable-key-card-quick-start.md index 7e3cdc2cd..ef9e9d371 100644 --- a/docs/guides/capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start.md +++ b/docs/guides/low-level-apis/access-systems/acs-quick-starts/encodable-key-card-quick-start.md @@ -57,7 +57,7 @@ In this quick start, use Seam Console to connect a virtual ACS to your sandbox w 2. In the device brand list, click **Visionline**. 3. On the **Set up your Seam Bridge** page, click **Continue**. - [Seam Bridge](../../seam-bridge.md) is a software-only component that enables you to connect on-premises software systems to the Seam platform. Because Visionline is an on-premises ACS, Seam Bridge is required for real Visionline systems. However, this quick start uses a virtual Visionline ACS, so you do not need to install Seam Bridge. + [Seam Bridge](../../../capability-guides/seam-bridge.md) is a software-only component that enables you to connect on-premises software systems to the Seam platform. Because Visionline is an on-premises ACS, Seam Bridge is required for real Visionline systems. However, this quick start uses a virtual Visionline ACS, so you do not need to install Seam Bridge. 4. On the **Seam Bridge Connection** page, click **Submit**. 5. On the **Enter your credentials** page: 1. In the **Visionline Site Name** field, type any string to identify this virtual Visionline ACS site, for example, `My Visionline Site`. diff --git a/docs/guides/capability-guides/access-systems/acs-quick-starts/mobile-key-quick-start.md b/docs/guides/low-level-apis/access-systems/acs-quick-starts/mobile-key-quick-start.md similarity index 97% rename from docs/guides/capability-guides/access-systems/acs-quick-starts/mobile-key-quick-start.md rename to docs/guides/low-level-apis/access-systems/acs-quick-starts/mobile-key-quick-start.md index a20b7b887..766955df8 100644 --- a/docs/guides/capability-guides/access-systems/acs-quick-starts/mobile-key-quick-start.md +++ b/docs/guides/low-level-apis/access-systems/acs-quick-starts/mobile-key-quick-start.md @@ -6,7 +6,7 @@ description: >- # Mobile Key Quick Start -In this quick start, create a user identity for a virtual [Salto KS](https://docs.seam.co/latest/device-and-system-integration-guides/salto-ks-access-control-system) access control system. Then, grant the user access to an entrance using a mobile key credential. With mobile keys, developers can create mobile apps that download users' credentials and then use Bluetooth low energy (BLE) or similar communications technologies to unlock granted nearby entrances. For more information about Seam's mobile access solution, see [Mobile Access](../../mobile-access/). +In this quick start, create a user identity for a virtual [Salto KS](https://docs.seam.co/latest/device-and-system-integration-guides/salto-ks-access-control-system) access control system. Then, grant the user access to an entrance using a mobile key credential. With mobile keys, developers can create mobile apps that download users' credentials and then use Bluetooth low energy (BLE) or similar communications technologies to unlock granted nearby entrances. For more information about Seam's mobile access solution, see [Mobile Access](../../../capability-guides/mobile-access/). {% hint style="info" %} This quick start walks you through the process that applies specifically to the Salto KS ACS. There are often differences between access control systems. Once you've completed this quick start, learn how to work with your ACS using Seam, by reading the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. @@ -583,7 +583,7 @@ To use Seam Console to view information about your new PIN code credential:
View the entrances to which the ACS user has access as a member of the access group.

View the entrances to which the ACS user has access as a member of the access group.

{% hint style="info" %} -This quick start shows the server-side portion of the mobile access development process. The other piece of this process is to develop a mobile app that downloads the user's mobile keys and then uses BLE or similar technology to unlock nearby entrances to which the user's credentials grant access. For details, see [Integrating into your mobile application](../../mobile-access/mobile-device-sdks/). +This quick start shows the server-side portion of the mobile access development process. The other piece of this process is to develop a mobile app that downloads the user's mobile keys and then uses BLE or similar technology to unlock nearby entrances to which the user's credentials grant access. For details, see [Integrating into your mobile application](../../../capability-guides/mobile-access/mobile-device-sdks/). {% endhint %} *** @@ -607,7 +607,7 @@ For a deeper dive into ACS concepts and instructions, see the following topics: * [Access Control System Resources](../connect-an-acs-to-seam/access-control-system-resources.md) * [Understanding ACS Differences](../connect-an-acs-to-seam/understanding-access-control-system-differences.md) 2. Create user identities. - * [Managing Mobile App User Accounts with User Identities](../../mobile-access/managing-mobile-app-user-accounts-with-user-identities.md) + * [Managing Mobile App User Accounts with User Identities](../../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md) 3. For relevant access control systems, assign user identities to access groups. * [Adding User Identities to Access Groups](https://docs.seam.co/latest/api/acs/access_groups/add_user) 4. Learn about available entrances. @@ -615,6 +615,6 @@ For a deeper dive into ACS concepts and instructions, see the following topics: 5. Create credentials for ACS users. * [Managing Credentials](../managing-credentials.md) 6. Learn more about the Seam mobile access solution. - * [Mobile Access](../../mobile-access/) - * [Integrating into your mobile application](../../mobile-access/mobile-device-sdks/) + * [Mobile Access](../../../capability-guides/mobile-access/) + * [Integrating into your mobile application](../../../capability-guides/mobile-access/mobile-device-sdks/) 7. See the Seam [Access Control Systems API reference](https://docs.seam.co/latest/api/acs/). diff --git a/docs/guides/capability-guides/access-systems/acs-quick-starts/pin-code-quick-start.md b/docs/guides/low-level-apis/access-systems/acs-quick-starts/pin-code-quick-start.md similarity index 100% rename from docs/guides/capability-guides/access-systems/acs-quick-starts/pin-code-quick-start.md rename to docs/guides/low-level-apis/access-systems/acs-quick-starts/pin-code-quick-start.md diff --git a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/README.md b/docs/guides/low-level-apis/access-systems/connect-an-acs-to-seam/README.md similarity index 100% rename from docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/README.md rename to docs/guides/low-level-apis/access-systems/connect-an-acs-to-seam/README.md diff --git a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md b/docs/guides/low-level-apis/access-systems/connect-an-acs-to-seam/access-control-system-resources.md similarity index 63% rename from docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md rename to docs/guides/low-level-apis/access-systems/connect-an-acs-to-seam/access-control-system-resources.md index e925d2596..260d49c3d 100644 --- a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md +++ b/docs/guides/low-level-apis/access-systems/connect-an-acs-to-seam/access-control-system-resources.md @@ -12,7 +12,7 @@ The following diagram shows an example of one ACS, including the ACS resources a The following table provides a brief description of each of the Seam ACS resources: -
ACS ResourceDescription

acs_system

The top-level object. Represents one or more buildings, residential locations, or other sites that you manage using this ACS.
For more information, see Retrieving ACS System Details.

acs_user

The set of users who access the entrances.

If you manage multiple ACSs and need to grant the same user access to entrances in multiple ACSs, you can also use Seam user identities. With user identities, you can link an application user in your own system to one or more Seam ACS users.
For more information, see Managing ACS Users.

acs_access_group

Some ACSs use access groups as an efficient way to grant sets of scheduled entrance access to one or more users.
For more information, see Assigning ACS Users to Access Groups.

acs_credential

A digital means that authorizes a user to access one or more entrances at specific days and times. Examples of credentials include RFID cards, mobile keys, and PIN codes.
For more information, see Managing Credentials.

acs_entrance

The set of entrances, doors, or zones that you want to manage. You identify each entrance by the corresponding lock object.
For more information, see Retrieving Entrance Details.
+
ACS ResourceDescription

acs_system

The top-level object. Represents one or more buildings, residential locations, or other sites that you manage using this ACS.
For more information, see Retrieving ACS System Details.

acs_user

The set of users who access the entrances.

If you manage multiple ACSs and need to grant the same user access to entrances in multiple ACSs, you can also use Seam user identities. With user identities, you can link an application user in your own system to one or more Seam ACS users.
For more information, see Managing ACS Users.

acs_access_group

Some ACSs use access groups as an efficient way to grant sets of scheduled entrance access to one or more users.
For more information, see Assigning ACS Users to Access Groups.

acs_credential

A digital means that authorizes a user to access one or more entrances at specific days and times. Examples of credentials include RFID cards, mobile keys, and PIN codes.
For more information, see Managing Credentials.

acs_entrance

The set of entrances, doors, or zones that you want to manage. You identify each entrance by the corresponding lock object.
For more information, see Retrieving Entrance Details.
{% hint style="info" %} You configure the access schedules for your ACS users either through access groups or credentials, depending on your specific ACS. There is no separate schedule resource in the Seam API. diff --git a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md b/docs/guides/low-level-apis/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md similarity index 96% rename from docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md rename to docs/guides/low-level-apis/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md index dc65aeb2b..ee2ab8561 100644 --- a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md +++ b/docs/guides/low-level-apis/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md @@ -4,7 +4,7 @@ description: Learn how to list and get information about your ACS systems. # Retrieving ACS System Details -You can list details for all the ACSs in your [workspace](../../../core-concepts/workspaces/) or get these details for a specific ACS. Note that Seam represents the ACS as an [`acs_system`](https://docs.seam.co/latest/api/acs/systems/) resource. When you want to [create ACS users](../../../capability-guides/access-systems/user-management.md#create-a-user) for your ACS, you must first obtain the ID of the `acs_system` for which you want to create these users. +You can list details for all the ACSs in your [workspace](../../../core-concepts/workspaces/) or get these details for a specific ACS. Note that Seam represents the ACS as an [`acs_system`](https://docs.seam.co/latest/api/acs/systems/) resource. When you want to [create ACS users](../../../low-level-apis/access-systems/user-management.md#create-a-user) for your ACS, you must first obtain the ID of the `acs_system` for which you want to create these users. *** diff --git a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md b/docs/guides/low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md similarity index 73% rename from docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md rename to docs/guides/low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md index aa62d695d..fce5f12eb 100644 --- a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md +++ b/docs/guides/low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md @@ -6,7 +6,7 @@ description: >- # Understanding Access Control System Differences -Seam's universal API provides the flexibility to manage a variety of [ACSs](../../../capability-guides/access-systems/). Variations among ACSs include the methods that you use to assign access permissions to users. For example, some ACSs grant scheduled access to [entrances](../retrieving-entrance-details.md) through configured [access groups](../user-management/assigning-users-to-access-groups.md), while others specify entrance permissions and schedules as properties of [credentials](../managing-credentials.md). Other variations include the following: +Seam's universal API provides the flexibility to manage a variety of [ACSs](../../../low-level-apis/access-systems/). Variations among ACSs include the methods that you use to assign access permissions to users. For example, some ACSs grant scheduled access to [entrances](../retrieving-entrance-details.md) through configured [access groups](../user-management/assigning-users-to-access-groups.md), while others specify entrance permissions and schedules as properties of [credentials](../managing-credentials.md). Other variations include the following: * Whether an ACS is cloud-based or on-premises * The specific licenses, if any, that each ACS manufacturer requires you to purchase @@ -22,9 +22,9 @@ Seam supports connecting to ACSs that are either cloud-based or on-premises. Cloud-based ACSs are hosted on the internet and are accessible by Seam over a secure connection. This type of ACS provides the benefits and ease of remote management. In addition, you can monitor real-time data and analytics. -On-premises ACSs can also be connected to the internet but are typically protected by a firewall. To integrate with these systems, Seam requires the [Seam Bridge](../../seam-bridge.md), an application installed on a local computer. Once installed, the [Seam Bridge](../../seam-bridge.md) acts as a secure intermediary, handling network requests between Seam and the on-premises network, and enables secure communication through the firewall. +On-premises ACSs can also be connected to the internet but are typically protected by a firewall. To integrate with these systems, Seam requires the [Seam Bridge](../../../capability-guides/seam-bridge.md), an application installed on a local computer. Once installed, the [Seam Bridge](../../../capability-guides/seam-bridge.md) acts as a secure intermediary, handling network requests between Seam and the on-premises network, and enables secure communication through the firewall. -For detailed information about installing the Seam Bridge and connecting an on-premises ACS to Seam, see [Seam Bridge](../../seam-bridge.md). +For detailed information about installing the Seam Bridge and connecting an on-premises ACS to Seam, see [Seam Bridge](../../../capability-guides/seam-bridge.md). *** @@ -34,7 +34,7 @@ This section describes various ways in which ACSs handle assigning access permis ### Access Group-Based Access Control Systems -Access group-based ACSs use access groups as an efficient way to assign access permissions to [ACS users](../../../capability-guides/access-systems/user-management.md). Each access group contains a list of entrances and the corresponding access schedule. Seam syncs all the access group and entrance information from the ACS. +Access group-based ACSs use access groups as an efficient way to assign access permissions to [ACS users](../../../low-level-apis/access-systems/user-management.md). Each access group contains a list of entrances and the corresponding access schedule. Seam syncs all the access group and entrance information from the ACS. To assign access permissions in an access group-based ACS, you add ACS users to the access groups. Then, you create credentials to specify the access mechanisms—such as key cards, PIN codes, or mobile keys—and assign these credentials to the ACS users. @@ -58,7 +58,7 @@ The following process describes the configuration steps for your application to Depending on the access method and specific ACS, your application can also configure additional credential properties. For more information about manufacturer-specific variations, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. -You can also perform other management actions, as needed, such as [adding ACS users to](../user-management/assigning-users-to-access-groups.md#add-an-acs-user-to-an-access-group) and [removing ACS users from access groups](../user-management/assigning-users-to-access-groups.md#remove-an-acs-user-from-an-access-group), [assigning](../managing-credentials/assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](../managing-credentials/assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../../capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../../capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../../capability-guides/access-systems/user-management.md#update-a-user) and [credentials](https://docs.seam.co/latest/api/acs/credentials/update), and [deleting ACS users](../../../capability-guides/access-systems/user-management.md#delete-a-user) and [credentials](../managing-credentials.md#delete-a-credential). +You can also perform other management actions, as needed, such as [adding ACS users to](../user-management/assigning-users-to-access-groups.md#add-an-acs-user-to-an-access-group) and [removing ACS users from access groups](../user-management/assigning-users-to-access-groups.md#remove-an-acs-user-from-an-access-group), [assigning](../managing-credentials/assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](../managing-credentials/assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../../low-level-apis/access-systems/user-management/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../../low-level-apis/access-systems/user-management/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../../low-level-apis/access-systems/user-management.md#update-a-user) and [credentials](https://docs.seam.co/latest/api/acs/credentials/update), and [deleting ACS users](../../../low-level-apis/access-systems/user-management.md#delete-a-user) and [credentials](../managing-credentials.md#delete-a-credential). ### Credential-Based Access Control Systems @@ -71,7 +71,7 @@ The following process describes the configuration steps for your application to 1. Connect the ACS system.\ When the ACS connects to Seam, Seam automatically creates the [`acs_system`](https://docs.seam.co/latest/api/acs/systems/). Seam also syncs the entrances from the connected ACS as `acs_entrance` resources. Note that because Seam automatically syncs these entrance resources from the ACS, you cannot create, edit, or delete them using the Seam API. 2. Create ACS users.\ - Your application [creates](../../../capability-guides/access-systems/user-management.md#create-a-user) an [`acs_user`](https://docs.seam.co/latest/api/acs/users/) for each user within this ACS. Each `acs_user` is configured with a set of attributes, such their name, email address, and phone number, as applicable.\ + Your application [creates](../../../low-level-apis/access-systems/user-management.md#create-a-user) an [`acs_user`](https://docs.seam.co/latest/api/acs/users/) for each user within this ACS. Each `acs_user` is configured with a set of attributes, such their name, email address, and phone number, as applicable.\ If you need to grant a single application user access to multiple ACSs—for example, if an application user needs access to multiple buildings, each of which uses a separate ACS—you can use Seam [user identities](https://docs.seam.co/latest/api/user_identities/) to link `acs_user`s in different `acs_system`s. 3. Create credentials.\ Your application [creates](../managing-credentials.md#create-a-credential-for-a-user) `acs_credential`s with the following attributes: @@ -83,7 +83,7 @@ The following process describes the configuration steps for your application to Depending on the access method and specific ACS, your application can also configure additional credential properties. For more information about manufacturer-specific variations, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. -You can also perform other management actions, as needed, such as [assigning](../managing-credentials/assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](../managing-credentials/assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../../capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../../capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../../capability-guides/access-systems/user-management.md#update-a-user) and [credentials](https://docs.seam.co/latest/api/acs/credentials/update), and [deleting ACS users](../../../capability-guides/access-systems/user-management.md#delete-a-user) and [credentials](../managing-credentials.md#delete-a-credential). +You can also perform other management actions, as needed, such as [assigning](../managing-credentials/assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](../managing-credentials/assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../../low-level-apis/access-systems/user-management/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../../low-level-apis/access-systems/user-management/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../../low-level-apis/access-systems/user-management.md#update-a-user) and [credentials](https://docs.seam.co/latest/api/acs/credentials/update), and [deleting ACS users](../../../low-level-apis/access-systems/user-management.md#delete-a-user) and [credentials](../managing-credentials.md#delete-a-credential). *** diff --git a/docs/guides/capability-guides/access-systems/managing-credentials.md b/docs/guides/low-level-apis/access-systems/managing-credentials.md similarity index 93% rename from docs/guides/capability-guides/access-systems/managing-credentials.md rename to docs/guides/low-level-apis/access-systems/managing-credentials.md index c39e875b9..1c2f1b254 100644 --- a/docs/guides/capability-guides/access-systems/managing-credentials.md +++ b/docs/guides/low-level-apis/access-systems/managing-credentials.md @@ -4,7 +4,11 @@ description: Learn how to manage credentials and assign them to users. # Managing Credentials -An ACS generally uses digital means of access to authorize an [ACS user](../../capability-guides/access-systems/user-management.md) trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs. +{% hint style="success" %} +**Granting access?** [Access Grants](../../use-cases/granting-access/README.md) are the default and recommended way to grant access—they manage the underlying codes and credentials for you, across standalone smart locks and access systems alike. +{% endhint %} + +An ACS generally uses digital means of access to authorize an [ACS user](../../low-level-apis/access-systems/user-management.md) trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
Examples of ACS user credentials

Examples of ACS user credentials

@@ -22,7 +26,7 @@ To [create a credential for an ACS user](https://docs.seam.co/latest/api/acs/cre * `code` for a PIN code-based credential * `card` for a plastic key card-based credential -* `mobile_key` for a [Seam mobile key](../mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#what-are-multi-phone-sync-credentials). +* `mobile_key` for a [Seam mobile key](../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#what-are-multi-phone-sync-credentials). Depending on the ACS and the type of credential you are issuing, you can also specify the following properties for the new credential: @@ -351,7 +355,7 @@ seam.CredentialsAcs.Create( ### Create a Seam Mobile Key -Depending on the ACS for which you want to create a credential, you may also need to include system-specific metadata. See the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. For more information about mobile access and issuing mobile credentials, see [Mobile Access](../mobile-access/) and [Issuing Mobile Credentials from an Access Control System](../mobile-access/issuing-mobile-credentials-from-an-access-control-system.md). +Depending on the ACS for which you want to create a credential, you may also need to include system-specific metadata. See the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. For more information about mobile access and issuing mobile credentials, see [Mobile Access](../../capability-guides/mobile-access/) and [Issuing Mobile Credentials from an Access Control System](../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md). {% tabs %} {% tab title="JavaScript" %} @@ -588,11 +592,11 @@ This response contains manufacturer-specific metadata that may vary by [manufact ## List Credentials -You can [list all ACS credentials](https://docs.seam.co/latest/api/acs/credentials/list) for a specific [ACS user](../../capability-guides/access-systems/user-management.md) or [user identity](../mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity). You can also [list all credentials for an ACS system](https://docs.seam.co/latest/api/acs/credentials/list). +You can [list all ACS credentials](https://docs.seam.co/latest/api/acs/credentials/list) for a specific [ACS user](../../low-level-apis/access-systems/user-management.md) or [user identity](../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity). You can also [list all credentials for an ACS system](https://docs.seam.co/latest/api/acs/credentials/list). ### List Credentials by ACS User -To [list all ACS credentials](https://docs.seam.co/latest/api/acs/credentials/list) for a specific [ACS user](../../capability-guides/access-systems/user-management.md), provide the `acs_user_id`. +To [list all ACS credentials](https://docs.seam.co/latest/api/acs/credentials/list) for a specific [ACS user](../../low-level-apis/access-systems/user-management.md), provide the `acs_user_id`. {% tabs %} {% tab title="JavaScript" %} @@ -760,7 +764,7 @@ This response contains manufacturer-specific metadata that may vary by [manufact ### List Credentials by User Identity -To [list all ACS credentials](https://docs.seam.co/latest/api/acs/credentials/list) for a specific [user identity](../mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity), provide the `user_identity_id`. +To [list all ACS credentials](https://docs.seam.co/latest/api/acs/credentials/list) for a specific [user identity](../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity), provide the `user_identity_id`. {% tabs %} {% tab title="JavaScript" %} diff --git a/docs/guides/capability-guides/access-systems/managing-credentials/assigning-credentials-to-users.md b/docs/guides/low-level-apis/access-systems/managing-credentials/assigning-credentials-to-users.md similarity index 100% rename from docs/guides/capability-guides/access-systems/managing-credentials/assigning-credentials-to-users.md rename to docs/guides/low-level-apis/access-systems/managing-credentials/assigning-credentials-to-users.md diff --git a/docs/guides/capability-guides/access-systems/managing-credentials/listing-credentials-and-associated-entrances.md b/docs/guides/low-level-apis/access-systems/managing-credentials/listing-credentials-and-associated-entrances.md similarity index 100% rename from docs/guides/capability-guides/access-systems/managing-credentials/listing-credentials-and-associated-entrances.md rename to docs/guides/low-level-apis/access-systems/managing-credentials/listing-credentials-and-associated-entrances.md diff --git a/docs/guides/capability-guides/access-systems/retrieving-entrance-details.md b/docs/guides/low-level-apis/access-systems/retrieving-entrance-details.md similarity index 100% rename from docs/guides/capability-guides/access-systems/retrieving-entrance-details.md rename to docs/guides/low-level-apis/access-systems/retrieving-entrance-details.md diff --git a/docs/guides/capability-guides/access-systems/troubleshooting-your-access-control-system.md b/docs/guides/low-level-apis/access-systems/troubleshooting-your-access-control-system.md similarity index 91% rename from docs/guides/capability-guides/access-systems/troubleshooting-your-access-control-system.md rename to docs/guides/low-level-apis/access-systems/troubleshooting-your-access-control-system.md index 3230cdd68..68eb22dd9 100644 --- a/docs/guides/capability-guides/access-systems/troubleshooting-your-access-control-system.md +++ b/docs/guides/low-level-apis/access-systems/troubleshooting-your-access-control-system.md @@ -12,12 +12,12 @@ These errors alert you to issues involving the connection between your on-premis ### `acs_system.errors.seam_bridge_disconnected` -This error indicates that the Seam API cannot communicate with your [Seam Bridge](../seam-bridge.md), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. This error might also occur if your Seam Bridge is connected to the wrong [workspace](../../core-concepts/workspaces/). +This error indicates that the Seam API cannot communicate with your [Seam Bridge](../../capability-guides/seam-bridge.md), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. This error might also occur if your Seam Bridge is connected to the wrong [workspace](../../core-concepts/workspaces/). To troubleshoot this error: -* Make sure that you are running the [latest version of the Seam Bridge](https://www.seam.co/seam-bridge/releases/latest). If not, reinstall and then start the Seam Bridge executable. See the [Seam Bridge installation instructions](../seam-bridge.md#installation-instructions). -* Reconnect the Seam Bridge. To reconnect, you can go to your ACS in the **Access Systems** area of the [Seam Console](https://console.seam.co/) or use a [Connect Webview](https://docs.seam.co/latest/api/connect_webviews/). For more information, see [Pairing the Seam Bridge with Your Workspace](../seam-bridge.md#pairing-the-seam-bridge-with-your-workspace). +* Make sure that you are running the [latest version of the Seam Bridge](https://www.seam.co/seam-bridge/releases/latest). If not, reinstall and then start the Seam Bridge executable. See the [Seam Bridge installation instructions](../../capability-guides/seam-bridge.md#installation-instructions). +* Reconnect the Seam Bridge. To reconnect, you can go to your ACS in the **Access Systems** area of the [Seam Console](https://console.seam.co/) or use a [Connect Webview](https://docs.seam.co/latest/api/connect_webviews/). For more information, see [Pairing the Seam Bridge with Your Workspace](../../capability-guides/seam-bridge.md#pairing-the-seam-bridge-with-your-workspace). * Restart the Seam Bridge executable. *** diff --git a/docs/guides/capability-guides/access-systems/user-management.md b/docs/guides/low-level-apis/access-systems/user-management.md similarity index 95% rename from docs/guides/capability-guides/access-systems/user-management.md rename to docs/guides/low-level-apis/access-systems/user-management.md index 77100effb..c6ecd255b 100644 --- a/docs/guides/capability-guides/access-systems/user-management.md +++ b/docs/guides/low-level-apis/access-systems/user-management.md @@ -6,6 +6,10 @@ description: >- # Managing ACS Users +{% hint style="success" %} +**Granting access?** [Access Grants](../../use-cases/granting-access/README.md) are the default and recommended way to grant access—they manage the underlying codes and credentials for you, across standalone smart locks and access systems alike. +{% endhint %} + An ACS user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the [Salto](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period. This guide explains how to create and manage ACS users. Using the [Access Control Systems API](https://docs.seam.co/latest/api/acs/), you can automate issuing access to long-term tenants or visitors. @@ -156,7 +160,7 @@ seam.SystemsAcs.List(); To [create an ACS user](https://docs.seam.co/latest/api/acs/users/create), provide the `acs_system_id` of the ACS system and the attributes of the user, such as the `full_name`, `email_address`, `phone_number`, and so on. -Also, if your [ACS architecture](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md) supports access groups, you can also assign an ACS user to one or more access groups. To do so, when you create the user, include the IDs of the access group to which you want add the user. The `acs_access_group_ids` parameter accepts an array of strings. +Also, if your [ACS architecture](../../low-level-apis/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md) supports access groups, you can also assign an ACS user to one or more access groups. To do so, when you create the user, include the IDs of the access group to which you want add the user. The `acs_access_group_ids` parameter accepts an array of strings. In addition, if your ACS architecture supports assigning access schedules directly to ACS users, you can specify an `access_schedule` for the user, including a `starts_at` and `ends_at` date and time. diff --git a/docs/guides/capability-guides/access-systems/user-management/assigning-users-to-access-groups.md b/docs/guides/low-level-apis/access-systems/user-management/assigning-users-to-access-groups.md similarity index 100% rename from docs/guides/capability-guides/access-systems/user-management/assigning-users-to-access-groups.md rename to docs/guides/low-level-apis/access-systems/user-management/assigning-users-to-access-groups.md diff --git a/docs/guides/capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md b/docs/guides/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users.md similarity index 100% rename from docs/guides/capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md rename to docs/guides/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users.md diff --git a/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md b/docs/guides/low-level-apis/access-systems/working-with-card-encoders-and-scanners/README.md similarity index 96% rename from docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md rename to docs/guides/low-level-apis/access-systems/working-with-card-encoders-and-scanners/README.md index 00aafd333..70c100964 100644 --- a/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md +++ b/docs/guides/low-level-apis/access-systems/working-with-card-encoders-and-scanners/README.md @@ -19,7 +19,7 @@ Some access control systems require credentials to be [encoded onto plastic key Separately, the Seam API also supports [card scanning](scanning-encoded-cards.md), which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with ACS records or diagnose discrepancies if needed. -To verify if your ACS requires a card encoder, see the [system integration guide](../../../capability-guides/access-systems/) for your ACS. +To verify if your ACS requires a card encoder, see the [system integration guide](../../../low-level-apis/access-systems/) for your ACS. *** diff --git a/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md b/docs/guides/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md similarity index 100% rename from docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md rename to docs/guides/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md diff --git a/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md b/docs/guides/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md similarity index 99% rename from docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md rename to docs/guides/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md index 2d7d7adf7..206706c33 100644 --- a/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md +++ b/docs/guides/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md @@ -12,7 +12,7 @@ Some access control systems require encoding a plastic card with the data necess This process consists of the following basic steps: -1. Set up an [access system user](../../../capability-guides/access-systems/user-management.md) and create a [credential](../managing-credentials.md#create-a-card-based-credential) with the `access_method` set to `card`.\ +1. Set up an [access system user](../../../low-level-apis/access-systems/user-management.md) and create a [credential](../managing-credentials.md#create-a-card-based-credential) with the `access_method` set to `card`.\ See the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your access system provider to learn specific requirements, such as configuring entrances and access schedules.\ See [Set Up an Access System User and Card Credential](creating-and-encoding-card-based-credentials.md#id-1.-set-up-an-access-syseuser-and-card-credential). 2. Use the `/acs/encoders/list` endpoint to retrieve a list of available encoders. Then, choose the encoder that you want to use to write the credential onto the card.\ diff --git a/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards.md b/docs/guides/low-level-apis/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards.md similarity index 100% rename from docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards.md rename to docs/guides/low-level-apis/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards.md diff --git a/docs/guides/capability-guides/smart-locks/README.md b/docs/guides/low-level-apis/smart-locks/README.md similarity index 86% rename from docs/guides/capability-guides/smart-locks/README.md rename to docs/guides/low-level-apis/smart-locks/README.md index 808a4cb0a..ee4c736f4 100644 --- a/docs/guides/capability-guides/smart-locks/README.md +++ b/docs/guides/low-level-apis/smart-locks/README.md @@ -6,6 +6,10 @@ description: >- # Smart Locks +{% hint style="warning" %} +**This is a low-level API.** For granting access to smart locks, use [Access Grants](../../use-cases/granting-access/README.md)—the default and recommended way to grant access to any physical space. We don't recommend building on the Smart Locks API directly unless you have discussed your use case with the Seam team at [support@seam.co](mailto:support@seam.co). See [Which API should I use to grant access?](../../use-cases/granting-access/README.md#which-api-should-i-use-to-grant-access) +{% endhint %} + {% 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 %} diff --git a/docs/guides/capability-guides/smart-locks/access-codes/README.md b/docs/guides/low-level-apis/smart-locks/access-codes/README.md similarity index 97% rename from docs/guides/capability-guides/smart-locks/access-codes/README.md rename to docs/guides/low-level-apis/smart-locks/access-codes/README.md index 28eb7e1d6..5d6124c40 100644 --- a/docs/guides/capability-guides/smart-locks/access-codes/README.md +++ b/docs/guides/low-level-apis/smart-locks/access-codes/README.md @@ -6,6 +6,10 @@ description: >- # Creating and Managing Smart Lock Access Codes +{% hint style="success" %} +**Granting access?** [Access Grants](../../../use-cases/granting-access/README.md) are the default and recommended way to grant access—they manage the underlying codes and credentials for you, across standalone smart locks and access systems alike. +{% endhint %} +
## What Is an Access Code? diff --git a/docs/guides/capability-guides/smart-locks/access-codes/access-code-requirements-for-door-locks.md b/docs/guides/low-level-apis/smart-locks/access-codes/access-code-requirements-for-door-locks.md similarity index 100% rename from docs/guides/capability-guides/smart-locks/access-codes/access-code-requirements-for-door-locks.md rename to docs/guides/low-level-apis/smart-locks/access-codes/access-code-requirements-for-door-locks.md diff --git a/docs/guides/capability-guides/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md b/docs/guides/low-level-apis/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md similarity index 100% rename from docs/guides/capability-guides/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md rename to docs/guides/low-level-apis/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md diff --git a/docs/guides/capability-guides/smart-locks/access-codes/backup-access-codes.md b/docs/guides/low-level-apis/smart-locks/access-codes/backup-access-codes.md similarity index 100% rename from docs/guides/capability-guides/smart-locks/access-codes/backup-access-codes.md rename to docs/guides/low-level-apis/smart-locks/access-codes/backup-access-codes.md diff --git a/docs/guides/capability-guides/smart-locks/access-codes/creating-access-codes/README.md b/docs/guides/low-level-apis/smart-locks/access-codes/creating-access-codes/README.md similarity index 89% rename from docs/guides/capability-guides/smart-locks/access-codes/creating-access-codes/README.md rename to docs/guides/low-level-apis/smart-locks/access-codes/creating-access-codes/README.md index 0005519cc..5b4f92d62 100644 --- a/docs/guides/capability-guides/smart-locks/access-codes/creating-access-codes/README.md +++ b/docs/guides/low-level-apis/smart-locks/access-codes/creating-access-codes/README.md @@ -16,14 +16,14 @@ Seam supports programming two types of online access codes for online door locks 2. **Time Bound**: Suitable for temporary access like guest visits or service appointments. These codes operate between a designated `starts_at` and `ends_at` time window, granting access only during that period. {% hint style="info" %} -For more information about creating offline access codes, see [Managing Offline Access Codes](../../../../capability-guides/smart-locks/access-codes/offline-access-codes.md). +For more information about creating offline access codes, see [Managing Offline Access Codes](../../../../low-level-apis/smart-locks/access-codes/offline-access-codes.md). {% endhint %} *** ## Before You Begin: Confirm Capabilities -Before you attempt to create an [online](../../../../capability-guides/smart-locks/access-codes/#what-is-an-access-code) or [offline](../../../../capability-guides/smart-locks/access-codes/#offline-access-codes) access code, be sure to confirm that your device has the capability to perform these operations. You can inspect the capabilities of a device by checking the following [capability flags](../../../device-and-system-capabilities.md#capability-flags) for the device: +Before you attempt to create an [online](../../../../low-level-apis/smart-locks/access-codes/#what-is-an-access-code) or [offline](../../../../low-level-apis/smart-locks/access-codes/#offline-access-codes) access code, be sure to confirm that your device has the capability to perform these operations. You can inspect the capabilities of a device by checking the following [capability flags](../../../../capability-guides/device-and-system-capabilities.md#capability-flags) for the device: * `device.can_program_online_access_codes` * `device.can_program_offline_access_codes` @@ -184,7 +184,7 @@ Ongoing online access codes are ideal for long-term users that wish to keep the Set an ongoing online access code by providing the `device_id` of the smart lock on which you want to [create an access code](https://docs.seam.co/latest/api/access_codes/create). Assign an optional `name` to the access code for easier identification within the [Seam Console](https://console.seam.co) and smart lock app. -To customize the PIN code, specify a desired PIN for the `code` property. If you do not specify a `code`, you can set the `preferred_code_length`, and Seam generates a code of this length if the affected device supports the specified preferred code length. See [Access Code Requirements for Door Locks](../../../../capability-guides/smart-locks/access-codes/access-code-requirements-for-door-locks.md) to understand any requirements specific to the door lock. +To customize the PIN code, specify a desired PIN for the `code` property. If you do not specify a `code`, you can set the `preferred_code_length`, and Seam generates a code of this length if the affected device supports the specified preferred code length. See [Access Code Requirements for Door Locks](../../../../low-level-apis/smart-locks/access-codes/access-code-requirements-for-door-locks.md) to understand any requirements specific to the door lock. {% tabs %} {% tab title="JavaScript" %} @@ -426,7 +426,7 @@ There are two methods to verify that an ongoing access code has been set on the Use the `access_code` reference returned by the create function to call the [Get Access Code](https://docs.seam.co/latest/api/access_codes/get) function. A basic implementation would involve polling this endpoint until the `status` of the access code updates to `set`. -If the `status` remains `setting` for a very long time, or if the `access_code` object contains any `warnings` or `errors` properties, consult [the guide on "Troubleshooting Access Code Issues"](../../../../capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues.md) for further guidance. +If the `status` remains `setting` for a very long time, or if the `access_code` object contains any `warnings` or `errors` properties, consult [the guide on "Troubleshooting Access Code Issues"](../../../../low-level-apis/smart-locks/access-codes/troubleshooting-access-code-issues.md) for further guidance.

Illustration of the polling verification step for an ongoing access code

@@ -437,7 +437,7 @@ To avoid polling, monitor for incoming Seam webhook events related to the code s * The `access_code.set_on_device` event indicates the successful setting of the access code on the device. * The `access_code.failed_to_set_on_device` or `access_code.delay_in_setting_on_device` events indicate a delay or failure. -In the event of delay or failure, refer to [the "Troubleshooting access code issues" guide](../../../../capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues.md) for assistance and mitigation strategies. +In the event of delay or failure, refer to [the "Troubleshooting access code issues" guide](../../../../low-level-apis/smart-locks/access-codes/troubleshooting-access-code-issues.md) for assistance and mitigation strategies.

Illustration of the webhook verification method for an ongoing access code

@@ -455,7 +455,7 @@ To set a time-bound online access code, provide the `device_id` of the smart loc As with ongoing codes, you can assign an optional `name` to the access code. A clear name helps users to identify the access code quickly within their smart lock app. -Similarly, to customize the PIN code, specify a desired PIN in the `code` property. If you do not specify a `code`, you can set the `preferred_code_length`, and Seam generates a code of this length if the affected device supports the specified preferred code length. See the [Access Code Requirements for Door Locks](../../../../capability-guides/smart-locks/access-codes/access-code-requirements-for-door-locks.md) to understand any requirements specific to the door lock brand. +Similarly, to customize the PIN code, specify a desired PIN in the `code` property. If you do not specify a `code`, you can set the `preferred_code_length`, and Seam generates a code of this length if the affected device supports the specified preferred code length. See the [Access Code Requirements for Door Locks](../../../../low-level-apis/smart-locks/access-codes/access-code-requirements-for-door-locks.md) to understand any requirements specific to the door lock brand. {% tabs %} {% tab title="JavaScript" %} @@ -709,7 +709,7 @@ if (device.CanProgramOnlineAccessCodes == true) { ### 2. Verify Successful Time-Bound Code Programming -The [lifecycle of a time-bound access code](../../../../capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md) is marked by distinct phases: +The [lifecycle of a time-bound access code](../../../../low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes.md) is marked by distinct phases: 1. `Unset`: When initially created on Seam, the access code remains in an `unset` state, indicating it has not yet been programmed onto the door lock due to its future activation time. 2. `Setting`: As the scheduled `starts_at` time approaches, Seam initiates the process of programming the code onto the lock, transitioning the code's `status` to `setting`. @@ -717,7 +717,7 @@ The [lifecycle of a time-bound access code](../../../../capability-guides/smart-

Life-cycle of a time-bound access code

-On door locks that support [natively scheduled](../../../../capability-guides/smart-locks/access-codes/#native-scheduling) access codes, Seam will preload the access code into the device's internal memory bank **72 hours ahead** of the `starts_at` time. Even if preloaded in memory, the access code will remain in an `unset` state ahead of the `starts_at` time and await the precise activation moment to toggle its status. When the `starts_at` time arrives, the access code becomes active and transition to a `set` status, granting the designated user the ability to utilize it for entry. If there's an issue programming the natively-scheduled code by its `starts_at` time, the code's status will display as `setting`. For more information on the lifecycle of access codes, [please refer to this guide](../../../../capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md). +On door locks that support [natively scheduled](../../../../low-level-apis/smart-locks/access-codes/#native-scheduling) access codes, Seam will preload the access code into the device's internal memory bank **72 hours ahead** of the `starts_at` time. Even if preloaded in memory, the access code will remain in an `unset` state ahead of the `starts_at` time and await the precise activation moment to toggle its status. When the `starts_at` time arrives, the access code becomes active and transition to a `set` status, granting the designated user the ability to utilize it for entry. If there's an issue programming the natively-scheduled code by its `starts_at` time, the code's status will display as `setting`. For more information on the lifecycle of access codes, [please refer to this guide](../../../../low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes.md). There are two methods to verify that an time-bound access code has been set on the device: @@ -728,7 +728,7 @@ There are two methods to verify that an time-bound access code has been set on t Use the `access_code` reference returned by the create function to call the [Get Access Code](https://docs.seam.co/latest/api/access_codes/get) function. In a basic implementation, you would poll this endpoint at the `starts_at` time to check if the access code's status is updated to `set`. -If the `status` remains `setting`, or if the `access_code` object displays any `warnings` or `errors`, refer to [the "Troubleshooting Access Code Issues" guide](../../../../capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues.md) for assistance. +If the `status` remains `setting`, or if the `access_code` object displays any `warnings` or `errors`, refer to [the "Troubleshooting Access Code Issues" guide](../../../../low-level-apis/smart-locks/access-codes/troubleshooting-access-code-issues.md) for assistance.
@@ -739,6 +739,6 @@ To avoid polling, monitor for incoming Seam webhook events related to the code s * The `access_code.set_on_device` event indicates the successful setting of the access code on the device. * The `access_code.failed_to_set_on_device` or `access_code.delay_in_setting_on_device` events indicate a delay or failure. -In the event of delay or failure, refer to [the "Troubleshooting access code issues" guide](../../../../capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues.md) for assistance and mitigation strategies. +In the event of delay or failure, refer to [the "Troubleshooting access code issues" guide](../../../../low-level-apis/smart-locks/access-codes/troubleshooting-access-code-issues.md) for assistance and mitigation strategies.
diff --git a/docs/guides/capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md b/docs/guides/low-level-apis/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md similarity index 100% rename from docs/guides/capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md rename to docs/guides/low-level-apis/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md diff --git a/docs/guides/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md b/docs/guides/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md similarity index 100% rename from docs/guides/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md rename to docs/guides/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md diff --git a/docs/guides/capability-guides/smart-locks/access-codes/deleting-access-codes.md b/docs/guides/low-level-apis/smart-locks/access-codes/deleting-access-codes.md similarity index 100% rename from docs/guides/capability-guides/smart-locks/access-codes/deleting-access-codes.md rename to docs/guides/low-level-apis/smart-locks/access-codes/deleting-access-codes.md diff --git a/docs/guides/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md b/docs/guides/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes.md similarity index 100% rename from docs/guides/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md rename to docs/guides/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes.md diff --git a/docs/guides/capability-guides/smart-locks/access-codes/migrating-existing-access-codes.md b/docs/guides/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes.md similarity index 100% rename from docs/guides/capability-guides/smart-locks/access-codes/migrating-existing-access-codes.md rename to docs/guides/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes.md diff --git a/docs/guides/capability-guides/smart-locks/access-codes/modifying-access-codes.md b/docs/guides/low-level-apis/smart-locks/access-codes/modifying-access-codes.md similarity index 100% rename from docs/guides/capability-guides/smart-locks/access-codes/modifying-access-codes.md rename to docs/guides/low-level-apis/smart-locks/access-codes/modifying-access-codes.md diff --git a/docs/guides/capability-guides/smart-locks/access-codes/offline-access-codes.md b/docs/guides/low-level-apis/smart-locks/access-codes/offline-access-codes.md similarity index 98% rename from docs/guides/capability-guides/smart-locks/access-codes/offline-access-codes.md rename to docs/guides/low-level-apis/smart-locks/access-codes/offline-access-codes.md index 9c04edcc1..ed5f68dff 100644 --- a/docs/guides/capability-guides/smart-locks/access-codes/offline-access-codes.md +++ b/docs/guides/low-level-apis/smart-locks/access-codes/offline-access-codes.md @@ -471,8 +471,8 @@ The [lifecycle of a time-bound access code](lifecycle-of-access-codes.md) is mar There are two methods to verify that an time-bound offline access code has been registered in the offline access code server that the device manufacturer maintains: -* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](../../../capability-guides/smart-locks/access-codes/creating-access-codes/#polling-method-1). -* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](../../../capability-guides/smart-locks/access-codes/creating-access-codes/#webhook-events-method-1). +* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](../../../low-level-apis/smart-locks/access-codes/creating-access-codes/#polling-method-1). +* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](../../../low-level-apis/smart-locks/access-codes/creating-access-codes/#webhook-events-method-1). *** @@ -767,5 +767,5 @@ The [lifecycle of a one-time-use access code](lifecycle-of-access-codes.md) is m There are two methods to verify that a one-time-use offline access code has been registered in the offline access code server that the device manufacturer maintains: -* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](../../../capability-guides/smart-locks/access-codes/creating-access-codes/#polling-method-1). -* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](../../../capability-guides/smart-locks/access-codes/creating-access-codes/#webhook-events-method-1). +* **Polling**: Continuously query the access code until the `status` is updated. For instructions, see [Polling Method](../../../low-level-apis/smart-locks/access-codes/creating-access-codes/#polling-method-1). +* **Webhook**: Wait for updates to arrive using webhook requests from the Seam API. For instructions, see [Webhook Events Method](../../../low-level-apis/smart-locks/access-codes/creating-access-codes/#webhook-events-method-1). diff --git a/docs/guides/capability-guides/smart-locks/access-codes/retrieving-access-codes.md b/docs/guides/low-level-apis/smart-locks/access-codes/retrieving-access-codes.md similarity index 100% rename from docs/guides/capability-guides/smart-locks/access-codes/retrieving-access-codes.md rename to docs/guides/low-level-apis/smart-locks/access-codes/retrieving-access-codes.md diff --git a/docs/guides/capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues.md b/docs/guides/low-level-apis/smart-locks/access-codes/troubleshooting-access-code-issues.md similarity index 100% rename from docs/guides/capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues.md rename to docs/guides/low-level-apis/smart-locks/access-codes/troubleshooting-access-code-issues.md diff --git a/docs/guides/capability-guides/smart-locks/get-started-with-smartlocks-api.md b/docs/guides/low-level-apis/smart-locks/get-started-with-smartlocks-api.md similarity index 99% rename from docs/guides/capability-guides/smart-locks/get-started-with-smartlocks-api.md rename to docs/guides/low-level-apis/smart-locks/get-started-with-smartlocks-api.md index 99e56d126..e9ccb4e04 100644 --- a/docs/guides/capability-guides/smart-locks/get-started-with-smartlocks-api.md +++ b/docs/guides/low-level-apis/smart-locks/get-started-with-smartlocks-api.md @@ -315,7 +315,7 @@ $seam->locks->lock_door($lock->device_id); Many smartlocks have a built-in keypad or an external one that can be paired over bluetooth. This lets you program access codes that a user can then enter at a later time to unlock a door. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a smartlock. An `ongoing` code is a code that will be permanently programmed onto the device until you tell the Seam API you wish to remove it. A `timebound` code is, as the time implies, time bound by a set of ISO8601 timestamp that you provide the Seam API. You can find out more about access code in our [core concept section on access codes.](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a smartlock. An `ongoing` code is a code that will be permanently programmed onto the device until you tell the Seam API you wish to remove it. A `timebound` code is, as the time implies, time bound by a set of ISO8601 timestamp that you provide the Seam API. You can find out more about access code in our [core concept section on access codes.](https://docs.seam.co/latest/low-level-apis/smart-locks/access-codes) {% tabs %} {% tab title="JavaScript" %} diff --git a/docs/guides/capability-guides/smart-locks/lock-and-unlock.md b/docs/guides/low-level-apis/smart-locks/lock-and-unlock.md similarity index 100% rename from docs/guides/capability-guides/smart-locks/lock-and-unlock.md rename to docs/guides/low-level-apis/smart-locks/lock-and-unlock.md diff --git a/docs/guides/quickstart.md b/docs/guides/quickstart.md index 995cff49f..6fce2825b 100644 --- a/docs/guides/quickstart.md +++ b/docs/guides/quickstart.md @@ -385,7 +385,7 @@ Here are some ideas of what you can do next... You just created your first Access Grant. The same API issues mobile keys, [Instant Keys](capability-guides/instant-keys/README.md), and plastic cards, grants access to multiple devices and [access system entrances](use-cases/granting-access/creating-an-access-grant-using-entrances.md) in one call, and manages the full credential lifecycle. See the [Granting Access guide](use-cases/granting-access/README.md). -You can also control devices directly—for example, [lock and unlock doors](capability-guides/smart-locks/lock-and-unlock.md) remotely. +You can also control devices directly—for example, [lock and unlock doors](low-level-apis/smart-locks/lock-and-unlock.md) remotely. ### Connect a Real Device @@ -401,4 +401,4 @@ If you are creating an app to control your users' devices, see [Connect Webviews Seam supports many device categories. Each device can be broken down into [device capabilities](capability-guides/device-and-system-capabilities.md). A capability indicates what the device can do, what properties it has, and what events it emits. To learn more about specific capabilities, such as access codes or thermostats, see the following guides: -
Door Locks APIGet started →smart-locks-16-9.pngsmart-locks
Thermostats APIGet started →thermostats-cover.pngthermostats
Noise Sensors APIGet started →sensors-16-9.pngnoise-sensors
Access Control Systems APIGet started →acs-cover.pngaccess-systems
+
Door Locks APIGet started →smart-locks-16-9.pngsmart-locks
Thermostats APIGet started →thermostats-cover.pngthermostats
Noise Sensors APIGet started →sensors-16-9.pngnoise-sensors
Access Control Systems APIGet started →acs-cover.pngaccess-systems
diff --git a/docs/guides/use-cases/granting-access/README.md b/docs/guides/use-cases/granting-access/README.md index 3fbbfc4a2..3569bd283 100644 --- a/docs/guides/use-cases/granting-access/README.md +++ b/docs/guides/use-cases/granting-access/README.md @@ -153,7 +153,7 @@ An Access Grant includes the following characteristics: The Access Grant process consists of the following steps: -
StepDescription
  1. Connect your devices or access system to Seam.
To connect your devices or access system to Seam, we recommend embedding a Connect Webview in your application. The Connect Webview flow guides the property manager through each step of the connection process.
For standalone smart locks, this is all the setup you need.
For on-premises access systems, use Seam Bridge to connect the access system securely to Seam. For details, see Connect an Access System to Seam.
  1. (Access systems only) Set up your site.
If you are granting access to access system entrances, confirm hardware capabilities and make sure that you have the required licenses. For example, if you plan to use mobile keys or Instant Keys, your lock hardware must support Bluetooth Low Energy (BLE) keys. Also, to use mobile keys with your access system, you may need to purchase licenses or subscriptions to activate certain software features. These requirements vary by access system. For details, see Setting Up Your Site for Instant Keys and the system integration guide for your access system.
  1. (Optional) Set up spaces to organize access points into logical groups.
You can use spaces to create groups of devices and entrances for efficiency. For example, a user staying in Room 101 may need access to the Room 101 door, the main entrance door, and the nearest elevator. You could create a space that includes these access points and then use this space when creating an Access Grant.
For details, see spaces.
  1. Create a user identity.
User identities represent your users—the people to whom you want to grant access. You can create a user identity before creating an Access Grant, or you can create a user identity as part of creating the Access Grant.
See Managing Mobile App User Accounts with User Identities.
  1. Create an Access Grant.
When you create an Access Grant, you specify the user identity to whom you want to grant access, the access schedule, the set of devices, entrances, or spaces, and one or more access methods that you want to request.
See Creating an Access Grant Using Devices, Creating an Access Grant Using Spaces, and Creating an Access Grant Using Entrances.
You can poll for access method status changes or watch for Access Grant and access method lifecycle events that alert you to next steps, such as how and when to deliver each created access method to your user.
  1. Deliver the access method to the user.

Once Seam alerts you that your access methods are ready, deliver them to your user. Delivery steps depend on the mode of access, such as PIN code, plastic key card, or mobile key.

  • If you have created an Access Grant that includes a code access method, retrieve the access method to get the PIN code and share it with your user.
  • If you have created an Access Grant that includes a card access method, you may need to encode the card using the Seam encoders API.
  • If you have created an Access Grant that includes a mobile key, you can use the Seam mobile SDKs to develop your mobile app that delivers these mobile keys to your users.
  • Each mobile key also includes an Instant Key URL. To share this Instant Key with your user, send it through text or email or embed it in your own app.

See Delivering Access Methods.

+
StepDescription
  1. Connect your devices or access system to Seam.
To connect your devices or access system to Seam, we recommend embedding a Connect Webview in your application. The Connect Webview flow guides the property manager through each step of the connection process.
For standalone smart locks, this is all the setup you need.
For on-premises access systems, use Seam Bridge to connect the access system securely to Seam. For details, see Connect an Access System to Seam.
  1. (Access systems only) Set up your site.
If you are granting access to access system entrances, confirm hardware capabilities and make sure that you have the required licenses. For example, if you plan to use mobile keys or Instant Keys, your lock hardware must support Bluetooth Low Energy (BLE) keys. Also, to use mobile keys with your access system, you may need to purchase licenses or subscriptions to activate certain software features. These requirements vary by access system. For details, see Setting Up Your Site for Instant Keys and the system integration guide for your access system.
  1. (Optional) Set up spaces to organize access points into logical groups.
You can use spaces to create groups of devices and entrances for efficiency. For example, a user staying in Room 101 may need access to the Room 101 door, the main entrance door, and the nearest elevator. You could create a space that includes these access points and then use this space when creating an Access Grant.
For details, see spaces.
  1. Create a user identity.
User identities represent your users—the people to whom you want to grant access. You can create a user identity before creating an Access Grant, or you can create a user identity as part of creating the Access Grant.
See Managing Mobile App User Accounts with User Identities.
  1. Create an Access Grant.
When you create an Access Grant, you specify the user identity to whom you want to grant access, the access schedule, the set of devices, entrances, or spaces, and one or more access methods that you want to request.
See Creating an Access Grant Using Devices, Creating an Access Grant Using Spaces, and Creating an Access Grant Using Entrances.
You can poll for access method status changes or watch for Access Grant and access method lifecycle events that alert you to next steps, such as how and when to deliver each created access method to your user.
  1. Deliver the access method to the user.

Once Seam alerts you that your access methods are ready, deliver them to your user. Delivery steps depend on the mode of access, such as PIN code, plastic key card, or mobile key.

  • If you have created an Access Grant that includes a code access method, retrieve the access method to get the PIN code and share it with your user.
  • If you have created an Access Grant that includes a card access method, you may need to encode the card using the Seam encoders API.
  • If you have created an Access Grant that includes a mobile key, you can use the Seam mobile SDKs to develop your mobile app that delivers these mobile keys to your users.
  • Each mobile key also includes an Instant Key URL. To share this Instant Key with your user, send it through text or email or embed it in your own app.

See Delivering Access Methods.

*** @@ -167,13 +167,13 @@ The Access Grant process consists of the following steps: | Grant a person access to ACS entrances | Access Grants (`acs_entrance_ids`) | | Grant a person access to a group of access points | Access Grants + [spaces](https://docs.seam.co/latest/api/spaces) (`space_ids`) | | Issue a mobile key or Instant Key | Access Grants (`mode: "mobile_key"`) | -| Set a PIN with a specific custom code value on a single lock | [Access Codes API](../../capability-guides/smart-locks/access-codes/README.md) (low-level) | -| Manage offline or backup PIN code pools on a single lock | [Access Codes API](../../capability-guides/smart-locks/access-codes/README.md) (low-level) | -| Directly manage ACS users, credentials, and access groups | [ACS API](../../capability-guides/access-systems/README.md) (low-level) | -| Lock or unlock a door remotely | [Smart Locks API](../../capability-guides/smart-locks/README.md) (not a granting workflow) | +| Set a PIN with a specific custom code value on a single lock | [Access Codes API](../../low-level-apis/smart-locks/access-codes/README.md) (low-level) | +| Manage offline or backup PIN code pools on a single lock | [Access Codes API](../../low-level-apis/smart-locks/access-codes/README.md) (low-level) | +| Directly manage ACS users, credentials, and access groups | [ACS API](../../low-level-apis/access-systems/README.md) (low-level) | +| Lock or unlock a door remotely | [Smart Locks API](../../low-level-apis/smart-locks/README.md) (not a granting workflow) | {% hint style="warning" %} -The low-level [Access Codes](../../capability-guides/smart-locks/access-codes/README.md) and [ACS](../../capability-guides/access-systems/README.md) granting workflows are no longer recommended for granting access. For new development, use Access Grants—they cover the same providers through one consistent, future-proof interface. +The low-level [Access Codes](../../low-level-apis/smart-locks/access-codes/README.md) and [ACS](../../low-level-apis/access-systems/README.md) granting workflows are no longer recommended for granting access. For new development, use Access Grants—they cover the same providers through one consistent, future-proof interface. {% endhint %} *** diff --git a/docs/guides/use-cases/granting-access/access-grant-quick-start.md b/docs/guides/use-cases/granting-access/access-grant-quick-start.md index db53155dc..1491d5491 100644 --- a/docs/guides/use-cases/granting-access/access-grant-quick-start.md +++ b/docs/guides/use-cases/granting-access/access-grant-quick-start.md @@ -28,7 +28,7 @@ Before you begin this quick start, perform the following steps: In this quick start, you can use a Seam virtual access system in a sandbox workspace, for example, the [virtual Salto Space access system](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/sandbox-salto-space-access-control-system). - For instructions, see [Connect an Access System to Seam](../../capability-guides/access-systems/connect-an-acs-to-seam/). + For instructions, see [Connect an Access System to Seam](../../low-level-apis/access-systems/connect-an-acs-to-seam/). 2. Install a Seam SDK and create an API key. For instructions, see [Installation](https://docs.seam.co/latest/api/installation) and [API Keys](../../core-concepts/authentication/api-keys.md). @@ -810,7 +810,7 @@ $seam->access_methods->get( The way in which you deliver an access method depends on the mode of access. The following table describes the delivery mechanisms: -
Access Method ModeDelivery Mechanism
PIN codeYou can retrieve the access method by ID. The returned access method resource includes the code that you can share with your user.
Plastic key cardSome access systems require you to encode plastic key cards. In this case, the access method's is_encoding_required property is true. You can use the Seam API or Seam Console to encode and scan the cards. For details, see Working with Card Encoders and Scanners.
Once you've encoded the card, the access method's is_encoding_required property changes to false, and its is_issued property changes to true. The card is ready to be delivered to your user.
Mobile keyYou deliver a mobile key to your user within your own mobile app that you develop using the Seam mobile SDKs. For mobile keys, the access method includes a client_session_token property that you can use to identify the client session and client session token that you need to initialize the Seam client on your user's mobile device. Then, your user simply taps a button in your app to unlock the door. For details, see Mobile Access.
Instant KeyEach mobile key that you create also includes an Instant Key. Seam Instant Keys are the most streamlined mobile access experience available today. Both the Access Grant and the mobile key access method include the instant_key_url property. You deliver this URL to your user by sending it through text or email. There's no app download required. You can also embed an Instant Key in your own app. For details, see Instant Keys and Delivering Instant Keys.
+
Access Method ModeDelivery Mechanism
PIN codeYou can retrieve the access method by ID. The returned access method resource includes the code that you can share with your user.
Plastic key cardSome access systems require you to encode plastic key cards. In this case, the access method's is_encoding_required property is true. You can use the Seam API or Seam Console to encode and scan the cards. For details, see Working with Card Encoders and Scanners.
Once you've encoded the card, the access method's is_encoding_required property changes to false, and its is_issued property changes to true. The card is ready to be delivered to your user.
Mobile keyYou deliver a mobile key to your user within your own mobile app that you develop using the Seam mobile SDKs. For mobile keys, the access method includes a client_session_token property that you can use to identify the client session and client session token that you need to initialize the Seam client on your user's mobile device. Then, your user simply taps a button in your app to unlock the door. For details, see Mobile Access.
Instant KeyEach mobile key that you create also includes an Instant Key. Seam Instant Keys are the most streamlined mobile access experience available today. Both the Access Grant and the mobile key access method include the instant_key_url property. You deliver this URL to your user by sending it through text or email. There's no app download required. You can also embed an Instant Key in your own app. For details, see Instant Keys and Delivering Instant Keys.
*** diff --git a/docs/guides/use-cases/granting-access/delivering-access-methods.md b/docs/guides/use-cases/granting-access/delivering-access-methods.md index b6991feb7..0c0b9fb3e 100644 --- a/docs/guides/use-cases/granting-access/delivering-access-methods.md +++ b/docs/guides/use-cases/granting-access/delivering-access-methods.md @@ -179,7 +179,7 @@ $seam->access_methods->get( ## Plastic Key Cards -Some access systems require you to encode plastic key cards. In this case, the access method's `is_encoding_required` property is `true`. You can use the Seam API or Seam Console to encode and scan the cards. For details, see [Working with Card Encoders and Scanners](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/). +Some access systems require you to encode plastic key cards. In this case, the access method's `is_encoding_required` property is `true`. You can use the Seam API or Seam Console to encode and scan the cards. For details, see [Working with Card Encoders and Scanners](../../low-level-apis/access-systems/working-with-card-encoders-and-scanners/). Once you've encoded the card, the access method's `is_encoding_required` property changes to `false`, and its `is_issued` property changes to `true`. The card is ready to be delivered to your user. diff --git a/docs/guides/use-cases/granting-access/updating-an-access-grant.md b/docs/guides/use-cases/granting-access/updating-an-access-grant.md index cc57bc89a..d80c075e1 100644 --- a/docs/guides/use-cases/granting-access/updating-an-access-grant.md +++ b/docs/guides/use-cases/granting-access/updating-an-access-grant.md @@ -127,7 +127,7 @@ $seam->access_grants->update( ## Updating Cards -If you update an Access Grant that includes a card access method, the `access_method.card_encoding_required` event indicates that you must [re-encode the card](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md) using the same access method. After you re-encode the card, Seam emits an `access_method.reissued` event. +If you update an Access Grant that includes a card access method, the `access_method.card_encoding_required` event indicates that you must [re-encode the card](../../low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md) using the same access method. After you re-encode the card, Seam emits an `access_method.reissued` event. You can also view the `is_encoding_required`, `is_issued`, and `issued_at` properties of the affected access method.