このページは、水田水管理プラットフォームを利用するための基本的な利用方法をまとめております。Getting Startedに沿って進めることで、デバイスから送信されたセンサーのデータをWeb APIにより取得することができます。

準備

水田水管理プラットフォームのご利用にあたっては、以下の準備が必要になります。いずれも、IIJよりあらかじめご連絡致します。

API Tokenの発行

IIJよりご連絡するAPI KeyとAPI Secretを用いて、API Tokenを発行します。

curlにより、以下のようなリクエストをします。< > 部分を文字列に置き換えてください。

curl -X POST -H 'Content-Type:application/json' -d "{\"api_key\": \"<お客様のAPI Key>\", \"api_secret\": \"<お客様のAPI Secret>\"}" https://api.agri.iij.jp/v1/auth

以下のようなレスポンスが返ります。

{
	"api_key": "お客様のAPI Key",
	"api_token": "発行したAPI Token",
	"expired": 有効期限(Unixタイムスタンプ)
}

以降、発行したAPI TokenをWeb APIの認可に利用することができます。なお、API Tokenの有効期限は発行から90日です。

センサーのデータを取得する

curlにより、以下のようなリクエストをします。

curl -X GET -H "Content-type: application/json" -H "Authorization: Bearer <発行したAPI Token>" https://api.agri.iij.jp/v1/sensors

レスポンスで、お客様の所持するセンサー一覧を取得できます。センサーの情報には、以下のような情報が含まれています。

• センサーID
• LoRa devaddr
• センサー名
• センサーの緯度・経度
• データの最新値

任意のセンサーの時系列データを取得する

センサーのデータの最新値だけではなく、時系列データを取得するには、以下のようにリクエストします。

curl -X GET -H "Content-type: application/json" -H "Authorization: Bearer <発行したAPI Token>" https://api.agri.iij.jp/v1/sensors/<センサーID>

レスポンスで、当該センサーIDの時系列データを取得できます。デフォルトでは直近24時間のデータを降順で表示しますが、クエリパラメータを指定することで遡って取得することも可能です。

利用できるWeb APIの詳細については、「Web API」をご参照ください。