Device - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki

スマートデバイスへの接続関連の機能を提供するAPI。

API	概要
POST /gotapi/device/pairing	スマートデバイスとペアリングする。
DELETE /gotapi/device/pairing	スマートデバイスとペアリングを解除する。

one-shot

スマートデバイスとペアリングする。

このAPIが実行される契機でプラグイン側でスマートデバイスとの接続処理を行わせる。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。 ペアリング対象スマートデバイス

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

one-shot

スマートデバイスとペアリングを解除する。

このAPIが実行される契機でプラグイン側でスマートデバイスとの接続を解除する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。 ペアリング解除対象スマートデバイス

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}