データアダプター「Web API」の使い方についてご案内します。(2020-01-13 更新)
大まかな手順は以下となります。
conect+ Studioに「Web API」タイプのデータアダプターを登録し、「WebAPIキー」を取得します。
conect+ StudioにIoTデバイスのデータを登録します。
※ conect+ StudioのWeb APIは以下の2種類があります
Get:c+ Studioのデータを取り出す
Post:c+ Studioにデータを投稿・送信する
1.データアダプターの登録
データアダプタの登録手順は以下となります。
画面左のメニューから「データアダプター」を選択します。データアダプター画面が表示されますので、「データアダプターを追加」を選択します。
「WebAPI」を選択します。
データアダプターを登録します。この時、「WebAPIキー」が生成されます。
以上でデータアダプターの登録は完了です。
2.データの登録
続いて、conect+ StudioにIoTデバイスのデータを登録します。
サイドメニュー→データアダプターにて、Web APIのリファレンスを確認します。
リファレンスの確認は下の画像より参照します。
リファレンスを確認します。
- URL:Web APIのURLを確認します
- ワークスペースID:ご利用中のワークスペースIDを確認します
- Web APIキー:ご利用中のデータアダプター Web APIキーを確認します
以下のAPIでデータを登録します。
URL:
https://api.studio.conect.plus/sensingData/{{ワークスペースID}}/{{WebAPIキー}}/{{デバイスID}}/{{センサーID}}
ワークスペースID、Web APIキー:前ステップで取得したID
デバイスID:IoTデバイスの製造番号など、ユーザが設定する任意の値 (例:device01、Dev01等)
センサーID:センサー種別など、ユーザが設定する任意の値 (例:sensor01、Temp01等)
※デバイスID、センサーIDは、半角英数記号(-_!#$%&=@<>) で指定して下さい。
Method:
POST
Header:
Content-Type: application/json
Body:
{
"sensingAt": {{"YYYY-MM-DDThh:mm:ssTimeZone"}},
"value01": {{MeasuredValue}}
}
sensingAt:センサー計測日時をISO 8601形式で指定
value01:センサー計測値を設定(1つのセンサーIDにつき最大10件の設定が可能。加速度など1つのセンサーに複数の値を持つ場合に使用。センサー種別が異なる場合は別のセンサーIDとして指定)
Bodyのサンプル (位置情報を含めて送信しています)
{
"sensingAt": "2019-12-05T13:26:53.124+09:00",
"location": {
"latitude": 35.647785,
"longitude": 139.640898
},
"value01": 21.4
}
データの登録が正常に完了すると、デバイス画面にデバイスのデータ登録日時が表示されます。
(デバイス画面へは画面左メニューから「デバイス」を選択します。)
以上です。
なお、Web APIリファレンスでは、Get/Postのテストが可能です。
【Sensing Data】にて、【Try it out】ボタンをクリックするとテストモードになりますので、deviceIdとsensorID及びRequest Bodyに任意の値を入力し、【Execute】にて実行できます。
-------------------
c+ Liteをご利用している場合は、より簡単に連携することが可能です。
c+ Studioとc+ Liteの連携については、こちらの記事をご覧ください。