Skip to content

Commit 9aa6fc6

Browse files
sybohyclaude
andcommitted
feat: move Smart Locks and ACS sections under Low-Level APIs
Per review, relocate the entire Smart Locks and Access Control Systems capability sections to a new "Low-Level APIs" group at the bottom of the nav. Both trees keep their original internal structure (access codes under Smart Locks, credential management under ACS) — no extra nesting level. - Warning banners on both section overviews: low-level APIs; use Access Grants for granting; discuss other use cases with the Seam team (no deprecation commitment) - Pointer hints on the granting-relevant sub-pages (access codes, managing credentials, ACS quick starts, ACS user management) - .gitbook.yaml redirects for all 38 moved pages, plus retargeted pre-existing redirects that pointed into the moved trees - Repo-wide link updates; cross-section relative links fixed by depth Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 65b927e commit 9aa6fc6

113 files changed

Lines changed: 373 additions & 308 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitbook.yaml

Lines changed: 43 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ redirects:
1515
core-concepts/workspaces/personal-access-tokens: core-concepts/authentication/personal-access-tokens.md
1616
core-concepts/workspaces/client-session-tokens: core-concepts/authentication/client-session-tokens/README.md
1717
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
18-
products/access-systems/user-management: capability-guides/access-systems/user-management.md
19-
capability-guides/access-systems/managing-credentials: capability-guides/access-systems/managing-credentials.md
20-
capability-guides/access-systems/assigning-credentials-to-users: capability-guides/access-systems/managing-credentials/assigning-credentials-to-users.md
21-
products/access-systems/suspending-and-unsuspending-users: capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md
18+
products/access-systems/user-management: low-level-apis/access-systems/user-management.md
19+
capability-guides/access-systems/managing-credentials: low-level-apis/access-systems/managing-credentials.md
20+
capability-guides/access-systems/assigning-credentials-to-users: low-level-apis/access-systems/managing-credentials/assigning-credentials-to-users.md
21+
products/access-systems/suspending-and-unsuspending-users: low-level-apis/access-systems/user-management/suspending-and-unsuspending-users.md
2222
products/seam-bridge-in-development: capability-guides/seam-bridge.md
2323
core-concepts/connect-webviews: core-concepts/connect-webviews/README.md
24-
capability-guides/access-systems/understanding-acs-differences: capability-guides/access-systems/README.md
24+
capability-guides/access-systems/understanding-acs-differences: low-level-apis/access-systems/README.md
2525
capability-guides/thermostats/creating-and-managing-climate-schedules: capability-guides/thermostats/creating-and-managing-thermostat-schedules.md
2626
capability-guides/access-grants: use-cases/granting-access/README.md
2727
capability-guides/access-grants/access-grant-quick-start: use-cases/granting-access/access-grant-quick-start.md
@@ -33,3 +33,41 @@ redirects:
3333
capability-guides/access-grants/updating-an-access-grant: use-cases/granting-access/updating-an-access-grant.md
3434
capability-guides/access-grants/revoking-an-access-method: use-cases/granting-access/revoking-an-access-method.md
3535
capability-guides/access-grants/deleting-an-access-grant: use-cases/granting-access/deleting-an-access-grant.md
36+
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
37+
capability-guides/access-systems/acs-quick-starts/mobile-key-quick-start: low-level-apis/access-systems/acs-quick-starts/mobile-key-quick-start.md
38+
capability-guides/access-systems/acs-quick-starts/pin-code-quick-start: low-level-apis/access-systems/acs-quick-starts/pin-code-quick-start.md
39+
capability-guides/access-systems/acs-quick-starts: low-level-apis/access-systems/acs-quick-starts/README.md
40+
capability-guides/access-systems/connect-an-acs-to-seam: low-level-apis/access-systems/connect-an-acs-to-seam/README.md
41+
capability-guides/access-systems/managing-credentials/assigning-credentials-to-users: low-level-apis/access-systems/managing-credentials/assigning-credentials-to-users.md
42+
capability-guides/access-systems/managing-credentials/listing-credentials-and-associated-entrances: low-level-apis/access-systems/managing-credentials/listing-credentials-and-associated-entrances.md
43+
capability-guides/access-systems/retrieving-entrance-details: low-level-apis/access-systems/retrieving-entrance-details.md
44+
capability-guides/access-systems/troubleshooting-your-access-control-system: low-level-apis/access-systems/troubleshooting-your-access-control-system.md
45+
capability-guides/access-systems/user-management/assigning-users-to-access-groups: low-level-apis/access-systems/user-management/assigning-users-to-access-groups.md
46+
capability-guides/access-systems/user-management/suspending-and-unsuspending-users: low-level-apis/access-systems/user-management/suspending-and-unsuspending-users.md
47+
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
48+
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
49+
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
50+
capability-guides/smart-locks/access-codes/accommodating-manufacturer-mobile-apps: low-level-apis/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md
51+
capability-guides/smart-locks/access-codes/backup-access-codes: low-level-apis/smart-locks/access-codes/backup-access-codes.md
52+
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
53+
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
54+
capability-guides/smart-locks/access-codes/deleting-access-codes: low-level-apis/smart-locks/access-codes/deleting-access-codes.md
55+
capability-guides/smart-locks/access-codes/lifecycle-of-access-codes: low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes.md
56+
capability-guides/smart-locks/access-codes/migrating-existing-access-codes: low-level-apis/smart-locks/access-codes/migrating-existing-access-codes.md
57+
capability-guides/smart-locks/access-codes/modifying-access-codes: low-level-apis/smart-locks/access-codes/modifying-access-codes.md
58+
capability-guides/smart-locks/access-codes/retrieving-access-codes: low-level-apis/smart-locks/access-codes/retrieving-access-codes.md
59+
capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues: low-level-apis/smart-locks/access-codes/troubleshooting-access-code-issues.md
60+
capability-guides/smart-locks/access-codes: low-level-apis/smart-locks/access-codes/README.md
61+
capability-guides/smart-locks/lock-and-unlock: low-level-apis/smart-locks/lock-and-unlock.md
62+
capability-guides/smart-locks: low-level-apis/smart-locks/README.md
63+
64+
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
65+
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
66+
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
67+
capability-guides/access-systems/user-management: low-level-apis/access-systems/user-management.md
68+
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
69+
capability-guides/access-systems/working-with-card-encoders-and-scanners: low-level-apis/access-systems/working-with-card-encoders-and-scanners/README.md
70+
capability-guides/access-systems: low-level-apis/access-systems/README.md
71+
capability-guides/smart-locks/access-codes/creating-access-codes: low-level-apis/smart-locks/access-codes/creating-access-codes/README.md
72+
capability-guides/smart-locks/access-codes/offline-access-codes: low-level-apis/smart-locks/access-codes/offline-access-codes.md
73+
capability-guides/smart-locks/get-started-with-smartlocks-api: low-level-apis/smart-locks/get-started-with-smartlocks-api.md

docs/brand-guides/2n-intercom-systems/get-started-with-2n-intercoms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ $seam->locks->lock_door($lock->device_id);
387387

388388
2N devices have a directory with residents. These residents can be assigned PIN codes to unlock the door.
389389

390-
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.
390+
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.
391391

392392
{% tabs %}
393393
{% tab title="JavaScript" %}

docs/brand-guides/33-lock-devices/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ For detailed information about the 33 Lock devices that Seam supports, see our [
2222

2323
We support the following features:
2424

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

2828
***
2929

docs/brand-guides/33-lock-devices/get-started-with-33-lock-devices.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -693,7 +693,7 @@ True
693693

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

696-
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.
696+
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.
697697

698698
Try out the following actions on your 33 Lock device:
699699

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

10111011
### Program access codes on your lock
10121012

1013-
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.
1013+
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.
10141014

1015-
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.
1015+
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.
10161016

10171017
{% tabs %}
10181018
{% tab title="JavaScript" %}
@@ -1400,7 +1400,7 @@ Now that you've completed this getting started guide for 33 Lock devices, you ca
14001400
* [ ] **Use webhooks**\
14011401
Learn how to use [webhooks](https://docs.seam.co/latest/developer-tools/webhooks) as an efficient way to receive device events.
14021402
* [ ] **Find out more**\
1403-
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).
1403+
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).
14041404
* [ ] **Develop for mobile access**\
14051405
Learn about Seam's [mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access).
14061406

docs/brand-guides/4suites-locks/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ For detailed information about the 4SUITES devices that Seam supports, see our [
2424

2525
We support the following features:
2626

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

3030
***
3131

docs/brand-guides/4suites-locks/get-started-with-4suites-locks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -675,7 +675,7 @@ True
675675

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

678-
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.
678+
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.
679679

680680
Try out the following actions on your 4SUITES lock:
681681

@@ -1018,7 +1018,7 @@ Now that you've completed this getting started guide for 4SUITES devices, you ca
10181018
* [ ] **Use webhooks**\
10191019
Learn how to use [webhooks](https://docs.seam.co/latest/developer-tools/webhooks) as an efficient way to receive device events.
10201020
* [ ] **Find out more**\
1021-
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).
1021+
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).
10221022
* [ ] **Develop for mobile access**\
10231023
Learn about Seam's [mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access).
10241024

docs/brand-guides/akiles-locks/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ For detailed information about the Akiles devices that Seam supports, see our [A
2626

2727
We support the following features:
2828

29-
* [Triggering web unlock actions](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock)
30-
* [Programming access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on devices that have an integrated keypad or Akiles Pinpad
29+
* [Triggering web unlock actions](https://docs.seam.co/latest/low-level-apis/smart-locks/lock-and-unlock)
30+
* [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
3131

3232
***
3333

0 commit comments

Comments
 (0)