お問い合わせ
  1. トップ
  2. 開発者
  3. 連携ガイド

INTEGRATION GUIDES

よくある連携を、流れで理解する。

業種ごとによくある連携の流れと、使う代表的な API をまとめました。パラメータの詳細は、WatchKey 登録後に閲覧できる仕様書をご覧ください。

GUIDE 01

予約に合わせて、滞在期間だけの暗証番号を発行する

ホテル・民泊・貸しスペースの予約システムから、EPIC スマートロックに暗証番号を発行します。

タイミング処理API
予約の確定期間・時間帯を指定してゲスト暗証番号を発行。先の予約は予約登録（ベータ）でPOST /api/epic/{id}/guest_keys
POST /api/epic/{id}/guest_keys/reservations
チェックイン入室を Webhook で受け取り、チェックイン済みにするPOST /api/notifications
キャンセル発行した暗証番号・予約を削除DELETE /api/epic/{id}/guest_keys/{key_id}

ゲスト暗証番号は錠ごとに最大10件、予約は最大500件です。ほかの暗証番号と同じ番号は登録できません（409 が返ります）。

GUIDE 02

入居・退去に合わせて鍵を切り替える

物件管理システムから、入居・空室モードと入居期間の暗証番号を設定します。

タイミング処理API
入居入居モードに切り替え、入居期間の暗証番号を設定。入居者アプリには入居者向けの権限のトークンを渡すPATCH /api/epic/{id}/room_state
POST /api/devices/{id}/scheduled_passwords
退去空室モードに戻す（錠内の鍵情報が初期化される）PATCH /api/epic/{id}/room_state
内見60分サイクルパスワードを取得して案内GET /api/doors/{id}/cycle_password

GUIDE 03

入社・退職に合わせてカードを登録・削除する

人事システムの社員情報から、利用者とカードを作り、各扉の機器に登録します。

タイミング処理API
入社利用者とカードを作成（CSV で一括も可）し、制御器や錠に登録POST /api/users
POST /api/cards
POST /api/gateway/{gw}/controllers/{c}/users
確認その利用者が登録されている制御器と同期状態を確認GET /api/users/{id}/coa_registrations
退職機器から登録を削除し、利用者を削除DELETE /api/gateway/{gw}/controllers/{c}/users/{registration_id}
DELETE /api/users/{id}

GUIDE 04

部署や時間帯で、入れる扉を分ける

Lavish の制御器で、アクセスグループと曜日・休日スケジュールを設定します。

  1. アクセスグループを作る

    「社員」「清掃」などのグループを作ります。POST /api/access_groups

  2. 扉（リーダー）とスケジュールを割り当てる

    グループごとに使えるリーダーと、週間・休日のスケジュールを設定します。

  3. 利用者のグループを割り当てる

    PUT /api/access_groups/{id}/user_groups

  4. 制御器に反映する

    設定を制御器に同期すると、回線が切れてもそのルールで動きます。

GUIDE 05

顔認証で入館できるようにする

顔認証リーダー RESR-QF7-M に利用者を登録し、顔・カード・QR コードを実機に反映します。

  1. 利用者を作る

    POST /api/users

  2. 顔認証リーダーに登録する

    顔の有無・通行手段（顔・カード・QR）を設定します。POST /api/gateway/{gw}/qf7/{qf7_id}/users

  3. 実機に反映する

    顔と通行手段は、それぞれ同期の API で実機に反映します。すでに実機にいる利用者は、WatchKey に取り込むこともできます。

GUIDE 06

たくさんの拠点の履歴を集める

勤怠や監査のために、全拠点の入退室履歴を集めます。機器の台数が多いときは、分けて取得すると待ち時間を短くできます。

  1. 保存済みの履歴をすぐ取得する

    GET /api/histories?fetch=false は、WatchKey に保存済みの履歴をすぐに返します。

  2. 機器ごとに最新の履歴を取り込む

    POST /api/devices/{id}/histories/fetch を機器ごとに、バックグラウンドで実行します（期間を指定できます）。

  3. もう一度取得して更新する

    手順1をもう一度呼ぶと、取り込んだ履歴も含めて返ります。リアルタイムに受け取りたい出来事は Webhook と組み合わせます。

GUIDE 07

EPIC スマートロックにカードを登録する

WatchKey のカード台帳と、錠ごとの登録枠（登録番号）は別々に管理されています。

REGISTER

登録の流れ

  • 台帳にカードを作る：POST /api/cards
  • 錠の空いている登録番号を確認：GET /api/epic/{id}/cards
  • 錠に登録する：POST /api/epic/{id}/cards
EXISTING CARDS

錠本体で登録したカード

錠本体で登録されたカードも、カードの番号を読み取って WatchKey の台帳に紐づけられます。

錠と通信して最新の状態を読み取る処理は、数秒かかることがあります。すべてのカードを WatchKey から登録する運用なら、毎回読み取る必要はありません。

GET STARTED

まずは、無料ではじめてみる。

メールアドレスだけで登録でき、登録後すぐに API 仕様書を閲覧できます。導入・お見積りのご相談もお気軽にどうぞ。

無料ではじめる 相談する