System

概要

DeviceConnectシステム情報を提供するAPI。

目次

API	概要
GET /gotapi/system	DeviceConnectシステム情報を提供するAPI。
PUT /gotapi/system/device/wakeup	デバイスプラグインの機能を有効にする。
DELETE /gotapi/system/events	リクエスト送信元のOriginに紐づくイベントを一挙に解除する。
PUT /gotapi/system/keyword	DeviceConnectシステムに対し、ユーザーが登録したキーワードの表示リクエストをする。

GET /gotapi/system

種別

one-shot

概要

DeviceConnectシステム情報を提供するAPI。

DeviceConnectシステムのバージョンやサポートするAPI一覧、 インストールされているプラグイン一覧などのアプリケーション情報を取得する。

リクエスト

物理名	データ型	必須	説明

レスポンス

論理名		物理名	データ型	必須	説明
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
プロファイル一覧		supports	array(string)	Yes	Device Connect Managerのサポートするプロファイル名の配列。
プラグイン一覧		plugins	array(object)	Yes	DeviceConnectシステムにインストールされているプラグインについての情報の配列。
	ID	id	string	Yes	DeviceConnectシステム上でプラグインを識別するためのID。
	名前	name	string	Yes	プラグインの名前。
	バージョン	version	string	Yes	プラグインのバージョン名。
	プロファイル一覧	supports	array(string)	Yes	プラグインのサポートするプロファイル名の配列。
	パッケージ名	packageName	string	No	DeviceConnectシステムの実行環境 (例:Android)でプラグインを識別するための名前。

PUT /gotapi/system/device/wakeup

種別

one-shot

概要

デバイスプラグインの機能を有効にする。

プラグインによっては、設定画面が起動してデバイスとの接続を行う。

リクエスト

物理名	データ型	必須	説明
pluginId	string	Yes

レスポンス

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

DELETE /gotapi/system/events

種別

one-shot

概要

リクエスト送信元のOriginに紐づくイベントを一挙に解除する。

デバイスプラグインの仕様によっては対応していない場合もある。

リクエスト

物理名	データ型	必須	説明

レスポンス

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

PUT /gotapi/system/keyword

種別

one-shot

概要

DeviceConnectシステムに対し、ユーザーが登録したキーワードの表示リクエストをする。

デフォルト値はDeviceConnectシステム側で設定しておくものとする。

リクエスト

物理名	データ型	必須	説明

レスポンス

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