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

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

KEYVOX API:場所およびドア管理に関する新エンドポイントを公開しました

リリースノートAPI
KEYVOX API:場所およびドア管理に関する新エンドポイントを公開しました

いつも「KEYVOX」をご利用いただき誠にありがとうございます。

この度、KEYVOX APIにおきまして、WEB管理画面「BACS」の場所(Place)およびドア(Unit)オブジェクトを操作するための新しいエンドポイントを公開いたしました。

今回のアップデートにより、外部システムとの連携において場所やドアの登録・管理をより柔軟かつ効率的に行っていただけるようになります。

新規公開されたエンドポイント

#### 場所(Place)関連
1. 場所一覧取得(/v1/place/list)

- BACSに登録されている場所の一覧を取得します。ページネーション、施設タイプによるフィルタに対応しています。
2. 場所詳細情報取得(/v1/place/detail)

- 指定した場所の詳細情報を取得します。利用規約、ブランドカラー、ロゴ画像などの全フィールドを含みます。
3. 場所作成(/v1/place/addPlace)

- 場所を新規作成します。施設名、住所、電話番号、施設タイプなどを指定して登録できます。
4. 場所更新(/v1/place/updatePlace)

- 登録済みの場所情報を更新します。施設名や住所の変更、利用規約の更新などに利用できます。
5. 場所削除(/v1/place/deletePlace)

  • 場所を削除します。

#### ドア(Unit)関連
6. ドア一覧取得(/v1/unit/list)

- BACSに登録されているドアの一覧を取得します。場所ごとのフィルタ、ページネーションに対応しています。
7. ドア詳細情報取得(/v1/unit/detail)

- 指定したドアの詳細情報を取得します。紐づけられたデバイス情報(devices)はこのエンドポイントでのみ取得できます。
8. ドア作成(/v1/unit/addUnit)

- ドアを新規作成します。場所に紐づけてドア名やドアタイプを指定して登録できます。
9. ドア更新(/v1/unit/updateUnit)

- 登録済みのドア情報を更新します。ドア名やドアタイプの変更に利用できます。
10. ドア削除(/v1/unit/deleteUnit)

- ドアを削除します。
11. ドアとロックデバイスの紐づけ(/v1/unit/bindDevice)

  • ドアにスマートロックデバイスを紐づけます。1つのドアに複数のデバイスを紐づけることも可能です。デバイスの紐づけ変更や解除もこのエンドポイントで行えます。

補足事項

  • 場所の削除(`/v1/place/deletePlace`)を行う際、ドアが紐づいている場所は削除できません。事前にドアを削除してから実行してください。
  • 各エンドポイントの利用方法やリクエスト・レスポンスの詳細については、APIドキュメントおよび操作マニュアルをご参照ください。

ブロックチェーンロックでは、お客様の利便性向上とシステム連携の拡張性強化に向け、引き続き機能改善を進めてまいります。今後ともKEYVOXをよろしくお願い申し上げます。