feat: merge access grant pages & add access method guides

.gitbook.yaml

@@ -25,8 +25,11 @@ redirects:
   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
-  capability-guides/access-grants/creating-an-access-grant-using-entrances: use-cases/granting-access/creating-an-access-grant-using-entrances.md
-  capability-guides/access-grants/creating-an-access-grant-using-spaces: use-cases/granting-access/creating-an-access-grant-using-spaces.md
+  capability-guides/access-grants/creating-an-access-grant-using-entrances: use-cases/granting-access/creating-an-access-grant.md
+  capability-guides/access-grants/creating-an-access-grant-using-spaces: use-cases/granting-access/creating-an-access-grant.md
+  use-cases/granting-access/creating-an-access-grant-using-devices: use-cases/granting-access/creating-an-access-grant.md
+  use-cases/granting-access/creating-an-access-grant-using-spaces: use-cases/granting-access/creating-an-access-grant.md
+  use-cases/granting-access/creating-an-access-grant-using-entrances: use-cases/granting-access/creating-an-access-grant.md
   capability-guides/access-grants/delivering-access-methods: use-cases/granting-access/delivering-access-methods.md
   capability-guides/access-grants/reservation-access-grants: use-cases/granting-access/reservation-access-grants.md
   capability-guides/access-grants/retrieving-access-grants-and-access-methods: use-cases/granting-access/retrieving-access-grants-and-access-methods.md

docs/guides/SUMMARY.md

@@ -8,10 +8,12 @@
 
 * [Granting Access](use-cases/granting-access/README.md)
   * [Access Grant Quick Start](use-cases/granting-access/access-grant-quick-start.md)
-  * [Creating an Access Grant Using Devices](use-cases/granting-access/creating-an-access-grant-using-devices.md)
-  * [Creating an Access Grant Using Spaces](use-cases/granting-access/creating-an-access-grant-using-spaces.md)
-  * [Creating an Access Grant Using Entrances](use-cases/granting-access/creating-an-access-grant-using-entrances.md)
+  * [Creating an Access Grant](use-cases/granting-access/creating-an-access-grant.md)
   * [Delivering Access Methods](use-cases/granting-access/delivering-access-methods.md)
+  * [Using PIN Codes](use-cases/granting-access/using-pin-codes.md)
+  * [Using Mobile Keys](use-cases/granting-access/using-mobile-keys.md)
+  * [Using Instant Keys](use-cases/granting-access/using-instant-keys.md)
+  * [Using Key Cards](use-cases/granting-access/using-key-cards.md)
   * [Using Cloud Keys](use-cases/granting-access/using-cloud-keys.md)
   * [Reservation Access Grants](use-cases/granting-access/reservation-access-grants.md)
   * [Retrieving Access Grants and Access Methods](use-cases/granting-access/retrieving-access-grants-and-access-methods.md)

docs/guides/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md

@@ -30,7 +30,7 @@ Once you have written an access method to a card, you cannot reuse the access me
 
 This example shows how to create a card access method as part of an Access Grant. Note that the `is_encoding_required` property of the resulting access method is `true`, which means that the access method must be encoded onto a card. Further, once you've encoded the access method on to the card, the `is_issued` property changes to `true`, and the `issued_at` property indicates the date and time at which the encoding occurred.
 
-For more details about creating Access Grants, see [Creating an Access Grant Using Entrances](../../../use-cases/granting-access/creating-an-access-grant-using-entrances.md) and [Creating an Access Grant Using Spaces](../../../use-cases/granting-access/creating-an-access-grant-using-spaces.md).
+For more details about creating Access Grants, see [Creating an Access Grant](../../../use-cases/granting-access/creating-an-access-grant.md).
 
 {% tabs %}
 {% tab title="JavaScript" %}

docs/guides/quickstart.md

@@ -383,7 +383,7 @@ Here are some ideas of what you can do next...
 
 ### Go Deeper on Granting Access
 
-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 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.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](low-level-apis/smart-locks/lock-and-unlock.md) remotely.
 

docs/guides/use-cases/granting-access/README.md

@@ -135,9 +135,9 @@ Access Grants work across the entire Seam provider lineup:
 
 We recommend learning Access Grants in three steps, from the simplest setup to the most advanced:
 
-1. **One device.** Connect a smart lock and create an Access Grant with a single `device_id` and a `code` access method. See [Creating an Access Grant Using Devices](creating-an-access-grant-using-devices.md).
-2. **Multiple devices and spaces.** Pass several `device_ids` in one call to grant access to a set of locks at once. To manage groups of access points by name—for example, everything a guest in Unit 101 needs—organize them into [spaces](creating-an-access-grant-using-spaces.md) and grant access by `space_id`.
-3. **Access control systems.** Connect an ACS, such as Salto, Visionline, or Brivo, and grant access to entrances with `acs_entrance_ids`. This path can involve additional setup, such as licenses, on-premises connections through Seam Bridge, mobile key configuration, and [reservations](reservation-access-grants.md) for offline-override systems. See [Creating an Access Grant Using Entrances](creating-an-access-grant-using-entrances.md).
+1. **One device.** Connect a smart lock and create an Access Grant with a single `device_id` and a `code` access method. See [Creating an Access Grant](creating-an-access-grant.md#using-device-ids).
+2. **Multiple devices and spaces.** Pass several `device_ids` in one call to grant access to a set of locks at once. To manage groups of access points by name—for example, everything a guest in Unit 101 needs—organize them into [spaces](creating-an-access-grant.md#using-space-ids) and grant access by `space_id`.
+3. **Access control systems.** Connect an ACS, such as Salto, Visionline, or Brivo, and grant access to entrances with `acs_entrance_ids`. This path can involve additional setup, such as licenses, on-premises connections through Seam Bridge, mobile key configuration, and [reservations](reservation-access-grants.md) for offline-override systems. See [Creating an Access Grant](creating-an-access-grant.md#using-entrance-ids).
 
 ***
 
@@ -153,7 +153,7 @@ An Access Grant includes the following characteristics:
 
 The Access Grant process consists of the following steps:
 
-<table><thead><tr><th width="198.800048828125">Step</th><th>Description</th></tr></thead><tbody><tr><td><ol><li>Connect your devices or access system to Seam.</li></ol></td><td>To connect your devices or access system to Seam, we recommend embedding a <a href="../../core-concepts/connect-webviews/README.md">Connect Webview</a> in your application. The Connect Webview flow guides the property manager through each step of the connection process.<br>For standalone smart locks, this is all the setup you need.<br>For on-premises access systems, use Seam Bridge to connect the access system securely to Seam. For details, see <a href="../../low-level-apis/access-systems/connect-an-acs-to-seam/README.md">Connect an Access System to Seam</a>.</td></tr><tr><td><ol start="2"><li>(Access systems only) Set up your site.</li></ol></td><td>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 <a href="../../capability-guides/instant-keys/setting-up-your-site-for-instant-keys.md">Setting Up Your Site for Instant Keys</a> and the <a href="https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems">system integration guide</a> for your access system.</td></tr><tr><td><ol start="3"><li>(Optional) Set up spaces to organize access points into logical groups.</li></ol></td><td>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.<br>For details, see <a href="https://docs.seam.co/latest/api/spaces">spaces</a>.</td></tr><tr><td><ol start="4"><li>Create a user identity.</li></ol></td><td>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.<br>See <a href="../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity">Managing Mobile App User Accounts with User Identities</a>.</td></tr><tr><td><ol start="5"><li>Create an Access Grant.</li></ol></td><td>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.<br>See <a href="creating-an-access-grant-using-devices.md">Creating an Access Grant Using Devices</a>, <a href="creating-an-access-grant-using-spaces.md">Creating an Access Grant Using Spaces</a>, and <a href="creating-an-access-grant-using-entrances.md">Creating an Access Grant Using Entrances</a>.<br>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.</td></tr><tr><td><ol start="6"><li>Deliver the access method to the user.</li></ol></td><td><p>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.</p><ul><li>If you have created an Access Grant that includes a <code>code</code> access method, retrieve the access method to get the PIN code and share it with your user.</li><li>If you have created an Access Grant that includes a <code>card</code> access method, you may need to encode the card using the Seam encoders API.</li><li>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.</li><li>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.</li></ul><p>See <a href="delivering-access-methods.md">Delivering Access Methods</a>.</p></td></tr></tbody></table>
+<table><thead><tr><th width="198.800048828125">Step</th><th>Description</th></tr></thead><tbody><tr><td><ol><li>Connect your devices or access system to Seam.</li></ol></td><td>To connect your devices or access system to Seam, we recommend embedding a <a href="../../core-concepts/connect-webviews/README.md">Connect Webview</a> in your application. The Connect Webview flow guides the property manager through each step of the connection process.<br>For standalone smart locks, this is all the setup you need.<br>For on-premises access systems, use Seam Bridge to connect the access system securely to Seam. For details, see <a href="../../low-level-apis/access-systems/connect-an-acs-to-seam/README.md">Connect an Access System to Seam</a>.</td></tr><tr><td><ol start="2"><li>(Access systems only) Set up your site.</li></ol></td><td>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 <a href="../../capability-guides/instant-keys/setting-up-your-site-for-instant-keys.md">Setting Up Your Site for Instant Keys</a> and the <a href="https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems">system integration guide</a> for your access system.</td></tr><tr><td><ol start="3"><li>(Optional) Set up spaces to organize access points into logical groups.</li></ol></td><td>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.<br>For details, see <a href="https://docs.seam.co/latest/api/spaces">spaces</a>.</td></tr><tr><td><ol start="4"><li>Create a user identity.</li></ol></td><td>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.<br>See <a href="../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity">Managing Mobile App User Accounts with User Identities</a>.</td></tr><tr><td><ol start="5"><li>Create an Access Grant.</li></ol></td><td>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.<br>See <a href="creating-an-access-grant.md">Creating an Access Grant</a>.<br>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.</td></tr><tr><td><ol start="6"><li>Deliver the access method to the user.</li></ol></td><td><p>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.</p><ul><li>If you have created an Access Grant that includes a <code>code</code> access method, retrieve the access method to get the PIN code and share it with your user.</li><li>If you have created an Access Grant that includes a <code>card</code> access method, you may need to encode the card using the Seam encoders API.</li><li>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.</li><li>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.</li></ul><p>See <a href="delivering-access-methods.md">Delivering Access Methods</a>.</p></td></tr></tbody></table>
 
 ***
 
@@ -192,9 +192,7 @@ When issuing Access Grants for these systems, you’ll need to use reservations
 
 To create your first Access Grant, see the [Access Grant Quick Start](access-grant-quick-start.md). Then, learn more in the following topics:
 
-* [Creating an Access Grant Using Devices](creating-an-access-grant-using-devices.md)
-* [Creating an Access Grant Using Spaces](creating-an-access-grant-using-spaces.md)
-* [Creating an Access Grant Using Entrances](creating-an-access-grant-using-entrances.md)
+* [Creating an Access Grant](creating-an-access-grant.md)
 * [Delivering Access Methods](delivering-access-methods.md)
 * [Access Grants API Reference](https://docs.seam.co/latest/api/access_grants/)
 * [Access Methods API Reference](https://docs.seam.co/latest/api/access_methods/)

docs/guides/use-cases/granting-access/access-grant-quick-start.md

@@ -9,7 +9,7 @@ description: >-
 In this quick start, create an Access Grant to give a user access to a set of access points. Access Grants are the default and recommended way to grant access to any physical space, irrespective of the locking hardware—standalone smart locks, access control systems, or a mix of both. With a single command you can define the "who, where, when, and how" for assigning a user access.
 
 {% hint style="success" %}
-**Starting with a standalone smart lock?** The fastest first success is a single device and a PIN code: see the [Seam Quick Start](../../quickstart.md), which creates an Access Grant on a sandbox August lock, or [Creating an Access Grant Using Devices](creating-an-access-grant-using-devices.md). This quick start walks through the more advanced access system (ACS) path, including key cards, mobile keys, and Instant Keys.
+**Starting with a standalone smart lock?** The fastest first success is a single device and a PIN code: see the [Seam Quick Start](../../quickstart.md), which creates an Access Grant on a sandbox August lock, or [Creating an Access Grant](creating-an-access-grant.md#using-device-ids). This quick start walks through the more advanced access system (ACS) path, including key cards, mobile keys, and Instant Keys.
 {% endhint %}
 
 In addition, this quick start shows you that, with Access Grants, it's easy to issue users access through multiple types of access methods, such as key cards, PIN codes, mobile keys, and Instant Keys.
@@ -818,8 +818,7 @@ The way in which you deliver an access method depends on the mode of access. The
 
 Now that you've created your first Access Grant, learn more about Access Grants.
 
-* [Creating an Access Grant Using Entrances](creating-an-access-grant-using-entrances.md)
-* [Creating an Access Grant Using Spaces](creating-an-access-grant-using-spaces.md)
+* [Creating an Access Grant](creating-an-access-grant.md)
 * [Delivering Access Methods](delivering-access-methods.md)
 * [Access Grants API Reference](https://docs.seam.co/latest/api/access_grants/)
 * [Access Methods API Reference](https://docs.seam.co/latest/api/access_methods/)