APIとWebhookの活用例

入室のない予約の自動チェック|開始時刻を過ぎても扉が開いていない予約を拾い、担当者に知らせるしくみ

開始時刻を過ぎても扉が開いていない予約を拾って、担当者に知らせられます。
宿泊施設やレンタルスペースなどで、APIで発行したカギと、Webhookで届く解錠の知らせを組み合わせる例です。
こんなとき

来ていない予約に早めに気づけます

無人の施設では、予約した人が時間どおりに着いたかが分かりにくく、入れずに困っている人や、連絡のない取りやめに気づくのが遅れます。予約ごとにクラウド管理画面の履歴を見比べるのも手間です。APIで発行したカギの解錠の知らせをWebhookで受けて予約と突き合わせると、開始時刻を過ぎても入室のない予約だけを拾えます。
しくみ

解錠の知らせに入る人のIDで、予約と突き合わせます

予約から入室のチェックまでの流れの図。1 貴社が作る連携:予約をAPIで作り、IDを控える。返ってきた人のIDを予約と並べて残します。2 予約した人:暗証番号で扉を開ける。予約のカギで入室します。3 RemoteLOCK:解錠の知らせを送る。扉・時刻・カギの人のIDが入ります。4 貴社が作る受け口:IDで予約と突き合わせる。入室があった予約に印を付けます。5 貴社が作る連携:開始から決めた時間で見回す。利用中の予約をAPIで取り出します。6 貴社が作る連携:印のない予約を知らせる。担当者のチャットやメールに送ります。7 担当者:予約した人に連絡する。着いていないか、入れずにいるかを確かめます。「貴社が作る連携」は、貴社か開発会社で作っていただく部分です「貴社が作る受け口」は、貴社か開発会社で作っていただく部分です
APIで予約を作ると、カギのURLと一緒に、その予約のカギを持つ人のIDが返ってきます。貴社で作る連携のプログラムは、このIDを予約と並べて控えておきます。予約した人が扉を開けると、RemoteLOCKから受け口(Webhook)に解錠の知らせが届き、そこに同じIDが入っています(お知らせ機能)。受け口は、IDで予約を探して入室の印を付けます。
開始時刻から決めた時間(例:1時間)がたったら、連携のプログラムが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時間受付)か、お電話でご相談ください。