Programming Salto Space Card-based Credentials
Learn how to create plastic card-based credentials for Salto Space.
For each access system user in a Salto Space access system, you can create a maximum of one key card credential and one mobile key credential. For Salto Space, you create card credentials and then encode them onto plastic key cards for users.
To use the Seam API to create card credentials for a Salto Space access system:
Create an access system user.
Assign access permissions to the user by assigning them to one or more access groups.
Each access group is preconfigured with specific entrances.
Create a credential.
Specify the ID of the access system user.
Set the
access_method
tocard
.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.Consider the following situations:
To assign a first, new card to a user, set
salto_space_metadata.assign_new_key
totrue
.To replace a user's card—for example, if a user has lost their card—delete the user's previous credential and then create a new credential, setting
salto_space_metadata.assign_new_key
totrue
. Remember that a Salto Space user can only have one key card at a time.To update a user's card with changed access permissions, set
salto_space_metadata.assign_new_key
tofalse
. For example, this option is applicable if a user's access group assignment has changed or if the set of entrances for an access group has changed.
Encode the credential onto a card.
Make sure that each of your Salto Space sites is equipped with a supported card encoder. The NCoder card encoder is compatible with the Seam integration.
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.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.Confirm that the card was encoded successfully using polling or a webhook. See Confirm Successful Encoding. Also, see a list of common encoding errors.
The following example walks you through this process:
Code:
Output:
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.
Learn More
To find out more about using the Seam API with your Salto Space access system, see the following topics:
Access Systems in the Seam API reference
Last updated
Was this helpful?