====================================================================
(前提条件)
LockStateConnectAPIをご利用頂くためには、秘密保持契約(NDA)を締結して頂く必要があります。
秘密保持契約(NDA)を締結していないお客様は、以下のURLよりLockStateConnectAPI 概要資料を
入手&参照し、資料記載の手順で手続きを進めてください。
https://remotelock.kke.co.jp/contact/api_request/
※本ページはNDAを締結していないお客様も参照可能であるため、詳細な記載は割愛しております。
====================================================================
登録したアプリケーションからLockStateConnectサーバーにアクセスするには、
セキュリティの関係上、認証手順を行う必要があり、
LockStateConnectAPIではOAuth認証方式を採用しています。
OAuth認証方式とは、「アクセストークン」と呼ばれる認可情報を
アプリケーションに渡すことでセキュリティを確保するものです。
上記の図の「認可コード取得」の所で、「アカウント保有者が許可」という所が重要であり、LockStateConnectAPIではこの部分はアカウント保有者による手動操作を必須としています。
具体的には以下の手順となります。
-
認可リクエスト(Client ID/Redirect URI)を送信します。
- クラウド(LockState Connect)の認証画面が表示されます。
-
クラウド(RemoteLOCKクラウド管理画面)のアカウントと同じEmailとパスワードを入力すると、
認証画面許可画面が表示されるので「AUTHORIZE」ボタンを押下します。
- 指定したコールバックURLに認可コード(Authorization Code)がリダイレクトされます。
- 受領した認可コード(Authorization Code)を用いることによって、
アクセストークン/リフレッシュトークンの取得を行います。
アクセストークンの有効期限は2時間となっておりますので、API呼び出しのための認証を継続して得るためには、2時間毎にアクセストークンを更新する必要があります。
アクセストークンが失効となってしまった後は、リフレッシュトークンを使用することで、再度アクセストークンを取得することが可能です。
応用編として、1つのアプリケーションで複数の顧客(複数のRemoteLOCKクラウド(RemoteLOCKクラウド管理画面)のアカウントを操作するには、各アカウント毎に認可コードの取得を行うことで実現可能です。
※(注意事項)1つのアプリケーションから、1つのRemoteLOCKクラウドアカウントに対して、
複数回の認可コードを取得することはできません。