KEYVOXサービスではAPIを公開しており、APIを使った鍵の配信が可能です。
その前にまず、「鍵の配信って何ですか?」と聞かれることがあります。スマートロックには暗証番号(以降 鍵)を発行可能です。スマートロック単体で利用する場合は直接スマートロックデバイス(以降 デバイス)を操作して鍵を登録することが可能です。
しかし、弊社のKeyvoxサービスを使うとインターネット経由でデバイスに鍵を発行(削除)することが可能です。このことを「鍵の配信」と呼んでいます。
こちらの記事ではKEYVOX-APIを利用した鍵の配信について説明したいと思います。
鍵の配信にはオンライン・オフラインがあります。一言でいうと
まず前提条件として、APIからの鍵の配信は「ドア(部屋)」に対して実施します。「ドア」はKEYVOXで管理されている概念でドアに対してデバイスを関連付ける必要があります。この操作はBACSの画面から実施する必要があります。(操作方法はXXX参照)
ドアを特定するユニークキーは unitIdとなっています。部屋リスト取得API で取得可能です。
ここで取得した発行したいドアのunitIdと暗証番号(任意)、開始、終了時間を指定して、暗証番号発行APIを呼び出すことで鍵の発行が可能です。
APIが正常終了したあとに、鍵は即時に配信されるのではなく、一旦KEYVOXサーバ(以降 KEYVOX Cloud) が受信したあとにバッチ処理(2分毎)に配信を実施しますので実際に利用開始できるまで少し時間差があります。また、利用開始時間の72時間前より配信開始という条件があります。またAPI自体は「鍵の配信リクエストを正しく受け付けた」というだけで実際の配信を保証するものではありません。
配信が失敗すると指定したメールアドレス宛にエラー通知が送信されます。
(メールアドレスはBACSの [設定->各種メール設定->ロックへの更新失敗時のメール通知]で指定可能です。)