How to generate temporary access codes programmatically

1npm install seam
2
3# Use an API key from your sandbox workspace.
4export SEAM_API_KEY="seam_test_your_sandbox_api_key"

1import { Seam } from "seam"
2
3const seam = new Seam()
4
5const devices = await seam.devices.list()
6const pinCapableDevices = devices.filter((device) => device.can_program_online_access_codes)
7console.log(pinCapableDevices.map((device) => device.device_id))
8
9const entrances = await seam.acs.entrances.list()
10const codeEntrances = entrances.filter((entrance) => entrance.can_unlock_with_code)
11console.log(codeEntrances.map((entrance) => entrance.acs_entrance_id))

1import { Seam } from "seam"
2
3const seam = new Seam()
4
5const devices = await seam.devices.list()
6const device = devices.find((item) => item.can_program_online_access_codes)
7if (!device) throw new Error("Connect a PIN-capable lock first")
8
9// Use your booking's check-in and checkout times in production.
10const startsAt = new Date()
11const endsAt = new Date(startsAt.getTime() + 3 * 24 * 60 * 60 * 1000)
12const accessGrant = await seam.accessGrants.create({
13  user_identity: { full_name: "Jane Doe", email_address: "jane@example.com" },
14  device_ids: [device.device_id],
15  requested_access_methods: [{ mode: "code" }],
16  starts_at: startsAt.toISOString(),
17  ends_at: endsAt.toISOString(),
18})
19console.log(accessGrant.access_grant_id) // Store this on the booking.

1import { Seam } from "seam"
2
3const seam = new Seam()
4
5const spaceId = process.env.SEAM_SPACE_ID
6if (!spaceId) throw new Error("Set SEAM_SPACE_ID to the booked space's UUID")
7const entrances = await seam.acs.entrances.list({ space_id: spaceId })
8if (!entrances.length || entrances.some((entrance) => !entrance.can_unlock_with_code)) {
9  throw new Error("Every entrance in this space must support PIN codes")
10}
11const needsReservation = entrances.some((entrance) => entrance.can_belong_to_reservation)
12const startsAt = new Date()
13const accessGrant = await seam.accessGrants.create({
14  user_identity: { full_name: "Jane Doe", email_address: "jane@example.com" },
15  acs_entrance_ids: entrances.map((entrance) => entrance.acs_entrance_id),
16  requested_access_methods: [{ mode: "code" }],
17  starts_at: startsAt.toISOString(),
18  ends_at: new Date(startsAt.getTime() + 3 * 86400000).toISOString(),
19  ...(needsReservation ? { reservation_key: "booking-8412" } : {}),
20})
21console.log(accessGrant.access_grant_id)

1const methods = await seam.accessMethods.list({
2  access_grant_id: accessGrant.access_grant_id,
3})
4const pin = methods.find((method) => method.mode === "code" && method.is_issued)
5if (pin) console.log(pin.code) // Pass to your guest messaging service.

1import { Seam } from "seam"
2
3const seam = new Seam()
4
5// Call the appropriate handler for the booking event.
6async function updateCheckout(accessGrantId, newCheckOut) {
7  await seam.accessGrants.update({ access_grant_id: accessGrantId, ends_at: newCheckOut })
8}
9
10async function cancelBooking(accessGrantId) {
11  await seam.accessGrants.delete({ access_grant_id: accessGrantId })
12}