Get started with dormakaba Oracode Locks

Overview

Seam provides a universal API to connect and control many brands of locks. This guide provides a rapid introduction to connecting and controlling your dormakaba Oracode locks using the Seam API. To learn more about other device brands supported by the Seam API, such as Yale, Schlage, and August, head over to our integration page. Note that dormakaba offers multiple lines of products, including Lyazon, Sapphire, Oracode, and more. This guide is specifically for dormakaba Oracode.

1 — Install the Seam SDK

Seam provides client libraries for many languages, such as JavaScript, Python, Ruby, PHP, and others, as well as a Postman collection and OpenAPI spec.

JavaScript / TypeScript (npm, GitHub)
Python (pip, GitHub)
Ruby Gem (rubygem, GitHub)
PHP (packagist, GitHub)
Java (GitHub)
C# (nuget, GitHub)
Go (GitHub)

JavaScript
Python
Ruby
PHP
C#

npm i seam

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

bundle add seam

composer require seamapi/seam

Once installed, sign-up for Seam to get your API key, and export it as an environment variable:

$ export SEAM_API_KEY=seam_test2ZTo_0mEYQW2TvNDCxG5Atpj85Ffw

This guide uses a sandbox workspace. You can only connect virtual devices to a sandbox workspace. If you need to connect real Oracode devices, use a non-sandbox workspace and API key.

2 — Link Your dormakaba Oracode Account with Seam

To control your dormakaba Oracode locks using the Seam API, the owner or manager of these locks must first authorize your Seam workspace to access their dormakaba Oracode account. To do so, Seam provides Connect Webviews, which are pre-built UX flows that walk the device owner or manager through authorizing your application to control Oracode locks.

This guide discusses using a Seam sandbox workspace with virtual devices. However, to connect real devices to Seam, some manufacturers may require additional prerequisite setup steps. For dormakaba Oracode-specific instructions, see the dormakaba Oracode device integration guide.

Request a Connect Webview

import { Seam } from 'seam'

const seam = new Seam()

const { connect_webview: connectWebview } = await seam.connectWebviews.create()

console.log(connectWebview.login_successful) // false

// Send the Connect Webview URL to your user.
console.log(connectWebview.url)

from seam import Seam

seam = Seam()

webview = seam.connect_webviews.create()

assert webview.login_successful is False

# Send the Connect Webview URL to your user.
print(webview.url)

require "seam"

seam = Seam.new(api_key: 'MY_API_KEY')

webview = seam.connect_webviews.create()

puts webview.login_successful # false

# Send the Connect Webview URL to your user.

puts webview.url

use Seam\SeamClient;

$seam = new SeamClient("YOUR_API_KEY");

$webview = $seam->connect_webviews->create();

Authorize Your Workspace

Navigate to the URL that the Connect Webview object returned. Because you are using a sandbox workspace, complete the login flow by entering the following dormakaba Oracode sandbox test account credentials:

username: jane
site: Ocean Beach Vacations
time zone: (Any)

Confirm the Connect Webview was successful by querying the status.

const updatedWebview = await seam.connectWebviews.get(
  connectWebview.connect_webview_id,
)

console.log(updatedWebview.login_successful) // true

updated_webview = seam.connect_webviews.get(connect_webview_id: webview.connect_webview_id)

assert updated_webview.login_successful # true

updated_webview = seam.connect_webviews.get(connect_webview_id: webview.connect_webview_id)

puts updated_webview.login_successful # true

$webview = $seam->connect_webviews->get('729847ff-98e0-418d-aeba-1e3cb38157c6');
assert($webview->status == 'pending');

3 — Retrieve dormakaba Oracode Devices

After a dormakaba Oracode account is linked with Seam, you can retrieve the connected devices.

const allLocks = await seam.locks.list()

const someLock = allLocks[0]

console.log(someLock.properties.battery_level)

console.log(someLock)

all_locks = seam.locks.list()

some_lock = all_locks[0]

assert some_lock.properties["battery_level"] is True

print(some_lock)

some_lock = seam.locks.list.first

puts some_lock.properties.battery_level

puts some_lock

<?php
$seam = new SeamClient('YOUR_API_KEY');

$locks = $seam->locks->list();

echo json_encode($locks);

4 — Grant Access on a dormakaba Oracode Lock

dormakaba Oracode grants access exclusively through access codes—there is no remote unlock or mobile key. Each door programs either online or offline access codes, depending on whether it is gateway-connected. Seam detects this automatically, so check device.can_program_online_access_codes and device.can_program_offline_access_codes to see which applies. We recommend granting access with Access Grants, Seam’s high-level, device-agnostic API. An Access Grant creates the correct dormakaba Oracode access code for you and manages its lifecycle:

const accessGrant = await seam.accessGrants.create({
  user_identity: { full_name: 'Jane Doe' },
  device_ids: [someLock.device_id],
  requested_access_methods: [{ mode: 'code' }],
  starts_at: '2024-09-10T07:00:00-07:00',
  ends_at: '2024-09-15T19:00:00-07:00',
})

access_grant = seam.access_grants.create(
    user_identity={"full_name": "Jane Doe"},
    device_ids=[some_lock.device_id],
    requested_access_methods=[{"mode": "code"}],
    starts_at="2024-09-10T07:00:00-07:00",
    ends_at="2024-09-15T19:00:00-07:00",
)

curl -X 'POST' \
  'https://connect.getseam.com/access_grants/create' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "user_identity": { "full_name": "Jane Doe" },
    "device_ids": ["11111111-1111-1111-1111-444444444444"],
    "requested_access_methods": [{ "mode": "code" }],
    "starts_at": "2024-09-10T07:00:00-07:00",
    "ends_at": "2024-09-15T19:00:00-07:00"
  }'

If you prefer to manage individual codes yourself, you can also use the lower-level Access Codes API. Either way, dormakaba Oracode enforces device-specific time constraints, so read the device’s time slots before choosing your starts_at and ends_at. For full details—including online vs. offline codes, checking time constraints, and hourly- and daily-bound codes—see Creating dormakaba Oracode Access Codes.

dormakaba Oracode does not let you specify a code for an access code. Instead it auto-generates a six-digit code, which the Seam API returns. If you try to pass the code argument to the access code create function, the Seam API returns an error.

Next Steps

Now that you’ve completed this guide, you can try to connect a real dormakaba Oracode device. To do so, make sure to switch to a non-sandbox workspace and API key because you cannot connect real devices to sandbox workspaces. In addition, if you’d like to explore other aspects of Seam, check out the following helpful resources:

If you have any questions or want to report an issue, email us at support@seam.co.

Overview

Smart Locks

Access Control Systems

Intercoms

Thermostats

Noise Sensors

Cameras

Other Devices

Get started with dormakaba Oracode Locks

Overview

1 — Install the Seam SDK

2 — Link Your dormakaba Oracode Account with Seam

Request a Connect Webview

Authorize Your Workspace

3 — Retrieve dormakaba Oracode Devices

4 — Grant Access on a dormakaba Oracode Lock

Next Steps

​Overview

​1 — Install the Seam SDK

​2 — Link Your dormakaba Oracode Account with Seam

​Request a Connect Webview

​Authorize Your Workspace

​3 — Retrieve dormakaba Oracode Devices

​4 — Grant Access on a dormakaba Oracode Lock

​Next Steps

Overview

1 — Install the Seam SDK

2 — Link Your dormakaba Oracode Account with Seam

Request a Connect Webview

Authorize Your Workspace

3 — Retrieve dormakaba Oracode Devices

4 — Grant Access on a dormakaba Oracode Lock

Next Steps