APIとWebhookの活用例

入室の履歴の自動記録|扉が開くたびに、日時と扉と使われたカギを貴社の台帳に書きためるしくみ

扉が開くたびに、その日時・扉・使われたカギを、貴社の台帳に自動で書きためられます。
イベントの一覧をAPIで取得する方法は、2025年12月末で廃止しました(廃止のお知らせ)。その代わりに、RemoteLOCKのWebhookで知らせを受けて記録する例です。
こんなとき

入室の履歴を、自社の台帳で見られます

入室の履歴は、クラウド管理画面のレポートからCSVで取り出せます(イベント情報をCSV出力した時の内容)。ただ、自社の台帳と合わせて見るには、そのたびに取り出して貼り付けることになります。Webhookで解錠の知らせを受けて書きためるようにすると、取りに行かなくても履歴がたまります。
しくみ

解錠の知らせを、1件ずつ台帳に書き足します

解錠から台帳への記録までの流れの図。1 利用者:扉を開ける。番号・カード・QRコードなどを使います。2 RemoteLOCK:解錠の知らせを送る。扉・時刻・使われたカギのIDが入ります。3 貴社が作る受け口:受け取ってすぐ応答を返す。書き込みは応答を返したあとに行います。4 貴社が作る受け口:番号の値を落とす。暗証番号やカード番号は書きません。5 貴社が作る受け口:台帳に1件書き足す。日時・扉の名前・カギのIDを書きます。6 担当者:台帳で履歴を見る。会員や部屋の情報と合わせて集計します。「貴社が作る受け口」は、貴社か開発会社で作っていただく部分です
お知らせ機能で「解錠」のイベントを選び、通知先にWebhookを登録すると、扉が開くたびに受け口に知らせが届きます。ノブなどカギを使わない解錠も届くことがあるので、方法の項目で分けて記録します。知らせには、開いた扉のID、時刻、使われたカギ(アクセスユーザーやゲスト)のIDが入っています。貴社で作る受け口のプログラムが、例えばkintoneのアプリに1件ずつ書き足します。
受け口が長く止まると、Webhookは無効になり、知らせが止まります。抜けた期間の分は、レポートのCSVで補ってください。CSVにも暗証番号の列があるので、台帳に入れる前に外します。施錠の知らせはオートロックで閉まったときにも届くため、退室の記録には使えません。
※ kintoneは、Webhookを受けて自作するときの例です。RemoteLOCKと連携済みのサービスではありません。連携済みのサービスは 予約エンドポイントに対応した連携サービス と 連携システム一覧(公式サイト)でご覧いただけます。
必要なもの

始める前に3つがそろっているかお確かめください

必要なもの 中身
アカウントとデバイス 有効なRemoteLOCKのアカウントに、扉のデバイスが登録されていること
Webhookの登録 クラウド管理画面の「高度な機能」→「お知らせ機能」で、通知先と受け取るイベントを登録します(お知らせ機能)。Webhookを受けるだけなら、APIのご利用の手続き(NDA)は要りません
受け口のプログラム 知らせを受けて処理するプログラムは、貴社か、ご依頼先の開発会社で作っていただきます。弊社は開発の受託や技術支援を行っておりません
気をつける点

作る前にお確かめいただきたいこと

  • 受け口は、HTTPSで受け、3秒以内に200番台を返す作りにしてください。失敗が続くとWebhookは無効になり、メールでお知らせします(Webhookの受け口の条件)
  • 解錠の知らせには、使われた暗証番号やカード番号の値がそのまま入ります。チャットや表に流すときは、受け取った直後にその項目を落としてください
  • 解錠の知らせには、人の名前ではなく、アクセスユーザーやゲストのIDが入ります。名前で知らせたいときは、IDと名前の対応を貴社の側で持っておきます
  • 機種によって受け取れるイベントが違います。すべての扉を対象にするときは、お知らせ機能の情報元を「アカウント」にしてください(お知らせ機能)
始め方

まずはお知らせ機能で通知先をご登録ください

Webhookの通知先は、クラウド管理画面の「高度な機能」→「お知らせ機能」→「通知先」で登録し、受け取るイベントを選びます(お知らせ機能)。届く内容の例は Webhookでのイベント情報の取得 にあります。カギの発行などをAPIで自動にしたいときは、API資料のお申し込み からご請求ください。
関連する記事

最終更新

この記事は役に立ちましたか?

0人中0人がこの記事が役に立ったと言っています

記事で解決しないときは

問い合わせフォーム(24時間受付)か、お電話でご相談ください。