APIとWebhookの活用例

入室の記録の予約台帳への書き戻し|扉が開いた時刻を、来店の実績として予約ごとに残すしくみ

扉が開いた時刻を、来店の実績として予約台帳に自動で書き戻せます。
店舗や宿泊施設などで、APIで発行したカギと、Webhookで届く解錠の知らせを組み合わせる例です。
こんなとき

予約ごとの来店の有無と時刻を台帳に残せます

予約台帳に残るのは予約の内容だけで、実際に来たかは、クラウド管理画面の履歴と見比べないと分かりません。イベントをCSVで出して突き合わせる方法もありますが(イベント情報をCSV出力した時の内容)、毎回の手作業になります。解錠の知らせをWebhookで受けて予約と突き合わせると、扉が開いた時刻が予約ごとに自動で残ります。
しくみ

解錠の知らせに入る人のIDで、予約を探して書き込みます

予約から来店の記録までの流れの図。1 貴社が作る連携:予約をAPIで作り、IDを控える。返ってきた人のIDを予約と並べて残します。2 予約した人:暗証番号で扉を開ける。予約のカギで入室します。3 RemoteLOCK:解錠の知らせを送る。扉・時刻・カギの人のIDが入ります。4 貴社が作る受け口:IDで予約を探す。控えておいたIDから予約を見つけます。5 貴社が作る受け口:入室の時刻を台帳に書き込む。来店の実績として予約ごとに残します。6 貴社が作る連携:チェックインの時刻を記録する。必要ならAPIで予約の側にも残します。7 担当者:台帳で来店を確かめる。番号の値は台帳に残しません。「貴社が作る連携」は、貴社か開発会社で作っていただく部分です「貴社が作る受け口」は、貴社か開発会社で作っていただく部分です
APIで予約を作ると、カギのURLと一緒に、その予約のカギを持つ人のIDが返ってきます。貴社で作る連携のプログラムは、このIDを予約と並べて控えておきます。扉が開くと、RemoteLOCKから受け口(Webhook)に解錠の知らせが届き、そこに同じIDが入っています(お知らせ機能)。受け口は、IDで予約を探し、入室の時刻を台帳に書き込みます。
入室の時刻は、APIで予約にチェックインの時刻として記録することもできます。チェックアウトを記録するとカギは使えなくなり、延長もできなくなるため、入室の記録にはチェックインのほうを使います。アクセスゲストの解錠では、解錠の知らせとカギが使われた知らせの2つが届くので、受け取るイベントはどちらか一方にそろえ、同じ予約で何度も開けたときは最初の時刻だけを実績にするなど、書き込む決まりを決めておきます。
必要なもの

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

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

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

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

まずはAPI資料をお申し込みください

API資料のお申し込み からご請求いただくと、概要資料と、機密保持契約(NDA)の手続きのご案内をお送りします。NDAの締結後に、API仕様書と、動作を確かめるためのサンプルのアカウントとデバイスの情報をお送りします。手続きの流れは RemoteLOCK APIのご利用までの手続き に、そのほかの使い方は RemoteLOCK APIでできること にまとめています。
関連する記事

最終更新

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

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

記事で解決しないときは

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