ハウス環境モニタサービス API仕様

　本書はハウス環境モニタサービス（以下、本サービス）において計測器からの測定値/画像情報を受け付けるWeb APIの仕様を記載しています。

1. APIについて

　本サービスではハウスに設置された計測器の測定値/画像情報を記録・活用するため、測定値/画像情報を次のWeb APIで受け付けます。

計測値受付API
画像受付API

2. 計測値受付API

2-1. API仕様

項目	仕様
プロトコル	HTTPS
メソッド	GET または POST
リクエストURL	https://asia-northeast1-vhousem.cloudfunctions.net/w
認証	後述するパラメーター(did, pc)により認証
レスポンスデータ形式	MIMEタイプ: text/plain、エンコード: utf-8
送信可能間隔	送信間隔は１分以上開けてください。また、１時間に送信可能な回数は最大６回です。

2-2. パラメーター

2-2-1. 説明

パラメーター	必須	定義
did	○	計測器ID。計測器に固有のIDです。アプリ画面の [設定 > 計測器一覧] に表示される8桁の文字列です。
pc	○	パスコード。計測器に固有の情報です。アプリ画面の [設定 > 計測器一覧 > (任意の計測器)] に表示される「送信パスコード」を指定してください。
ht		ハウス内気温[度]。-50.0〜100.0の値を指定してください。
st		地温[度]。-50.0〜100.0の値を指定してください。
ot		外気温[度]。-50.0〜100.0の値を指定してください。
h		ハウス内湿度[%]。0〜100の値を指定してください。
sm		土壌水分[%]。0〜100の値を指定してください。
dt		計測器内温度[度]。-50.0〜100.0の値を指定してください。
wifi		wi-fi電波強度[dBm]。-200〜0の値を指定してください。

2-2-2. 例

https://asia-northeast1-vhousem.cloudfunctions.net/w?did=XXXXXXXX&pc=1234567890&ht=22.1&st=23.2&h=24&sm=25&ot=26.3&dt=27.4&wifi=-88

2-2-3. 送信テスト

　アプリの設定画面＞計測器一覧＞計測器を選択し「テスト計測値送信」をタップすることで、実際に送信テストを行うことができます。

2-3. レスポンス

※4. APIレスポンス仕様 参照

3. 画像受付API

3-1. API仕様

項目	仕様
プロトコル	HTTPS
メソッド	POST
リクエストURL	https://asia-northeast1-vhousem.cloudfunctions.net/i
認証	Basic認証。・ユーザーIDには計測器IDを設定。計測器IDは計測器に固有のIDです。アプリ画面の [設定 > 計測器一覧] に表示される8桁の文字列です。・パスワードにはパスコードを設定。パスコードは計測器に固有の情報です。アプリ画面の [設定 > 計測器一覧 > (任意の計測器)] に表示される「送信パスコード」を設定してください。
リクエスト MIMEタイプ	multipart/form-data
画像形式(Content-Type)	image/jpeg ファイルサイズ最大2MB
レスポンスデータ形式	MIMEタイプ: text/plain、エンコード: utf-8
送信可能間隔	送信間隔は１分以上開けてください。また、１時間に送信可能な回数は最大６回です。

3-2. レスポンス

※4. APIレスポンス仕様 参照

4. APIレスポンス仕様

API呼び出し結果を判定するためのHTTPステータスとレスポンスbodyの詳細を説明します。

2-3-1. 200 OK

　送信された情報が記録されました。

2-3-2. 400 Bad Request

body	説明
E01	’did’パラメーターが設定されていません。アプリの設定画面から利用可能な計測器の計測器IDを設定してください。
E07	計測器IDまたはパスコードに誤りがあります。アプリの設定画面から利用可能な計測器の計測器ID ‘did’ とパスコード ‘pc’ パラメーターを設定してください。
E09	パスコードが設定されていません。 ‘pc’ パラメーターを設定してください。
E13	’did’パラメータの値が不正です。アプリの設定画面から利用可能な計測器の計測器IDを設定してください。
E14	’ht’パラメータの値が不正です。-50〜100の値を設定してください。
E15	’st’パラメータの値が不正です。-50〜100の値を設定してください。
E16	’h’パラメータの値が不正です。0〜100の値を設定してください。
E17	’sm’パラメータの値が不正です。0〜100の値を設定してください。
E18	’ot’パラメータの値が不正です。-50〜100の値を設定してください。
E19	’dt’パラメータの値が不正です。-50〜100の値を設定してください。
E20	’wifi’パラメータの値が不正です。-200〜0の値を設定してください。
E21	’pc’パラメータの値が不正です。アプリの設定画面から計測器の送信パスコードを確認し設定してください。
EA0	HTTPヘッダに’Authorization’がありません。ユーザーIDに計測器ID、パスワードにパスコードを設定してください。
EA1	’Authorization’ヘッダに計測器ID、パスコードのいずれか、または両方が設定されていません。ユーザーIDに計測器ID、パスワードにパスコードを設定してください。

2-3-3. 403 Forbidden

body	説明
E04	‘did’ に指定された計測器のライセンスが無効です。アプリからライセンスを購入してください。

2-3-4. 405 Method Not Allowed

body	説明
E08	無効なHTTP Methodです。GET、または、POSTを利用してください。

4-5. 429 Too Many Requests

body	説明
E03	アクセスが多すぎます。１時間にアクセス数は最大６回までです。また、アクセス間隔は1分以上空けてください。
E11	アクセスが多すぎます。１時間にアクセス数は最大６回までです。また、アクセス間隔は1分以上空けてください。

4-6. 500 Internal Server Error

body	説明
E91,E93,E94	システムに問題が発生しました。しばらく経ってから再度アクセスしてください。
E92	計測器の設定に問題があります。アプリの設定画面から計測器を選択し、「設定先ハウス」を一度「ハウスに設置しない」を選択して設定画面に戻ってください。次に、再度、該当する計測器を選択し、「設定先ハウス」に任意のハウスを設定してください。
E95	画像情報に問題あがあります。画像はJPEG形式、ファイルサイズは2MBまでです。送信した画像ファイルをご確認ください。

更新履歴

2022/11/24 初版
2024/8/10 画像受付API仕様を追記