API・開発者向け
KEYVOX REST APIでスマートロック・スマートロッカー・予約システムをプログラマブルに制御。既存の管理システムやアプリケーションとの統合を実現します。
# HMAC-SHA256 認証ヘッダーの構成
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 カテゴリ
KEYVOX APIは4つのカテゴリで、スマートアクセス管理に必要な機能を網羅しています。
スマートロックAPI
ドア・部屋の管理、暗証番号（PIN）・QRコードの発行・変更・無効化、解錠・施錠操作、イベントログ取得。
スマートロッカーAPI
ロッカーユニットの管理、空きボックス検索、暗証番号発行、LED色制御、利用ログ取得。
ICカード操作API
ICカードの登録・更新・無効化。スマートロック・ロッカー両方に対応。有効期間設定や配信ステータスの追跡。
予約管理API
施設・部屋プランの取得、予約の作成・更新・キャンセル、チェックイン・チェックアウト処理、空室検索。
技術仕様
セキュアで信頼性の高いAPI連携を支える技術基盤。
HMAC-SHA256 認証
BACS管理画面でAPIキー・シークレットを発行。サーバーのIPアドレスをホワイトリスト登録し、HMAC-SHA256署名で認証。
通知・Webhook
暗証番号の発行通知をメール・SMSで自動送信。カスタムWebhookエンドポイントへのイベント通知にも対応。
セキュリティ
全通信はTLS暗号化。IPアドレス制限、リクエスト署名検証、APIコール数制限でセキュアなアクセスを実現。
サンプルコード
Java・PHPのサンプルコード、Postmanコレクションを提供。Discordコミュニティで開発者サポート。
データ仕様
レスポンス形式
JSON（code, msg, data 構造）
タイムスタンプ
Unix時間（1970/01/01からの秒数）
ページネーション
カーソルベース（ポジションポインター）
暗証番号
4〜8桁（未指定時は6桁を自動生成）
対応デバイス
Zapier連携
Zapierを使って、KEYVOXと5,000以上のアプリをノーコードで連携。予約・解錠イベントをトリガーに、Slack通知やGoogleスプレッドシート記録などを自動化できます。
Zapier連携を見る