Encodable Key Card Quick Start

Create your first encodable key card credential to start controlling an access control system with Seam.

In this quick start, create an ACS user for a virtual ASSA ABLOY Visionline access control system. Then, grant the user access to an entrance using a encodable key card credential.

This quick start walks you through the process that applies specifically to the Visionline ACS. There are often differences between access control systems. For example, for some access control systems, you encode credentials onto cards. For others, you do not encode data onto cards, but, rather, assign cards to users.

Once you've completed this quick start, learn how to work with your ACS using Seam, by reading the system integration guide for your ACS.

Overview

This quick start walks you through the following basic steps:

1. Connect an access control system to Seam.

   • To get started quickly, use a virtual ACS in a sandbox workspace.

2. Install a Seam SDK and create an API key.

3. Create an ACS user.

4. Create an encodable key card ACS credential for the ACS user.

   This credential contains both the set of entrances to which the user has access and the access schedule for the user. While some access control systems specify allowed entrances directly within the credential, others use access groups. For more details, see Access Permission Assignment Variations.

5. View the following information about your successfully-created credential:

   • The list of entrances to which the ACS user now has access.

   • The access schedule for the credential.

6. Encode the credential onto a card.

   Some access control systems—including Visionline—require you to encode credentials onto key cards.

🚀 Let's get started!

---

Step 1: Connect a Virtual ACS

In this quick start, use Seam Console to connect a virtual ACS to your sandbox workspace. Alternately, you can use the Seam API to create a Connect Webview and then use it to connect an ACS to Seam.

1. Log in to Seam Console.
2. In the upper-left corner, click the workspace switcher and select or create a sandbox workspace.

   
3. In the top navigation pane, click ACS Systems.

   

   Click ACS Systems to go to the Access Systems page.
4. On the Access Systems page, click New Access System.

   Seam Console displays a Connect Webview that enables you to connect a virtual ACS to Seam.

5. In the Connect Webview, authorize the connection.

   1. Click Continue.

   2. In the device brand list, click Visionline.

   3. On the Set up your Seam Bridge page, click Continue.

      Seam Bridge 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 Visionline info page:

      1. In the Enter your pairing token field, type 123456 (or any six-character string).

      2. In the Name your bridge field, type My Network (or any unique string).

      3. 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.

      2. In the Username field, type jane.

      3. In the Password field, type 1234.

      4. Click Submit.

   6. Click Close.

   The Access Systems page now displays the newly-connected virtual Visionline access control system.

---

Step 2: Install a Seam SDK and Create an API Key

1. Download and install a Seam SDK in your favorite programming language.

JavaScript

npm i seam

Python

pip install seam
# For some development environments, use pip3 in this command instead of pip.

Ruby

bundle add seam

PHP

composer require seamapi/seam

Java

Gradle:

// build.gradle
dependencies {
    implementation 'io.github.seamapi:java:0.x.x'
}

Maven:

<!-- pom.xml -->
<dependency>
    <groupId>io.github.seamapi</groupId>
    <artifactId>java</artifactId>
    <version>0.x.x</version>
</dependency>

C#

Install using nuget.

Go

go get github.com/seamapi/go

1. Create an API key.

   1. In the top navigation pane of Seam Console, click Developer.
   2. In the left navigation pane, click API Keys.

   3. In the upper-right corner of the API Keys page, click Add API Key.

   4. In the Add API Key dialog, type a name for your new API key and then click Create API Key.

   5. Copy the newly-created API key and store it for future use.

2. Open a terminal window and export your API key as an environment variable.

   export SEAM_API_KEY=seam_test2bMS_94SrGUXuNR2JmJkjtvBQDg5c

   The Seam SDK that you have installed automatically uses this API key once you have exported it.

---

Step 3: Create an ACS User

Create an ACS user within the virtual Visionline access control system.

1. Find the ACS system ID.

   1. In the top navigation pane of Seam Console, click ACS Systems.
   2. On the Access Systems page, locate the Visionline ACS, for example, My Visionline Site.

   3. In the acs_system_id column for the Visionline ACS, click the ID to copy it.

   4. Store this ACS system ID for future use.

2. Create the ACS user, as follows:

Python

Code:

from seam import Seam

seam = Seam()  # Seam automatically uses your exported SEAM_API_KEY.

acs_user = seam.acs.users.create(
  full_name = "Jim Doe",
  # Use the ACS system ID that you copied earlier from Seam Console.
  acs_system_id = acs_system_id
)

Output:

AcsUser(
  acs_user_id='33333333-3333-3333-3333-333333333333',
  full_name='Jim Doe',
  ...
)

cURL (bash)

Code:

# Use the ACS system ID that you copied earlier from Seam Console.
acs_user=$(curl -X 'POST' \
  'https://connect.getseam.com/acs/users/create' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d "{
  \"full_name\": \"Jim Doe\",
  \"acs_system_id\": \"${acs_system_id}\"
}")

Output:

{
  "acs_user": {
    "acs_user_id": "33333333-3333-3333-3333-333333333333",
    "full_name": "Jim Doe",
    ...
  },
  "ok": true
}

JavaScript

Code:

import { Seam } from "seam";

const seam = new Seam(); // Seam automatically uses your exported SEAM_API_KEY.

const acsUser = await seam.acs.users.create({
  full_name: "Jim Doe",
  // Use the ACS system ID that you copied earlier from Seam Console.
  acs_system_id: acsSystemId
});

Output:

{
  acs_user_id: '33333333-3333-3333-3333-333333333333',
  full_name: 'Jim Doe',
  ...
}

Ruby

Code:

require "seam"

seam = Seam.new() # Seam automatically uses your exported SEAM_API_KEY.

acs_user = seam.acs.users.create(
  full_name: "Jim Doe",
  # Use the ACS system ID that you copied earlier from Seam Console.
  acs_system_id: acs_system_id
)

Output:

<Seam::Resources::AcsUser:0x005f0
  acs_user_id="33333333-3333-3333-3333-333333333333"
  full_name="Jim Doe"
  ...
>

PHP

Code:

<?php
require 'vendor/autoload.php';

$seam = new Seam\SeamClient(); // Seam automatically uses your exported SEAM_API_KEY.

$acs_user = $seam->acs->users->create(
  full_name: "Jim Doe",
  // Use the ACS system ID that you copied earlier from Seam Console.
  acs_system_id: $acs_system_id
);

Output:

{
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "full_name": "Jim Doe",
  ...
}

C#

Code:

// Coming soon!

Output:

// Coming soon!

Java

Code:

// Coming soon!

Output:

// Coming soon!

Go

Code:

package main

import (
  "context"
  "fmt"
  "os"
  "time"

  api "github.com/seamapi/go"
  seam "github.com/seamapi/go/client"
  acs "github.com/seamapi/go/acs"
)

func main() {
  if err := run(); err != nil {
    _, _ = fmt.Fprintln(os.Stderr, err.Error())
    os.Exit(1)
  }
}

func run() error {
  client := seam.NewClient(
    seam.WithApiKey(SEAM_API_KEY),
  )

  acsUser, err := client.Acs.Users.Create(
    context.Background(), &acs.UsersCreateRequest{
      FullName: api.String("Jim Doe"),
      // Use the ACS system ID that you copied earlier from Seam Console.
      AcsSystemId: acsSystemId,
    },
  )
  if err != nil {
    return err
  }
  
  return nil
}

Output:

{
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "full_name": "Jim Doe",
  ...
}

---

Step 4: Create an Encodable Key Card Credential

Create an encodable key card credential for the ACS user. In this credential, specify the set of allowed entrances and the access schedule. For Visionline, you must also specify some system-specific metadata, such as the card format and whether the credential is an override credential.

If this credential were intended for a real Visionline card, you'd need to create the credential and then encode this data onto the key card. Other access control systems do not use encodable cards, but, rather, assign cards to users.

1. Find the IDs of the allowed entrances.

   1. In the top navigation pane of Seam Console, click ACS Systems.
   2. On the Access Systems page, click the Visionline ACS, for example, My Visionline Site.

   3. On the Visionline ACS page, click the Entrances tab.

   4. Locate the Vingcard Lock 2 and Guest Lock 1 entrances.

      In this example, the set of entrances includes both a common entrance and a guest room door.

   5. For each of these entrances, click ..., click Copy Id, and then store this entrance ID for future use.

      

      Copy the IDs for the Vingcard Lock 2 and Guest Lock 1 entrances.
2. Create the key card credential, as follows:

Python

Code:

key_card_credential = seam.acs.credentials.create(
  acs_user_id = acs_user.acs_user_id,
  access_method = "card",
  allowed_acs_entrance_ids = [
    vingcard_lock_2_entrance_id,
    guest_lock_1_entrance_id
  ],
  starts_at = "2025-02-10T15:00:00.000Z",
  ends_at = "2025-02-12T11:00:00.000Z",
  visionline_metadata = {
    "card_format": "rfid48",
    "override": True
  }
)

Output:

AcsCredential(
  acs_credential_id='66666666-6666-6666-6666-666666666666',
  acs_user_id='33333333-3333-3333-3333-333333333333',
  access_method='card',
  starts_at='2025-02-10T15:00:00.000Z',
  ends_at='2025-02-12T11:00:00.000Z',
  ...
)

cURL (bash)

Code:

key_card_credential=$(curl -X 'POST' \
  'https://connect.getseam.com/acs/credentials/create' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d "{
  \"acs_user_id\": \"$(jq -r '.acs_user.acs_user_id' <<< ${acs_user})\",
  \"access_method\": \"card\",
  \"allowed_acs_entrance_ids\": [
    \"${vingcard_lock_2_entrance_id}\",
    \"${guest_lock_1_entrance_id}\"
  ],
  \"starts_at\": \"2025-02-10T15:00:00.000Z\",
  \"ends_at\": \"2025-02-12T11:00:00.000Z\",
  \"visionline_metadata\": {
     \"card_format\": \"rfid48\",
     \"override\": true
  }
}")

Output:

{
  "acs_credential":
    {
      "acs_credential_id": "66666666-6666-6666-6666-666666666666",
      "acs_user_id": "33333333-3333-3333-3333-333333333333",
      "access_method": "card",
      "starts_at": "2025-02-10T15:00:00.000Z",
      "ends_at": "2025-02-12T11:00:00.000Z",
      ...
    },
  "ok":true
}

JavaScript

Code:

const keyCardCredential = await seam.acs.credentials.create({
  acs_user_id: acsUser.acs_user_id,
  access_method: "card",
  allowed_acs_entrance_ids: [
    vingcardLock2EntranceId,
    guestLock1EntranceId
  ],
  starts_at: "2025-02-10T15:00:00.000Z",
  ends_at: "2025-02-12T11:00:00.000Z",
  visionline_metadata: {
    "card_format": "rfid48",
    "override": true
  }
});

Output:

{
  acs_credential_id: '66666666-6666-6666-6666-666666666666',
  acs_user_id: '33333333-3333-3333-3333-333333333333',
  access_method: 'card',
  starts_at: '2025-02-10T15:00:00.000Z',
  ends_at: '2025-02-12T11:00:00.000Z',
  ...
}

Ruby

Code:

key_card_credential = seam.acs.credentials.create(
  acs_user_id: acs_user.acs_user_id,
  access_method: "card",
  allowed_acs_entrance_ids: [
    vingcard_lock_2_entrance_id,
    guest_lock_1_entrance_id
  ],
  starts_at: "2025-02-10T15:00:00.000Z",
  ends_at: "2025-02-12T11:00:00.000Z",
  visionline_metadata: {
    "card_format": "rfid48",
    "override": true
  }
)

Output:

<Seam::Resources::AcsCredential:0x00410
  acs_credential_id="66666666-6666-6666-6666-666666666666"
  acs_user_id="33333333-3333-3333-3333-333333333333"
  access_method="card"
  starts_at="2025-02-10T15:00:00.000Z"
  ends_at="2025-02-12T11:00:00.000Z"
  ...
>

PHP

Code:

$key_card_credential = $seam->acs->credentials->create(
  acs_user_id: $acs_user->acs_user_id,
  access_method: "card",
  allowed_acs_entrance_ids: [
    $vingcard_lock_2_entrance_id,
    $guest_lock_1_entrance_id
  ],
  starts_at: "2025-02-10T15:00:00.000Z",
  ends_at: "2025-02-12T11:00:00.000Z",
  visionline_metadata: array('card_format' => "rfid48", 'is_override_key' => true)
);

Output:

{
  "acs_credential_id": "66666666-6666-6666-6666-666666666666",
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "access_method": "card",
  "starts_at": "2025-02-10T15:00:00.000Z",
  "ends_at": "2025-02-12T11:00:00.000Z",
  ...
}

C#

Code:

// Coming soon!

Output:

// Coming soon!

Java

Code:

// Coming soon!

Output:

// Coming soon!

Go

Code:

startsAt, err := time.Parse(time.RFC3339, "2025-02-10T15:00:00Z")
endsAt, err := time.Parse(time.RFC3339, "2025-02-12T11:00:00Z")
if err != nil {
  return err
}

keyCardCredential, err := client.Acs.Credentials.Create(
  context.Background(), &acs.CredentialsCreateRequest{
    AcsUserId: acsUser.AcsUserId,
    AccessMethod: "card",
    AllowedAcsEntranceIds: []string{
      vingcardLock2EntranceId,
      guestLock1EntranceId,
    },
    StartsAt: api.Time(startsAt),
    EndsAt: api.Time(endsAt),
    VisionlineMetadata: &acs.CredentialsCreateRequestVisionlineMetadata{
      CardFormat: acs.CredentialsCreateRequestVisionlineMetadataCardFormatRfid48.Ptr(),
      Override: api.Bool(true),
    },
  },
);
if err != nil {
  return err
};

fmt.Println(keyCardCredential)
return nil

Output:

{
  "acs_credential_id": "66666666-6666-6666-6666-666666666666",
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "access_method": "card",
  "starts_at": "2025-02-10T15:00:00Z",
  "ends_at": "2025-02-12T11:00:00Z",
  ...
}

---

Step 5: View Your New Credential

You can use Seam Console, the Seam API, or the Seam CLI to view the following information about your successfully-created credential:

• The list of entrances to which the ACS user now has access.

• The access schedule for the credential.

To use Seam Console to view information about your new key card credential:

1. In the top navigation pane of Seam Console, click ACS Systems.
2. On the Access Systems page, click the Visionline ACS, for example, My Visionline Site.

3. In the Users table, click Jim Doe, the ACS user that you created.

   

   Click the ACS user to view their credentials.
4. In the Credentials tab for the ACS user, view the following information for the key card credential that you created:

   1. Under the credential name, Seam Console displays the list of list of entrances to which the credential grants access.

   2. The Start and End fields for the credential show the access schedule.

      Note that Seam Console displays times adjusted to your local computer settings. That is, the times that you see in Seam Console are the times that you specified when creating the credential, adjusted to match your computer's time settings.

   

   View the entrances and access schedule for the credential that you created.

---

Step 6: Encode the Credential onto a Card

Encode the credential that you created onto a card for the Visionline access control system.

First, find the encoder that you want to use and note its ID. Then, encode the credential onto the card using the encoder that you identified. Finally, confirm that the card was encoded successfully.

For more information, see Working with Card Encoders and Scanners.

Python

Code:

# Get the encoder that you want to use.
encoder = seam.acs.encoders.list(
  acs_system_ids = [acs_system_id]
)[0]

# Encode the card.
encoding_action_attempt = seam.acs.encoders.encode_credential(
  acs_credential_id = key_card_credential.acs_credential_id,
  acs_encoder_id = encoder.acs_encoder_id
)

# Confirm that the encoding succeeded by 
# polling the returned action attempt
# until its status is success.
# You can also use a webhook.
seam.action_attempts.get(
  action_attempt_id = encoding_action_attempt.action_attempt_id
)

Output:

ActionAttempt(
  status='success',
  action_attempt_id='11111111-2222-3333-4444-555555555555',
  action_type='ENCODE_CREDENTIAL',
  result={
    acs_credential_id='66666666-6666-6666-6666-666666666666',
    card_number='1234abc',
    is_issued=True,
    issued_at='2025-02-10T12:00:00.000Z',
    ...
  },
  error=null
)

cURL (bash)

Code:

# Get the encoder that you want to use.
encoder=$(curl -X 'POST' \
  'https://connect.getseam.com/acs/encoders/list' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d "{
  \"acs_system_id\": \"${acs_system_id}\"
}" | jq -r '.acs_encoders[0]')

# Encode the card.
encoding_action_attempt=$(curl -X 'POST' \
  'https://connect.getseam.com/acs/encoders/encode_credential' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d "{
  \"acs_credential_id\": \"$(jq -r '.acs_credential.acs_credential_id' <<< ${key_card_credential})\",
  \"acs_encoder_id\": \"$(jq -r '.acs_encoder_id' <<< ${encoder})\"
}")

# Confirm that the encoding succeeded by 
# polling the returned action attempt
# until its status is success.
# You can also use a webhook.
curl -X 'POST' \
  'https://connect.getseam.com/action_attempts/get' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d "{
  \"action_attempt_id\": \"$(jq -r '.action_attempt.action_attempt_id' <<< ${encoding_action_attempt})\"
}"

Output:

{
  "action_attempt":
    {
      "status": "success",
      "action_attempt_id": "11111111-2222-3333-4444-555555555555",
      "action_type": "ENCODE_CREDENTIAL",
      "result": {
        "acs_credential_id": "66666666-6666-6666-6666-666666666666",
        "card_number": "1234abc",
        "is_issued": true,
        "issued_at": "2025-02-10T12:00:00.000Z",
        ...
      },
      "error": null
    },
  "ok": true
}

JavaScript

Code:

// Get the encoder that you want to use.
const encoder = (await seam.acs.encoders.list({
  acs_system_ids = [acsSystemId]
}))[0];

// Encode the card.
const encodingActionAttempt = await seam.acs.encoders.encodeCredential({
  acs_credential_id: keyCardCredential.acs_credential_id,
  acs_encoder_id: encoder.acs_encoder_id
});

// Confirm that the encoding succeeded by 
// polling the returned action attempt
// until its status is success.
// You can also use a webhook.
await seam.actionAttempts.get({
  action_attempt_id: encodingActionAttempt.action_attempt_id
});

Output:

{
  status: 'success',
  action_attempt_id: '11111111-2222-3333-4444-555555555555",
  action_type: 'ENCODE_CREDENTIAL',
  result: {
    acs_credential_id: "66666666-6666-6666-6666-666666666666',
    card_number: '1234abc',
    is_issued: true,
    issued_at: '2025-02-10T12:00:00.000Z',
    ...
  },
  error: null
}

Ruby

Code:

# Get the encoder that you want to use.
encoder = (seam.acs.encoders.list(
  acs_system_ids = [acs_system_id]
))[0]

# Encode the card.
encoding_action_attempt = seam.acs.encoders.encode_credential(
  acs_credential_id: key_card_credential.acs_credential_id,
  acs_encoder_id: encoder.acs_encoder_id
)

# Confirm that the encoding succeeded by 
# polling the returned action attempt
# until its status is success.
# You can also use a webhook.
seam.action_attempts.get(
  action_attempt_id: encoding_action_attempt.action_attempt_id
)

Output:

<Seam::Resources::ActionAttempt:0x00410
  status="success"
  action_attempt_id="11111111-2222-3333-4444-555555555555"
  action_type="ENCODE_CREDENTIAL"
  result={
    acs_credential_id="66666666-6666-6666-6666-666666666666"
    card_number="1234abc"
    is_issued=true,
    issued_at="2025-02-10T12:00:00.000Z"
    ...
  }
  error=nil
>

PHP

Code:

// Get the encoder that you want to use.
$encoder = $seam->acs->encoders->list(
  acs_system_ids = [$acs_system_id]
)[0];

// Encode the card.
$encoding_action_attempt = $seam->acs->encoders->encode_credential(
  acs_credential_id: $key_card_credential->acs_credential_id,
  acs_encoder_id: $encoder->acs_encoder_id
);

// Confirm that the encoding succeeded by 
// polling the returned action attempt
// until its status is success.
// You can also use a webhook.
$seam->action_attempts->get(
  action_attempt_id: $encoding_action_attempt->action_attempt_id
);

Output:

{
  "status": "success",
  "action_attempt_id": "11111111-2222-3333-4444-555555555555",
  "action_type": "ENCODE_CREDENTIAL",
  "result": {
    "acs_credential_id": "66666666-6666-6666-6666-666666666666",
    "card_number": "1234abc",
    "is_issued": true,
    "issued_at": "2025-02-10T12:00:00.000Z",
    ...
  },
  "error": null
}

C#

Code:

// Coming soon!

Output:

// Coming soon!

Java

Code:

// Coming soon!

Output:

// Coming soon!

Go

Code:

// Get the encoder that you want to use.
encoders, err := client.Acs.Encoders.List(
  context.Background(), &acs.EncodersListRequest{
    AcsSystemIds: []string{
      acsSystemId,
    },
  },
)
if err != nil {
  return err
}
encoder := encoders[0]

// Encode the card.
encodingActionAttempt, err := client.Acs.Encoders.EncodeCredential(
  context.Background(), &acs.EncodersEncodeCredentialRequest{
    AcsCredentialId: keyCardCredential.AcsCredentialId,
    AcsEncoderId: encoder.AcsEncoderId,
  },
)
if err != nil {
  return err
}

// Confirm that the encoding succeeded by 
// polling the returned action attempt
// until its status is success.
// You can also use a webhook.
actionAttempt, err := client.ActionAttempts.Get(
  context.Background(), &api.ActionAttemptsGetRequest{
    ActionAttemptId: encodingActionAttempt.ActionAttemptId,
  },
)
if err != nil {
  return err
}

fmt.Println(actionAttempt)

return nil

Output:

{
  "status": "success",
  "action_attempt_id": "11111111-2222-3333-4444-555555555555",
  "action_type": "ENCODE_CREDENTIAL",
  "result": {
    "acs_credential_id": "66666666-6666-6666-6666-666666666666",
    "card_number": "1234abc",
    "is_issued": true,
    "issued_at": "2025-02-10T12:00:00.000Z",
    ...
  },
  "error": null
}

---

Next Steps

Now that you've created a key card credential and encoded it onto a card, try out the other ACS quick starts.

• Mobile Key Quick Start
• PIN Code Quick Start

Then, connect your ACS to Seam.

---

Learn More

For a deeper dive into ACS concepts and instructions, see the following topics:

1. Learn about ACS concepts.

   • Access Control System Resources
   • Understanding ACS Differences
2. Create ACS users.

   • Managing ACS Users
3. For relevant access control systems, assign ACS users to access groups.

   • Assigning ACS Users to Access Groups
4. Learn about available entrances.

   • Retrieving Entrance Details
5. Create credentials for ACS users.

   • Managing Credentials
6. For relevant access control systems, encode credentials onto key cards.

   • Working with Card Encoders and Scanners
7. See the Seam Access Control Systems API reference.