今すぐ最初のQRコードスキャンをしてみよう。無料デモ機貸出中

新着情報一覧に戻る
|KEYVOX編集部

KEYVOX APIに新機能:場所とドアの管理を可能にする新たなエンドポイントを公開しました

リリースノートAPI
KEYVOX APIに新機能:場所とドアの管理を可能にする新たなエンドポイントを公開しました

# KEYVOX APIに新機能:場所とドアの管理を可能にする新たなエンドポイントを公開しました

平素よりKEYVOXをご利用いただき、誠にありがとうございます。

この度、KEYVOX APIに、施設(場所)およびスマートロック(ドア)の管理を可能にする新たなエンドポイントを追加しました。これにより、お客様のシステムからKEYVOXの基盤機能をより柔軟に操作できるようになります。

変更内容

WEB管理画面「BACS」上で管理されている「場所」と「ドア(Unit)」に関する、以下のエンドポイントが追加されました。

場所に関するエンドポイント

* 場所一覧取得 (`/v1/place/list`)
* BACSに登録されている場所の一覧を取得します。ページネーション、施設タイプによるフィルタリングに対応しています。
* 場所詳細情報取得 (`/v1/place/detail`)
* 指定した場所の詳細情報を取得します。利用規約、ブランドカラー、ロゴ画像などの全フィールドを含みます。
* 場所作成 (`/v1/place/addPlace`)
* 新しい場所を登録します。施設名、住所、電話番号、施設タイプなどを指定して登録できます。
* 場所更新 (`/v1/place/updatePlace`)
* 登録済みの場所情報を更新します。施設名や住所の変更、利用規約の更新などに利用できます。
* 場所削除 (`/v1/place/deletePlace`)
* 指定した場所を削除します。ドアが紐づいている場所は削除できません。先にドアを削除してください。

ドア(Unit)に関するエンドポイント

* ドア一覧取得 (`/v1/unit/list`)
* BACSに登録されているドアの一覧を取得します。場所ごとのフィルタリング、ページネーションに対応しています。
* ドア詳細情報取得 (`/v1/unit/detail`)
* 指定したドアの詳細情報を取得します。紐づけられたデバイス情報はこのエンドポイントでのみ取得できます。
* ドア作成 (`/v1/unit/addUnit`)
* 新しいドアを登録します。場所に紐づけてドア名やドアタイプを指定して登録できます。
* ドア更新 (`/v1/unit/updateUnit`)
* 登録済みのドア情報を更新します。ドア名やドアタイプの変更に利用できます。
* ドア削除 (`/v1/unit/deleteUnit`)
* 指定したドアを削除します。
* ドアとロックデバイスの紐づけ (`/v1/unit/bindDevice`)
* ドアにスマートロックデバイスを紐づけます。1つのドアに複数のデバイスを紐づけることも可能です。デバイスの紐づけ変更や解除もこのエンドポイントで行えます。

補足

本APIの詳細および実装方法については、操作マニュアルをご参照ください。
APIの利用にはKEYVOXアカウントとAPIキーが必要です。

今後もお客様のご要望にお応えできるよう、機能改善に努めてまいりますので、引き続きKEYVOXをよろしくお願い申し上げます。