解錠の知らせをためておき、扉ごとの入室の件数や、入室のあった予約の数を毎月まとめられます。
複数の部屋や拠点を運営する施設で、APIで発行したカギと、Webhookで届く解錠の知らせを組み合わせる例です。
こんなとき
毎月の集計の手作業を減らせます
扉ごとの使われ方は、クラウド管理画面のレポートからイベントをCSVで出して集計できますが、毎月の手作業になります（イベント情報をCSV出力した時の内容）。APIでイベントの一覧を取り出す方法は2025年12月末で廃止され、代わりにWebhookを使うことになっています（イベント一覧の取得の廃止のお知らせ）。解錠の知らせをWebhookで受けてためておくと、集計を自動にできます。
しくみ
知らせを1件ずつためて、月末に数えます
扉が開くたびに、RemoteLOCKから受け口（Webhook）に解錠の知らせが届きます。知らせには、開いた扉、時刻、使われたカギの人のIDが入っています。貴社で作る受け口のプログラムは、使われた番号の値を落としてから、1件ずつ表やデータベースにためます。APIで予約を作るときに返ってくる人のIDを控えておくと、どの予約の入室かが分かります（お知らせ機能）。
アクセスユーザーやゲストの解錠では、解錠の知らせとカギが使われた知らせの2つが届くため、数えるのはどちらか一方にそろえます。ノブなどカギを使わない解錠も届くことがあるので、カギを使った解錠に絞って数えます。受け口が受け取れない状態が続くとWebhookは無効になり、その間の知らせは届きません。件数が合わない月は、管理画面のレポートのCSVと見比べてください。
必要なもの
始める前に5つがそろっているかお確かめください
| 必要なもの | 中身 |
| 料金プラン | ビジネス スタンダード以上で、お支払いが有効なこと（ご利用までの手続き） |
| アカウントとデバイス | 有効なRemoteLOCKのアカウントに、扉のデバイスが登録されていること |
| 契約 | 機密保持契約（NDA）。APIのご利用に必要です。API利用料はかかりません |
| 連携のプログラム | 貴社か、ご依頼先の開発会社で作っていただきます。弊社は開発の受託や技術支援を行っておりません |
| Webhookの登録 | クラウド管理画面の「高度な機能」→「お知らせ機能」で、通知先と受け取るイベントを登録します（お知らせ機能） |
気をつける点
作る前にお確かめいただきたいこと
- 受け口は、HTTPSで受け、3秒以内に200番台を返す作りにしてください。失敗が続くとWebhookは無効になり、メールでお知らせします（Webhookの受け口の条件）
- 解錠の知らせには、使われた暗証番号やカード番号の値がそのまま入ります。チャットや表に流すときは、受け取った直後にその項目を落としてください
- 解錠の知らせには、人の名前ではなく、アクセスユーザーやゲストのIDが入ります。名前で知らせたいときは、IDと名前の対応を貴社の側で持っておきます
- 機種によって受け取れるイベントが違います。すべての扉を対象にするときは、お知らせ機能の情報元を「アカウント」にしてください（お知らせ機能）
始め方
まずはAPI資料をお申し込みください
API資料のお申し込み からご請求いただくと、概要資料と、機密保持契約（NDA）の手続きのご案内をお送りします。NDAの締結後に、API仕様書と、動作を確かめるためのサンプルのアカウントとデバイスの情報をお送りします。手続きの流れは RemoteLOCK APIのご利用までの手続き に、そのほかの使い方は RemoteLOCK APIでできること にまとめています。
関連する記事