おんどとり Web Storageで管理されている機器の最新の現在値を取得します。
おんどとり Web Storageにログイン後に表示される、現在値の一覧と同等の情報が取得可能です。
※警報に関する情報は含まれておりません。警報情報の取得については今後のバージョンアップにて対応予定です。
https://api.webstorage.jp/v1/devices/current
参照専用IDでもご利用できます。
10回/120秒
おんどとり Web Storageへデータを自動送信する場合の送信間隔はTR-7wb/nw/wfシリーズなどの1分間隔が最短間隔です。
このような毎分更新される機器の最新状況を取得する運用をカバーできるように設計しました。
それぞれの機器の更新タイミングのずれもありますが、基本的には2分間に2～5回ほど現在値を取得すればおおよその状況が把握できることを想定した利用制限となります。
| 項目名 | 値 |
|---|---|
| HTTP Method | POST |
| X-HTTP-Method-Override | GET |
| Host | api.webstorage.jp:443 |
| Content-Type | application/json |
| パラメータ名 | 型 | 要否 | デフォルト値 | 説明 |
|---|---|---|---|---|
| api-key | string(45文字) | 必須 | --- | 取得済みのAPI KEY |
| login-id | string(8文字) | 必須 | --- | 利用者ID。参照専用IDでも可。 |
| login-pass | string(4~16文字) | 必須 | --- | 上記利用者IDに対するパスワード。 |
| remote-serial | 配列:string(8文字) | --- | 子機シリアル番号で絞り込みをしたい場合に指定します。配列による複数指定が可能です。(*1) | |
| base-serial | 配列:string(8文字) | --- | 親機シリアル番号で絞り込みをしたい場合に指定します。配列による複数指定が可能です。(*1) |
(*1) remote-serial/base-serialについて、複数指定が可能です。ただし、remote-serialとbase-serialを同時に指定しないでください。remote-serialだけの指定、base-serialだけの指定、もしくはどちらも指定しないでください。
remote-serialを指定する場合にはすでに機器を特定しているため、base-serialの指定は不要です。
なおシリアル番号を指定する場合、指定するシリアル番号が1つであっても配列として記述ください。（下記のリクエスト例を参照ください）
リクエストヘッダ
POST /v1/devices/current HTTP/1.1 Host: api.webstorage.jp:443 Content-Type: application/json X-HTTP-Method-Override: GET
リクエストボディ
[1．全ての機器情報を取得する場合]
{
"api-key":"73pfobnche8d1p6laqnemsbnpkght3bjv047oid6p2sg3",
"login-id":"tbzz9999",
"login-pass":"ppaasswwoorrdd"
}
[2．特定のシリアル番号の子機の機器情報を複数取得する場合]
{
"api-key":"73pfobnche8d1p6laqnemsbnpkght3bjv047oid6p2sg3",
"login-id":"tbzz9999",
"login-pass":"ppaasswwoorrdd",
"remote-serial":["52120001","52120002"]
}
※この例では、TR-71wf[52120001]とTR-71wf[52120002]の2台分のデータを取得。
[3．特定のシリアル番号の親機と子機の機器情報を取得する場合]
{
"api-key":"73pfobnche8d1p6laqnemsbnpkght3bjv047oid6p2sg3",
"login-id":"tbzz9999",
"login-pass":"ppaasswwoorrdd",
"base-serial":["52A010D0"]
}
※この例では、弊社デモ機であるRTR-500AW[52A010D0]に登録されている子機のデータ全てを取得。
WindowsやMac端末などのコマンドラインから利用可能なcurlコマンドを使ったリクエスト例です。リクエストヘッダとリクエストボディを含む形でのコマンド例になっています。
[1．全ての機器情報を取得する場合]
curl -X POST \
-H "Content-Type: application/json" \
-H "X-HTTP-Method-Override: GET" \
-d '{"api-key":"73pfobnche8d1p6laqnemsbnpkght3bjv047oid6p2sg3","login-id":"tbzz9999","login-pass":"ppaasswwoorrdd"}' \
https://api.webstorage.jp:443/v1/devices/current
[2．特定のシリアル番号の子機の機器情報を複数取得する場合]
curl -X POST \
-H "Content-Type: application/json" \
-H "X-HTTP-Method-Override: GET" \
-d '{"api-key":"73pfobnche8d1p6laqnemsbnpkght3bjv047oid6p2sg3","login-id":"tbzz9999","login-pass":"ppaasswwoorrdd","remote-serial":["52120001","52120002"]}' \
https://api.webstorage.jp:443/v1/devices/current
[3．特定のシリアル番号の親機と子機の機器情報を取得する場合]
curl -X POST \
-H "Content-Type: application/json" \
-H "X-HTTP-Method-Override: GET" \
-d '{"api-key":"73pfobnche8d1p6laqnemsbnpkght3bjv047oid6p2sg3","login-id":"tbzz9999","login-pass":"ppaasswwoorrdd","base-serial":["52A010D0"]}' \
https://api.webstorage.jp:443/v1/devices/current
| 項目名 | 値 | 説明 |
|---|---|---|
| HTTP status code | (**) | HTTPステータスコード |
| Content-Type | application/json; charset=utf-8 | 文字コードはUTF-8 |
| X-RateLimit-Limit | (integer) | 単位時間あたりのアクセス上限 |
| X-RateLimit-Reset | (integer) | 単位時間の秒数 |
| X-RateLimit-Remaining | (integer) | 単位時間あたりのアクセス残数 |
(**) HTTPステータスコードが「200」であれば正常に処理が完了しています。それ以外のHTTPステータスコードが返ってきた場合にはエラーにより処理されていません。 エラー発生時にはエラー情報を含むJSONデータが返ってきます。
HTTP/1.1 400 Bad Request
Server: api.webstorage.jp
Content-Type: application/json; charset=utf-8
X-RateLimit-Limit: 60
X-RateLimit-Reset: 60
X-RateLimit-Remaining: 57
{
"error":{
"code": エラーコード,
"message": "エラーの内容"
}
}
| 項目名 | 型 | 説明 |
|---|---|---|
| devices | 配列 | 機器(子機)情報。機器の数が要素数となる配列。 親機と子機と組み合わせる機器の場合、子機の情報となります。 |
| devices.num | string (*1) | 機器(子機)番号。単体動作機器の場合は0固定です。 |
| devices.serial | string(8文字) | 機器(子機)のシリアル番号 |
| devices.model | string(32文字) | 機器(子機)のモデル名称 |
| devices.name | string(32文字) | 機器(子機)の機器名称 |
| devices.battery | string (*1) | 機器(子機)の電池残量 TR7A、TR-7wb/nw/wfシリーズ 1: すぐに交換が必要 | 2: 早めに交換が必要 | 3: 半分以下 | 4: 少なくなり始め | 5: 十分あり RTR500Bシリーズ、RTR-500シリーズ、TR4Aシリーズ 1-3: すぐに交換が必要 | 4: 早めに交換が必要 | 5: 十分あり |
| devices.rssi | string (*1) | 機器(子機)の電波強度 |
| devices.time_diff | string (*1) | 機器の時差情報[単位は分]。子機の場合は親機に設定されている時差情報。 |
| devices.std_bias | string (*1) | 機器の標準時差[単位は分]。子機の場合は親機に設定されている標準時差。 |
| devices.dst_bias | string (*1) | 機器の夏時間時差[単位は分]。子機の場合は親機に設定されている夏時間時差。 |
| devices.unixtime | string (*1) | 機器(子機)の最新測定値の時刻(unixtime) |
| devices.channel | 配列 | 機器(子機)の測定チャンネル情報。測定チャンネル数が要素数となる配列。 |
| devices.channel.num | string (*1) | チャンネル番号 |
| devices.channel.name | string(32文字) | チャンネル名称 |
| devices.channel.value | string(*1)(*2) | 最新測定値 |
| devices.channel.unit | string(20文字) | 測定単位。スケール変換などを行っている場合には変換後の測定単位となります。 |
| devices.baseunit | object | 親機情報。 親機がない単体動作機器でも、単体動作機器の情報が親機情報として入ります |
| devices.baseunit.serial | string(8文字) | 親機のシリアル番号（単体動作機器は、機器のシリアル番号） |
| devices.baseunit.model | string(32文字) | 親機のモデル名称（単体動作機器は、機器のモデル名称） |
| devices.baseunit.name | string(32文字) | 親機の機器名称（単体動作機器は、機器の機器名称） |
| devices.group | object | グループ情報。 グループ設定がない機器でも番号0扱いで1つの要素となります。 |
| devices.group.num | string (*1) | グループ番号。（グループ設定がない機器の場合は、0固定) |
| devices.group.name | string(16文字) | グループ名称。（グループ設定がない機器の場合は、空データ) |
(*1) 値は数値ですが、型は文字型となっています。
(*2) 計測値が取得できた場合は文字型の数値が返りますが、エラーが発生している場合はEから始まるエラー値が返ります。
※単体動作機器とは、TR7A、TR-7wb/nw/wfシリーズ、TR4AシリーズやTR-700Wシリーズのように単体でおんどとり Web Storageへデータ送信する機器のことです。
{
"devices": [{
"num": "2",
"serial": "52BC078B",
"model": "RTR-503",
"name": "02",
"battery": "5",
"rssi": "5",
"time_diff": "540",
"std_bias": "0",
"dst_bias": "0",
"unixtime": "1476150408",
"channel": [{
"num": "1",
"name": "",
"value": "23.9",
"unit": "C"
}, {
"num": "2",
"name": "",
"value": "40",
"unit": "%"
}
],
"baseunit": {
"serial": "529C0051",
"model": "RTR-500NW",
"name": "RTR-500NW_529C0051"
},
"group": {
"num": "0",
"name": "Group1"
}
}, {
"num": "1",
"serial": "52BC1495",
"model": "RTR-503",
"name": "01",
"battery": "5",
"rssi": "5",
"time_diff": "540",
"std_bias": "0",
"dst_bias": "0",
"unixtime": "1476150411",
"channel": [{
"num": "1",
"name": "",
"value": "23.9",
"unit": "C"
}, {
"num": "2",
"name": "",
"value": "39",
"unit": "%"
}
],
"baseunit": {
"serial": "529C0051",
"model": "RTR-500NW",
"name": "RTR-500NW_529C0051"
},
"group": {
"num": "0",
"name": "Group1"
}
}
]
}