API & Developer Resources

Programmatically control smart locks, smart lockers, and reservation systems with the KEYVOX REST API. Seamlessly integrate with your existing management systems and applications.

# HMAC-SHA256 Authentication Header Structure

curl -X POST https://api.keyvox.co/v1/createLockPin \

-H "x-target-host: default.pms" \

-H "date: Thu, 01 Jan 2026 00:00:00 GMT" \

-H "digest: SHA-256=..." \

-H "authorization: hmac username=\"API_KEY\", algorithm=\"hmac-sha256\", headers=\"x-target-host date digest\", signature=\"...\"" \

-d '{"lockId":"LOCK_ID","pin":"123456","startDate":1735689600,"endDate":1735776000}'

API Categories

The KEYVOX API covers all smart access management needs across four categories.

Smart Lock API

Door and room management, PIN/QR code issuance, modification, and revocation, lock/unlock operations, and event log retrieval.

getUnits / getUnitPinListcreateLockPin / changeLockPin / disableLockPinunlock / getLockStatus / getLockHistorylocks/events (advanced event search)

Smart Locker API

Locker unit management, available box search, PIN code issuance, LED color control, and usage log retrieval.

getLockers / getLockerStatus / setLockerStatuscreateLockerPin / changeLockerPin / disableLockerPinunlockLocker / getAvailableBoxessetBoxColor (LED indicator control)

IC Card API

IC card registration, update, and revocation. Compatible with both smart locks and lockers. Set validity periods and track delivery status.

setCard / updateCard / disableCardgetCardStatus / getLockCardListsetLockerCard / updateLockerCard

Reservation Management API

Retrieve facility and room plans, create/update/cancel reservations, process check-in/check-out, and search available rooms.

getPlaces / getRoomPlans / getAvailableRoomscreateBooking / updateBooking / cancelBookingcheckIn / checkOut / getBookingDetails

Technical Specifications

The technical foundation supporting secure and reliable API integration.

HMAC-SHA256 Authentication

Issue API keys and secrets from the BACS management console. Whitelist server IP addresses and authenticate with HMAC-SHA256 signatures.

Notifications & Webhooks

Automatically send PIN code issuance notifications via email and SMS. Custom webhook endpoint event notifications also supported.

Security

All communications are TLS-encrypted. Secure access through IP address restrictions, request signature verification, and API call rate limiting.

Sample Code

Java and PHP sample code with Postman collections provided. Developer support available through our Discord community.

Data Specifications

Response Format

JSON (code, msg, data structure)

Timestamps

Unix time (seconds since 1970/01/01)

Pagination

Cursor-based (position pointer)

PIN Codes

4–8 digits (auto-generates 6 digits if unspecified)

Supported Devices

KEYVOX BCL-BX1KEYVOX BCL-QR1L!NKEYOPELOigloohomeSmart Locker

View API Documentation

Full endpoint specifications, request/response examples, and sample code are available on the developer portal.

Developer Portal

Zapier Integration

Connect KEYVOX with over 5,000 apps using Zapier—no code required. Automate Slack notifications, Google Sheets logging, and more triggered by reservation and unlock events.

View Zapier Integration

KEYVOX Developer Community

Exchange ideas with other developers on Discord. Share API integration tips, sample code, and get answers to technical questions.

Join Discord

API Consultation

For questions about API integration or technical inquiries, please don't hesitate to contact us.