はじめに
RemoteLOCKのAPIのご利用あたり、アクセスキーの説明です。アクセスキーはデバイスを解錠するための手段とその認証情報を示します。暗証番号式のスマートロックであれば、PIN：1234などが該当します。（アクセスキータイプがPINで、当該ゲストに与えられた解錠用コードが1234になります。）
RemoteLOCKクラウドは、国内の製品ラインナップ、海外スマートロックを含む複数のスマートロックが管理できる仕組みになっています。そのため、アクセスキーはPINやQRコード、URL認証など複数の（解錠方法）をサポートしており、デバイスによって利用できるアクセスキーのタイプは異なってきます。記事 APIから発行したカギの通知の実装方法 を合わせてご参照ください。
ページ内の目次
アクセスキータイプとは（複数）
デバイスが対応している解錠方法です。リスト形式での返却され、デバイスが複数の方法で解錠できる場合、アクセスキータイプにも複数の値が入ります。現在提供されていているアクセスキータイプは以下となります。
- pin
- qr_code
- felica_idm
- card_number
- url_credential
-
algorithm_pin
※アクセスキータイプは、上記に加えてタイプの追加が計画されています。
※url_credentialとpinではurl_credentialによる解錠時にpinの入力が要求されるなど、設定により2つのアクセスキーが補完的に使われる場合があります。
デフォルトアクセスキータイプとは（単一）
標準の解錠方法です。デバイスがサポートとしている全アクセスキータイプから1つ選ばれます。APIを利用するシステムが便宜上1つのアクセスキータイプしか施設利用者には提供できない場合、アカウント設定に基づいて、優先的に提供してほしいアクセスキーのタイプを示しています。
デバイス毎のアクセスキータイプの取得
GET /access_key_types/devices/:id から取得が可能です。
アクセスキータイプのサポート有無をTRUE/FALSEで返却します。また、デフォルトアクセスキーも取得できます。
ユニバーサルアクセスキーとは
汎用的にどのデバイスでもアクセスキーを受け渡すための仕組みです。予約APIでは、複数のアクセスキータイプを正確に取り扱う複雑さを回避するために、URL形式のカギの受け渡し用ページを提供しています。pinを含め、デバイスがサポートしていないアクセスキータイプはAPIの応答に値が入ってきません。一方で成功した予約作成リクエストの応答には必ず、ユニバーサルアクセスキーが含まれます。
予約APIで自動発行されないアクセスキー
オンラインで受け渡し可能な、PINコード、QRコード、URL認証、algorithm_pinについてはデバイスが対応しているアクセスキーが少なくとも1つ自動生成されます。解錠に、実在のカードが必要なcard_number, felica_idmは登録するカード番号を指定する必要があるためAPIサーバー側からの自動発行はされず、設定する場合はリクエスト時に当該アトリビュートの値を明示的に指定する必要があります。