2.2 デバイスの API
本節のデバイスのAPIは、SensePass/SenseThunder 2.x バージョンでは現在利用できません
2.2.1 ゲートウェイの追加 (/api/v3/gateway/add)
開発中のため当APIは現在利用できません
概要
ゲートウェイデバイスを追加します。
リクエストアドレスの例
https://HOST:PORT/api/v3/gateway/add
リクエスト方法
POST application/json
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
2.2.2 カメラの追加 (/api/v3/camera/add)
開発中のため当APIは現在利用できません。
概要
カメラを追加します。事前にゲートウェイデバイスを追加する必要があります。
リクエストアドレスの例
https://HOST:PORT/api/v3/camera/add
リクエスト方法
POST application/json
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
2.2.3 デバイスの更新 (/api/v3/device/update)
概要
デバイス情報を更新します(ゲートウェイデバイスはグループに連携できません) 。
v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。
リクエストアドレスの例
https://HOST:PORT/api/v3/device/update
リクエスト方法
POST application/json
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
group フィールドの説明
エラーレスポンスのフィールド
2.2.4 デバイスの削除 (/api/v3/device/delete)
概要
デバイス(ゲートウェイまたはカメラデバイス)を削除します。
v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。
リクエストアドレスの例
https://HOST:PORT/api/v3/device/delete
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
2.2.5 サブカメラのリストの取得 (/api/v3/gateway/cameraList)
開発中のため、当APIは現在利用できません
概要
カメラのリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/gateway/cameraList
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
2.2.6 親デバイスの取得 (/api/v3/camera/gatewayList)
開発中のため、当APIは現在利用できません。
概要
関連する親デバイスを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/camera/gatewayList
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
cameraフィールドの説明
エラーレスポンスのフィールド
2.2.7 デバイスリストの表示 (/api/v1/device)
概要
デバイスリストを表示します。デフォルトの順序は ID の降順です。
リクエストアドレスの例
https://HOST:PORT/api/v1/device
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
data.dataフィールドの説明
device_type フィールドの説明
device フィールドの説明
group フィールドの説明
エラーレスポンスのフィールド
2.2.8 リモート構成(一括複数アップデート)(/api/v2/device/update/config/batch)
概要
同じタイプのオンラインデバイスに対してリモート構成コマンドを送信します。一括送信に対応しています。
現在、下記のデバイスをサポートしています。SensePass、SenseThunder GE、SenseThunder Mini GE。
この機能をサポートするデバイスの最低バージョンは、SensePass(v1.2.3)、SenseThunder GE (v1.0.3)、SenseThunder Mini GE (v1.0.1)。
リクエストアドレスの例
https://HOST:PORT/api/v2/device/update/config/batch
リクエスト方法
POST application/json
リクエストパラメーター
デバイス型番識別子
構成項目とパラメーターの説明
認証パラメーター
リクエスト例
通常のレスポンス
エラーレスポンスのフィールド
2.2.9 リモートドアオープン (/api/v2/device/open)
概要
オンラインデバイスにドアオープンコマンドを送信します。
リクエストアドレスの例
https://HOST:PORT/api/v2/device/open
リクエスト方法
POST: form-data
リクエストパラメーター
認証パラメーター
通常のレスポンス
エラーレスポンスのフィールド
2.2.10 通知の送信 (/api/v3/device/notify)
開発中のため当APIは現在利用できません
概要
オンラインデバイスに通知メッセージを送信します。カスタマイズコマンドに対応しています。
リクエストアドレスの例
https://HOST:PORT/api/v3/device/notify
リクエスト方法
POST application/json
リクエストパラメーター
認証パラメーター
通常のレスポンス
エラーレスポンスのフィールド
リクエスト例
2.2.11 デバイスLDIDの取得(/api/v3/device/ldid)
概要
デバイスのシリアル番号でデバイスのLDIDを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/device/ldid
リクエスト方法
GET
リクエストパラメーター
デバイス型番識別子
認証パラメーター
通常のレスポンス
レスポンスのフィールド
最終更新