Learn about managing access control systems, users, and credentials that enable you to control access to physical spaces.
Last updated
© Seam Labs, Inc. All rights reserved.
Seam provides a unified API across multiple brands of access control systems (ACSs) to grant and manage access to apartment buildings, hotels, commercial offices, warehouses, and much more. The Seam API standardizes key functions across systems and brands, such as creating users, issuing credentials (PIN codes, key cards, and mobile keys), managing access permissions, retrieving access logs, and more.
Access control systems enable you to manage and monitor access to physical spaces, such as offices, residential complexes, and special-purpose facilities. A key aspect of ACSs is that they centralize access authorization, which enables you to grant access to a user across multiple doors using a single credential.
An access control system generally manages the following permissions:
Who has access
The entrances to which they have access
The access schedule for each ACS user and entrance
The access mechanism—such as a PIN code, mobile key, or RFID card—for each ACS user and entrance
Seam enables you to grant ACS users access to entrances through digital credentials, including PIN codes, mobile keys, and RFID cards. The Seam API combines centralized access management and audit log capabilities with the flexibility to create credentials using the access methods that best suit your users' needs.
The Seam ACS schema consists of a series of resources. These resources interact intuitively, enabling you to manage your ACS in a logical, efficient manner. Seam's universal API provides the flexibility to manage a variety of ACSs, each of which may have manufacturer-specific differences. For details about your ACS, see the corresponding system integration guide.
The following diagram shows an example of one ACS, including the ACS resources and the relationships between them:
The following table provides a brief description of each of the Seam ACS resources:
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.
The set of users who access the entrances. For more information, see Managing ACS Users.
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.
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.
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.
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.
While there are some manufacturer-specific differences between ACSs, all ACSs share the following basic resources and relationships:
ACS users: You create ACS users to represent the users in a specific ACS.
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.
Access permissions: Access permissions define the allowed entrances and the days and times at which this access is valid. Depending on your ACS, you configure access permissions by assigning ACS users to access groups or by specifying access permissions for each ACS user or credential.
Credentials: Credentials serve as the mechanism that allows your ACS users to gain access to entrances. Examples of credentials that Seam supports include RFID cards, mobile keys, and PIN codes. You create credentials and assign these credentials to your ACS users.
If you are developing a mobile app to provide access for your ACS users, you can also use Seam's iOS and Android SDKs that pair with the Seam API to create and manage mobile keys.
To learn how to manage ACS components, see the following guides:
For the corresponding Seam API reference, see Access Control Systems.
