RemoteLOCK API を使うと、貴社のシステムから RemoteLOCK のスマートロックにカギを発行したり、解錠の記録を受け取ったりできます。
クラウド管理画面でできる操作は、ほぼすべて API からも行えます。この記事では、API でできることと使い方の例、始める前に確かめていただきたいことをまとめています。ご利用までの手続きは RemoteLOCK APIのご利用までの手続き にあります。
最初に
まず連携済みのサービスがないかお確かめください
お使いのシステム、または作ろうとしているシステムが、すでに RemoteLOCK と連携している場合は、API の開発も機密保持契約（NDA）の締結も要りません。連携先のサービス提供会社のご案内に沿って設定してください。
一覧に載っているのは、掲載の許諾をいただいた公開のサービスです。このほかに、自社の業務システムと連携してお使いの例も多くあります。
使い方の例
貴社のサービスに合う使い方をお選びください
RemoteLOCK のクラウドは、さまざまなスマートロックやゲートなどの機器と、貴社のソフトウェアの間に立ちます。貴社のサービスは、図の右側のソフトウェアの位置に入ります。
API で連携していただいているのは、主に次のようなシステムです。
| システムの種類 | 例 |
| 宿泊施設向け | サイトコントローラー、PMS、精算機（キオスク端末）、客室のタブレット |
| 時間貸しの施設向け | コワーキングスペース、会議室、音楽スタジオ、レンタルルーム |
| 会員管理 | 無人の小売店、ジム、サロン、自習室、トランクルーム、会員制の施設 |
| 勤怠・受付の管理 | 自社の業務システム、複数の拠点のオフィスのセキュリティ管理 |
使い方は、次の3つの例が基本です。
予約との連携（宿泊施設、時間貸しの施設）
予約が確定したときやチェックインのときに、貴社のシステムから API でカギを発行します。カギは予約した時間だけ使え、ゲストは届いたカギでドアを開けます。チェックアウトのあとは使えなくなります。宿泊施設なら、客室とエントランスの2つのドアのカギを、まとめて1人のゲストに渡すこともできます（共用ドア）。
流れ：①予約の確定・チェックイン → ②③貴社サービスが RemoteLOCK クラウドからアクセスキーを受け取る → ④利用者にお知らせ → ⑤ドアを開ける → ⑥チェックアウト
シーケンス図：解錠の記録は Webhook で貴社アプリケーションに届きます。チェックアウトのときは、アクセスキーを使えなくする（deactivate）リクエストを送ります
会員証との連携（コワーキングスペースなどの共用の場所）
会員が登録したときに、貴社のシステムから API で会員だけが使えるカギを発行し、会員証として表示します。会員は会員証でドアを開けます。
流れ：①会員登録 → ②③貴社サービスが RemoteLOCK クラウドからアクセスキーを受け取る → ④会員証を表示 → ⑤ドアを開ける
シーケンス図：初めに一時的なアクセスキーを発行し、必要に応じて定期的に更新する例です
回数券との連携（コワーキングスペースなどの共用の場所）
回数券を買ったときに、いつでも使えるカギを API で発行します。解錠の記録を Webhook で受け取って回数を数え、使い切ったらカギを使えなくします。
流れ：①回数券の購入 → ②③貴社サービスが RemoteLOCK クラウドからアクセスキーを受け取る → ④利用者にお知らせ → ⑤ドアを開ける → ⑥使い切ったら使えなくする
シーケンス図：解錠の記録を Webhook で受け取り、貴社アプリケーションで回数を数えます。残りが0回になったら、アクセスキーを使えなくする（deactivate）リクエストを送ります
機能
API でできることをご確認ください
クラウド管理画面でできる操作は、ほぼすべて API からも行えます。
RemoteLOCK のクラウド管理画面
主な機能は次のとおりです。ここに挙げたのは一部で、ほかの操作も API から行えます。
| できること | 中身 |
| 入室の権限を与える | アクセスユーザー・ゲストの追加、情報の取得・更新・削除 |
| カギ（アクセスキー）を取り出す | 暗証番号、QRコード、ICカード（FeliCa の IDm を指定）、URL |
| デバイスの状態を見る・変える | 解錠・施錠の状態の確認と変更、施錠・解錠のイベントの通知 |
| お知らせを受け取る | 通知先の追加・削除・更新（メールか、貴社のサーバーへの通知）、お知らせの履歴の取得 |
| スケジュールを設定する | デバイスの解錠・施錠のスケジュール、オートロックのスケジュール、アクセススケジュール |
イベントを貴社のサーバーで受け取るしくみは Webhookでのイベント情報の取得 に、管理画面のお知らせの設定は お知らせ機能 にあります。
カギの渡し方
カギはユニバーサルアクセスキーでお渡しください
RemoteLOCK では、デバイスを開けるための手段とその認証情報を「アクセスキー」と呼んでいます。暗証番号式のスマートロックなら、ゲストに渡す「1234」のような番号がアクセスキーです。RemoteLOCK のクラウドは、国内の製品と海外のスマートロックを含めたさまざまな機種を管理しているため、機種によって開け方（暗証番号、QRコード、URL など）が違います。
そこで、カギは「ユニバーサルアクセスキー」でお渡しいただくことをおすすめしています。ユニバーサルアクセスキーは、URL の形で渡すカギです。ゲストが URL を開くと、予約の期間と、その機種で使える QR コードや暗証番号が表示されます。
ユニバーサルアクセスキーの画面の例
- 取り付けたスマートロックの種類や開け方に関係なく、同じ形でカギを渡せます
- これから連携する機種が増えても、貴社で追加の開発をしなくて済みます
ゲストが受け取る画面は ユニバーサルアクセスキー｜ゲストにURLで届くカギの画面とウォレットへの追加 で、API から発行できるカギの種類は アクセスキー｜APIから発行するカギの種類とユニバーサルアクセスキー でご覧いただけます。対応する機種は 予約エンドポイントに対応した連携サービス の末尾にあります。
ユニバーサルアクセスキーで使える機種（抜粋）
ご利用の条件
ご利用の条件をご確認ください
| 必要なもの | 中身 |
| 料金プラン | ビジネススタンダード以上。お支払いが有効であること |
| アカウント | 有効な RemoteLOCK のアカウントと、デバイスの登録 |
| 契約 | 機密保持契約（NDA）の締結。API 仕様書の閲覧とご利用に必要です |
| API 利用料 | かかりません |
開発のしかた
開発は貴社または開発会社でお進めください
弊社は API を無償で公開していますが、システム開発の受託や技術支援は行っておりません。連携の実装は、貴社またはご依頼先の開発会社にてお願いしています。
NDA の締結後に、API 仕様書と、動作を確かめるためのサンプルのアカウントとデバイスの情報をお送りします。サンプルのアカウントはほかの会社様も使う共有のものです。開発の進め方は API仕様書を受け取ったあと にあります。
実機で確かめたいとき デモ用の実機の貸し出しはしていません。お手元で確かめたいときは、製品をご購入ください。
ご質問
よくあるご質問
Q. 費用はかかりますか？
A. API の利用料はかかりません。実機で確かめるときや運用するときは、ビジネススタンダード以上のプランでアカウントをご契約ください。
Q. 仕様書はすぐに見られますか？
A. API 仕様書は、機密保持契約（NDA）を結んだあとにお送りします。手続きは RemoteLOCK APIのご利用までの手続き にあります。
Q. 試しに動かせますか？
A. NDA の締結後に、動作を確かめるためのサンプルのアカウントとデバイスの情報をお送りします。
Q. 自社の業務システムだけで使い、連携サービスの一覧に載せなくてもよいですか？
A. はい、一覧への掲載を伴わないご利用もできます。
Q. 海外でも提供できますか？
A. 提供するエリアによって、接続先（base URL）の切り替えが要ることがあります。運用を始める前のご連絡のときにお知らせください。
資料とご相談
資料のご請求とご相談はこちらから
API 仕様書の閲覧をご希望の場合は、API資料のお申し込み からご請求ください。概要資料と、機密保持契約（NDA）の手続きのご案内をお送りします。
この記事を読んだうえで個別にご相談したいことがあれば、RemoteLOCK API Web相談 からご予約ください。ご検討の段階でもお使いいただけます。
関連する記事