APIとWebhookの活用例

予約システムへの連携の最小構成|カギの発行・変更・取り消しと入室の記録から始めるしくみ

予約システムにRemoteLOCKとの連携を足すときは、カギの発行・変更・取り消しと、入室の記録から始められます。
予約システムを自社で開発・運営している事業者や開発会社の方に向けて、最初に作る部分をまとめた例です。
こんなとき

最初に作る部分を絞って始められます

APIでできることは多く(RemoteLOCK APIでできること)、どこから作るか迷いがちです。予約に合わせてカギを作り、変更と取り消しに合わせて直し、入室を記録するところまでがあれば、予約ごとのカギの発行と連絡の手作業はなくなります。ほかの機能は、運用を見ながらあとから足せます。
しくみ

予約の操作3つと、解錠の知らせ1つを結び付けます

最小構成の流れの図。1 予約する人:予約を入れる・変える。確定・変更・取り消しのどれかです。2 貴社が作る連携:予約の内容をAPIで送る。作る・変える・無効にするの3つです。3 RemoteLOCK:カギを作ってURLを返す。扉には次の通信で届きます。4 貴社が作る連携:URLを送り、IDを控える。予約IDと人のIDを予約に残します。5 予約する人:時間内に暗証番号で開ける。URLの画面に番号やQRコードが出ます。6 RemoteLOCK:解錠の知らせを送る。扉・時刻・カギの人のIDが入ります。7 貴社が作る受け口:IDで予約に入室を記録する。番号の値は残しません。「貴社が作る連携」は、貴社か開発会社で作っていただく部分です「貴社が作る受け口」は、貴社か開発会社で作っていただく部分です
予約が確定したら、名前・扉・開始と終了の日時をAPIで送って予約を作ります。予約IDには、予約システム側のIDを指定するのがおすすめです。返ってきたカギの画面のURL(ユニバーサルアクセスキー)を予約した人に送り、一緒に返ってくるカギの人のIDを予約に控えます。時間を変えたら予約を変え、取り消したら予約を無効にします。同じ予約を変えてもURLは変わらないので、送り直しは要りません(ユニバーサルアクセスキー)。
入室の記録は、Webhookの受け口で受けます。解錠の知らせに入る人のIDで予約を探し、入室の時刻を残します。取り消しには、予約の削除ではなく無効にする操作を使います。削除すると記録ごと消えます。
※ お使いの予約システムがすでにRemoteLOCKと連携している場合は、開発は要りません。連携済みのサービスは 予約エンドポイントに対応した連携サービス と 連携システム一覧(公式サイト)でご覧いただけます。
必要なもの

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

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

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

  • 番号も、予約の変更や取り消しも、扉に届くのは本体が次にクラウドと通信したときです。予約は早めに作り、延長は元の終了の時刻まで余裕をもって送ってください。直前の予約にはプールPINを使えます(ハートビート通信のしくみ、プールPIN)
  • 受け口は、HTTPSで受け、3秒以内に200番台を返す作りにしてください。失敗が続くとWebhookは無効になり、メールでお知らせします(Webhookの受け口の条件)
  • APIを呼べる回数には上限があります。予約をまとめて作るときは、間隔をあけて送ってください
始め方

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

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

最終更新

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

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

記事で解決しないときは

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