APIを使った開発のTIPs

APIで発行したカギの通知の実装|機種ごとの解錠方法の違いと、画面・メールへの埋め込み

APIからカギ発行をする場合には、RemoteLOCKでは複数の機種やデバイスがあり、それにより利用できる解錠方法(アクセスキータイプ)が異なることに注意が必要です。

記事「アクセスキー|APIから発行するカギの種類とユニバーサルアクセスキー」を合わせてご参照ください。

 

APIから発行したカギの渡し方の選び方の図。アクセスキータイプは、機種やデバイスによって違う。自社施設だけで機種が統一されているときは、導入機種が対応するアクセスキーに沿って実装する。複数のユーザーに提供するシステムで全機種に対応するときは、APIから返るURLリンクのユニバーサルアクセスキーで渡す。利用者には、PIN、QRコード、解錠の操作画面など、アクセスキーに合った内容が表示される。画面やメールに直接埋め込むときは、アクセスキータイプで分岐し、たとえばQRコードならQRコードの画像を表示する。分岐しないタイプには、ユニバーサルアクセスキーを使う。

特定機種のみ、自社施設のみへのAPI利用

自社が保有する施設に設置済みのデバイスを、自社システムからAPIで制御したい場合(機種が統一されている場合)、導入機種が対応するアクセスキーに沿った実装を進めてください。

 

 

複数ユーザに提供するシステムでの利用・全機種への対応

複数のアクセスキータイプに対応するため、予約APIから発行したカギを利用者に渡す際は、ユニバーサルアクセスキーと呼ばれるAPIから返却されるURLリンクをご利用ください。利用者には、PINやQRコード、解錠の操作画面など、アクセスキーの内容に準じた内容が表示されます。

この対応により、RemoteLOCKクラウドにより管理する各種スマートロック(製品HPに記載されている全機種)と連携が可能になります。

 

画面・メールへの埋め込み

開発するシステムの「画面やマイページ上に直接QRコードを表示したい」といった場合には、「アクセスキータイプがQRコードだった場合、QRコード画像を表示する」といった、分岐処理を実装してください。この場合にも、未知/分岐実装しないアクセスキータイプにはユニバーサルアクセスキーをご利用ください。

*QRコードの生成にはRemoteLOCKが提供するAPIでは util/qrcodes のエンドポイントがご利用できますが、開発システム内のライブラリ等を利用して独自に生成いただいて問題ありません。

 

 

最終更新

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

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

記事で解決しないときは

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