プールPIN｜直前の予約でも使える暗証番号のしくみと設定 – RemoteLOCK

API連携

プールPIN

プールPINは、あらかじめ予備のPINを発行してデバイスにプールしておくことで、より安定的に製品をご利用いただくための機能です。プールPIN機能を有効にすると、直前の予約や通信のトラブルのときでも、デバイスとの通信・PINの同期を待たずに、暗証番号をご利用いただけます。

対象は、予約API（/bookings エンドポイント）から発行される暗証番号です。連携サービスの側の実装を変える必要はありません。

プールPINのしくみ

プールPINは、予約のたびに作られるものではありません。RemoteLOCKクラウドは、設定した保有数を保つようにプールPINをあらかじめ生成し、ハートビートのたびにデバイスへ同期しています。連携サービスからの予約が無くても、プールPIN自体は定期的に更新され続けます。

連携サービス・RemoteLOCKクラウド・デバイスの3者間のシーケンス図。ハートビートでプールPINがデバイスへ同期され、直前予約が入るとクラウドがデバイスとの通信を待たずにプールPINを払い出し、在庫はクラウド側で補充され、補充されたPINは次のハートビートでデバイスへ届く

①ハートビートでプールPINがデバイスに入ります。②直前の予約が届くと、③クラウドはプールPINをその場で払い出し、在庫が1つ減ります。④減った分はクラウドの側で補充されます。⑤補充されたPINがデバイスに届くのは、次のハートビートです。

/bookings エンドポイント	Attributes	補充のタイミング
予約生成（POST）	rapid_mode = true	12時間ごとの定期メンテナンスのとき
予約生成・変更（POST・PUT）	rapid_mode = false	即時（すぐに補充）

「補充」と「デバイスへの同期」は別のタイミングです。在庫が戻るのはクラウドの中で、デバイスがその新しいPINを受け取るのは次のハートビートです。プールPINが直前の予約に間に合うのは、使う分がすでにデバイスの側にあるからです。

プールPINが使われる条件

POST /bookings を受けたRemoteLOCKクラウドは、予約開始時刻（starts_at）が「現時刻＋閾値」より前かどうかで、新しいアクセスキーを発行するか、プールPINを払い出すかを自動で選びます。連携サービスの側の実装や送るデータは、どちらの場合も変わりません。

POST /bookings を受けたRemoteLOCKクラウドが、予約開始時刻 starts_at が現時刻＋閾値より前かどうかを判定し、新規アクセスキー発行かプールPIN払い出しかを自動で選ぶ図。閾値は、ハートビート間隔をもとにRemoteLOCKクラウドが決める

予約開始時刻	RemoteLOCKクラウドの動き
「現時刻＋閾値」より後	新しいアクセスキーを発行し、デバイスへ同期してからレスポンスします。
「現時刻＋閾値」より前	あらかじめデバイスに同期済みのプールPINを、そのまま返します。デバイスへの新しい同期は起きません。

どちらになったかは、レスポンスの "meta": "pooling" で見分けられます（使われたかどうかの見分け方）。

閾値とハートビート間隔

閾値は、ハートビート間隔をもとにRemoteLOCKクラウドが決めます。ハートビート間隔が長いほど閾値も大きくなり、プールPINが使われる場面が増えます。そのかわり、通常どおり発行したPINがデバイスに届くのは遅くなります。デバイスが「切断」と判定されているあいだは、ハートビート間隔にかかわらず、決まった閾値が使われます。

閾値は、アカウント内のすべてのデバイスのハートビート間隔がそろっていることを前提にしています。プールPINの効き方を正確に把握するために、ハートビート間隔をそろえることをおすすめします。具体的なハートビート間隔は、ご運用を含めてご検討ください。

プールPINが使われない場合

リクエストでPINかQRコードを指定した場合（通常の発行になります）
デバイスにまだプールPINが同期されていない場合
同期されているプールPINの有効期間から外れている場合（同期済みのプールゲストの期間外）
PINを指定する場合

プールPINの採用は、/bookings エンドポイント経由の予約の生成・変更が対象です。/bookings で作った予約でも、PINの再発行（PUT /access_persons/:id）は対象外です。

使われたかどうかの見分け方

予約のJSONレスポンスに "meta": "pooling" が入っていれば、プールPINが使われています。クラウド管理画面では、プールPINのゲストの名前が、予約したゲストの名前に変わることで見分けられます（PINやQRコードの値は変わりません）。

プールPINの例。「pool_guest_」で始まる名前のプールPINが、カギを発行したあと、予約したゲストの名前に変わる

対象の機種と形式

プールPINの対象は、次の機種と、予約API（/bookings）から発行される暗証番号です。機種によっては、PINだけでなくQRコードにも対応しています。

対応デバイス	PINコード	QRコード
RemoteLOCK 5i	○	―
RemoteLOCK 7i	○	―
RemoteLOCK 8j	○	―
RemoteLOCK 8j-F	○	―
RemoteLOCK 8j-Q	○	○
RemoteLOCK 9j	○	―
RemoteLOCK 9j-Q	○	○
RemoteLOCK 500i	○	―
RemoteLOCK 700i	○	―
RemoteLOCK 900j-F	○	―
RemoteLOCK 900j-Q	○	○
TOBIRA	○	○

TOBIRAで利用できる暗証番号の詳しいことは TOBIRAでのQRコード・カードキーを利用する際の設定（APIの予約エンドポイント利用時）をご確認ください。

igloohomeとSADIOT ROOMは対象外です。igloohomeはデバイスの側の計算で暗証番号を決める方式のため、クラウドが先に配っておくという形をとれません。SADIOT ROOMはURL解錠の製品で暗証番号を使いませんので、プールしておく対象がありません。

設定の手順

設定は、クラウド管理画面の「システム連携」→「Bookings API設定」で行います。

クラウド管理画面の「Bookings API設定」の画面。1デバイスあたり使用プール数やハートビート間隔の欄と、右側のプールピンメンテナンス情報

予約システムとのAPI連携を、事前に設定します。予約API（/bookings）に対応した連携サービスかどうかは予約エンドポイントに対応した連携サービス｜宿泊系とそのほかのシステムの一覧でご確認ください。
クラウド管理画面の「システム連携」→「Bookings API設定」を開きます。操作は Bookings API設定をご覧ください。
「1デバイスあたり使用プール数」を設定します。1日1部屋あたりにご利用になる最大数を目安にしてください。設定した値は、アカウント内の各デバイスに適用されます。初期値は0（無効）で、1デバイスあたりの上限は30個です。
同じ画面の「ハートビート間隔(分)」に、アカウント内のデバイスのハートビート間隔のうち最も長いもの（分）を入れます。クラウド管理画面の「デバイス」→「設定」のハートビート間隔と、両方を設定してください。

施設	設定数の目安
ホテル等の宿泊施設	2〜3個／デバイス
時間貸しの施設	3〜7個／デバイス

発行されたプールPINは、クラウド管理画面では「pool_guest_xyz」などの名前で表示され、有効な暗証番号として機能します。プールPINは、設定した個数の範囲内でご利用いただけます。プールPINがいつ補充されたかは、同じ画面の右側の「プールピンメンテナンス情報」で確かめられます。

施設	理由
フロント・受付で、お客様の来訪時にカギを発行している施設	来訪のその場でカギを発行するため、通信を待つ数秒が体感を左右します。
お客様の直前の予約が多い施設	予約から入室までが短いほど、デバイスとのPINの同期が間に合わないおそれが高まります。
夜間無人で運営している施設	スタッフが不在の時間帯ほど、通信トラブルが起きたときの対応が難しくなります。
Wi-Fi環境などで通信トラブルの経験がある施設	通信が途切れやすいほど、発行したPINがデバイスに届かないおそれが高まります。

おすすめの使い方