鍵の配信とは
弊社のKEYVOXサービスではAPIを公開しており、APIを使った鍵の配信が可能です。
その前にまず、「鍵の配信って何ですか？」と聞かれることがあります。スマートロックには暗証番号（以降 鍵）を発行可能です。スマートロック単体で利用する場合は直接スマートロックデバイス（以降 デバイス）を操作して鍵を登録することが可能です。
しかし、弊社のKeyvoxサービスを使うとインターネット経由でデバイスに鍵を発行（削除）することが可能です。このことを「鍵の配信」と呼んでいます。
こちらの記事ではKEYVOX-APIを利用した鍵の配信について説明したいと思います。
鍵の配信方法
鍵の配信にはオンライン・オフラインがあります。一言でいうと
オンライン配信：インターネット経由で実際にデバイスへ鍵を発行（削除）する方法になります。
オフライン配信：デバイスとデバイスのCloudが保持する発行方法(アルゴリズム）により算出される暗証番号となります。実際に番号を登録するのではなく、計算で算出するので削除ができないという制約があります。また暗証番号の指定もできません。
APIでの配信
まず前提条件として、APIからの鍵の配信は「ドア(部屋）」に対して実施します。「ドア」はKEYVOXで管理されている概念でドアに対してデバイスを関連付ける必要があります。この操作はBACSの画面から実施する必要があります。
ドアを特定するユニークキーは unitIdとなっています。部屋リスト取得API で取得可能です。
ここで取得した発行したいドアのunitIdと暗証番号(任意)、開始、終了時間を指定して、暗証番号発行APIを呼び出すことで鍵の発行が可能です。
APIが正常終了したのに鍵が配信されない？
APIが正常終了したあとに、鍵は即時に配信されるのではなく、一旦KEYVOXサーバ（以降 KEYVOX Cloud) が受信したあとにバッチ処理（２分毎）に配信を実施しますので実際に利用開始できるまで少し時間差があります。また、利用開始時間の７２時間前より配信開始という条件があります。またAPI自体は「鍵の配信リクエストを正しく受け付けた」というだけで実際の配信を保証するものではありません。
配信状況の確認
配信が失敗すると指定したメールアドレス宛にエラー通知が送信されます。
(メールアドレスはBACSの [設定->各種メール設定->ロックへの更新失敗時のメール通知]で指定可能です。)
また実際に配信されているかどうかをAPIの暗証番号ステータス取得で確認することも可能です。APIの場合はデバイス毎の取得になり、キーとして暗証番号発行APIのレスポンスにあるpinIdを指定する必要があります。以下がAPIが返すステータス一覧(2023.06現在)です。ステータスはこちらより確認ください。
オフライン暗証番号の場合の注意事項
先程も記載したとおり、オフライン暗証番号の場合は削除ができません。言い換えるとキャンセルが発生したときにも削除ができないためお客様への通知を直前にするなど対策が必要です。
配信を待たずに今すぐ利用したい
利用開始直前に予約したお客様がおり、すぐに利用開始したい場合など、鍵の配信を最大２分間待つというのは現実的ではないケースも存在します。その場合はロック開閉API を利用して直接解錠（施錠）することが可能です。アプリなどにAPIを組み込むとき、解錠ボタンを提供し、ロック解錠APIを呼び出せば
オフラインQRによる解錠（QR1のオフライン利用限定）
弊社のQR1をご利用されている場合、オフラインで運用いだくことで即時にQRコードを発行可能です。
APIのレスポンスとして返却されるqrcodeからQRコードを生成してお客様に共有してもらえると解錠可能です。（オフライン暗証番号と同様に削除できないので、ユーザへのお渡しは注意が必要です。）
※Youtubeでも説明しています。
今回の記事についてYoutube: [KEYVOX] API連携方法を詳しく説明します でも説明していますのでこちらもぜひご覧になってください。
Multiple options can be selected.