センシング情報変換API：sensor/{device_id}
- 更新日 2024-10-21
概要
API名称
センシング情報変換API
説明
センサーのデータをjson形式で送信すると、項目名をRightARM共通英名に変換するAPI。 対応するデバイスは以下の通り。
| 対応デバイス | device_id |
|---|---|
| あぐりログ | agri_log |
| プロファインダー（ver.1） | profinder_v1 |
| プロファインダー（ver.2） | profinder_v2 |
| プロファインダー（ver.3） | profinder_v3 |
| プロファインダー（ver.4） | profinder_v4 |
| プロファインダーNext80 | profinder_next80 |
| ゼロアグリ | zero_agri |
| ※その他 |
※ほかに対応しているデバイスもございますので、別途お問い合わせください。
■API使用方法
POSTメソッドにより、変換対象のデータ登録を行ってください。
受付ID（reception_id）が返却されますので、その受付IDを指定してGETメソッドをご利用いただきますと、変換結果を取得することができます。
※サンプルコードを公開していますので、ご参照ください。
APIの紹介 : センシング情報変換APIの利用サンプルコード
データの更新頻度
ー
カテゴリー
添付ファイル
ー
関連メソッド
リクエスト
URL
https://api.wagri.net/API/Individual/terasuma/SensorConverter/prd/v1/sensor/{device_id}
説明
変換対象のデータを登録するメソッド。データ量は2MB（※）が上限。
※2MBより大きいデータサイズを取り扱いたい場合は、別途お問い合わせください。
HTTPメソッド
POST
パラメータ
URLデータ定義
デバイスID
| 名称 | 型 | サイズ | 値の説明 |
|---|---|---|---|
| device_id | デバイスID。デバイスの種類を指定する。 | string | Required |
URL説明
デバイスの種類を指定する。
リクエストデータ定義
変換対象のデータ
| 名称 | 型 | サイズ | 値の説明 |
|---|---|---|---|
| import_data | 変換対象のデータをjson形式で指定する。 | array | Required |
リクエスト説明
変換対象のデータ
呼出例
ー
レスポンス
レイアウト
レスポンスデータ定義
変換対象データ登録メソッドレスポンス
| 名称 | 型 | サイズ | 値の説明 |
|---|---|---|---|
| 200 OK | 正常に変換対象のセンサーデータ登録が完了しました。 | ||
| 400 Bad Request | リクエストの内容が不正です。リクエストデータを見直してください。 | ||
| 401 Unauthorized | 認証に失敗しました。認証情報が正しく設定されているかをご確認ください。 | ||
| 403 Forbidden | アクセス権限がありません。URLと認証情報が正しいかご確認ください。 | ||
| 413 Payload Too Large | 送信されたデータのサイズが大きすぎます。データサイズを減らしてください。 | ||
| 500 Internal Server Error | サーバー内で予期せぬエラーが発生しました。ベンダーにお問い合わせください。 |
レスポンス説明
変換対象データ登録メソッドレスポンス
レスポンス例
ー
ステータスコード
| コード | 名称 | 値の説明 |
|---|---|---|
| 400 | Bad Request | リクエストが不正です。 |
| 401 | Unauthorized | 認証情報が不正です。 |
| 403 | Forbidden | リソースのアクセスが禁止されています。 |
| 500 | Internal Server Error | サーバー内部でエラーが発生しました。 |
サンプルソースコード
ソースコード
ー