はじめにお読みください

概要

おんどとり WebStorage API(以後、公開API)は、おんどとり WebStorageプラットフォームからダイレクトにデータ取得が可能なAPIです。
従来からご利用者様にて要望が多かった、データの一斉取得などがより便利に利用できることを目的として提供を開始しました。

最新の機器状態の取得、特定機器の測定値の取得、警報一覧の取得など、ご利用者様の様々な用途に利用可能なAPIを順次提供していく予定です。

公開APIでデータ取得ができる機種について

おんどとりWebStorageに対応している機器において、通信方式の違いやデータの格納方法の違いにより公開APIの対応状況が異なりますので、下記の対応状況をご確認ください。

機種対応状況
TR7シリーズ 現在値の取得
現在値グラフデータの取得(最新300件分)
現在値グラフデータの取得
TR4シリーズ 現在値の取得
現在値グラフデータの取得(最新300件分)
現在値グラフデータの取得
RTR-500シリーズ 現在値の取得
TR-700Wシリーズ 現在値の取得
TR-5i/TR-7Uiシリーズ 対応しているAPIはありません

※ TR-5i/TR-7Ui シリーズについては公開APIでの対応予定はありません。

使い方

公開APIの利用方法について説明します。
詳細については各APIの詳細ページをご覧ください。ここではAPIを利用するための流れを説明します。

1.API KEYの取得

公開APIを利用するにあたって、はじめにおんどとり WebStorage Serviceへログインし、管理画面よりAPI KEYを取得してください。
API KEYは、下記のような45文字の文字列です。
このAPI KEYは利用者ID毎に割り当てられる大事な識別情報ですので、他人に利用させることのないように大切に管理をお願いします。

73pfobnche8d1p6laqnemsbnpkght3bjv047oid6p2sg3

※上記はサンプルであり、実際のリクエスト形式・フォーマットと異なる場合がありますので、詳細は各APIのページにてご確認ください。

2. 各APIへのアクセス

取得したAPIキーと利用者ID(もしくは参照専用ID)とパスワードを使って、ご希望のAPIへアクセスしてください。

実際には次のようなリクエストを行うことになります。

例) シリアル番号52120001の機器の、最新100件の現在値グラフの値を取得する。

POST /v1/devices/latest-data HTTP/1.1
Host: api.webstorage.jp:443
Content-Type: application/json
X-HTTP-Method-Override: GET

{
"api-key":"73pfobnche8d1p6laqnemsbnpkght3bjv047oid6p2sg3",
"login-id":"tbzz9999",
"login-pass":"ppaasswwoorrdd",
"remote-serial":["52120001"]
}

※上記はサンプルであり、実際のリクエスト形式・フォーマットと異なる場合がありますので、詳細は各APIのページにてご確認ください。

この場合のレスポンスはJSON形式の下記のようなものが返ってきます。
※APIによってはレスポンス形式の選択が可能です。

HTTP/1.1 200 OK
Server: api.webstorage.jp
Content-Type: application/json; charset=utf-8
X-RateLimit-Limit: 60
X-RateLimit-Reset: 60
X-RateLimit-Remaining: 57

{
	"serial":"52120001",
	"model":"TR-71wf",
	"name":"東側の窓の外",
	"channel":[
		{
			"name":"temp",
			"num":0,
			"unit":"C"
		}],
	"data":[
		{
			"unixtime": 123456789,
			"ch1":23.5
		},{
			"unixtime": 123456800,
			"ch1":25.5
		}, ... ,{
			"unixtime": 123456999,
			"ch1":21.5
		}
	]
}


※上記はサンプルであり、実際のリクエスト形式・フォーマットと異なる場合がありますので、詳細は各APIのページにてご確認ください。

WebStorage APIの利用に際して

お客様環境のHTMLコンテンツからのJavaScriptによるアクセスに関して

公開APIは、お客様環境のシステムからのデータ取得リクエストに対応することを主体としてサービス開始します。
お客様環境にあるブラウザで参照できるHTMLコンテンツに埋め込まれたJavaScriptにて、公開APIからデータを取得しそれをブラウザ上で表示させる、といった利用方法については現時点では提供しておりません。（よくあるブログパーツのようなものへ直接データ提供はできません。）
お客様環境のHTMLコンテンツ上にデータ表示を行いたい場合など、お客様環境のサーバサイドプログラムなどで弊社より取得したデータを一旦保存していただき、その保存データをご利用いただければと思います。

※ご利用者様のHTMLコンテンツに埋め込んだJavaScriptにてデータを利用したい場合、「よくある質問」に参考情報を掲載しております。

時間あたりの利用回数を制限しています (Rate Limit)

公開APIは、参照専用IDを含めた利用者ID単位でAPI別に単位時間を定めて利用制限を行っております。
公開APIのリソースを各利用者が公平に利用できるように設定した利用制限となりますのでご理解ください。

詳細な利用回数の上限などは各APIのページにて説明しておりますのでご確認ください。

MENU