ライト API

照明を操作

照明デバイスを明るさ、色を操作します。

基本情報

APIパス : /gotapi/light

HTTPメソッド : POST

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン
lightId 文字列 クエリー 照明デバイスのID
color 文字列 クエリー 照明の色。RGBで指定。
brightness 文字列 クエリー 輝度。0.01〜1の間で指定
flashing 文字列 クエリー 点滅させる場合。ms単位でカンマ区切りで指定。

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
version 文字列

照明デバイスのステータスを変更

照明デバイスのステータスを変更します。基本的に照明をつける場合と同じです。

基本情報

APIパス : /gotapi/light

HTTPメソッド : PUT

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン
lightId 文字列 クエリー 照明デバイスのID
name 文字列 クエリー 照明機器の名前
color 文字列 クエリー 照明の色。RGBで指定。
brightness 文字列 クエリー 輝度。0.01〜1の間で指定
flashing 文字列 クエリー 点滅させる場合。ms単位でカンマ区切りで指定。

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
version 文字列

照明を消す

照明デバイスを消します。

基本情報

APIパス : /gotapi/light

HTTPメソッド : DELETE

リクエスト

HTTPヘッダー

ヘッダーの種類 内容
Content-Type application/json

パラメータ

キー 必須 場所 説明
serviceId 文字列 クエリー サービスIDを指定します
accessToken 文字列 クエリー 取得したアクセストークン
lightId 文字列 クエリー 照明デバイスのID

レスポンス

HTTPレスポンス

HTTPステータスコード 内容
200 HTTP経由でアクセスするファイル情報

エラーについては エラーについて を参照してください。

レスポンス内容

キー
result 数値
product 文字列
version 文字列