APIとWebhookの活用例

最初の入室に合わせた案内の送信|予約した人が初めて扉を開けたときに、館内の案内を届けるしくみ

予約した人が初めて扉を開けたときに、Wi-Fiや館内の決まりなどの案内を届けられます。
宿泊施設やレンタルスペースで、予約からAPIでカギを発行しているしくみに、RemoteLOCKのWebhookを足す例です。
こんなとき

入室を合図に案内を届けられます

Wi-Fiのパスワードや館内の決まりを予約の確認のメールにまとめて送ると、ほかの案内に埋もれて、着いたときに探せないことがあります。Webhookで解錠の知らせを受け、その予約で初めての入室のときに案内を送るようにすると、部屋に入ったあとで読む案内を、入室を合図に届けられます。
しくみ

解錠の知らせから予約を探して、案内を送ります

解錠から案内のメールまでの流れの図。1 予約した人:予約の番号で扉を開ける。渡された番号やQRコードを使います。2 RemoteLOCK:解錠の知らせを送る。扉・時刻・使われたカギのIDが入ります。3 貴社が作る受け口:カギのIDから予約を探す。予約を作ったときのIDと突き合わせます。4 貴社が作る受け口:初めての入室かを確かめる。2回目からの入室では送りません。5 貴社が作る受け口:案内をメールで送る。Wi-Fiや館内の決まりを届けます。6 予約した人:入ったあとで案内を読む。入室を合図に届くので探さずに済みます。「貴社が作る受け口」は、貴社か開発会社で作っていただく部分です
予約した人が番号などで扉を開けると、RemoteLOCKから、登録した受け口(Webhook)に解錠の知らせが届きます。APIで作った予約の人が開けたときは、知らせに、予約を作ったときに返ってきたカギ(アクセスゲスト)のIDが入ります。貴社で作る受け口のプログラムが、このIDで予約を探し、その予約で初めての入室なら、予約した人に案内をメールで送ります。
知らせには名前が入っていないため、予約を作るときに、返ってきたIDを予約の記録に残しておきます。2回目からの入室で送り直さないよう、案内を送ったかどうかも予約ごとに記録します。アクセスゲストが開けたときは、解錠の知らせと、カギが使われた知らせの2つが届くので、お知らせ機能では「解錠」だけを選んでください。
必要なもの

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

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

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

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

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

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

最終更新

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

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

記事で解決しないときは

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