APIのレスポンスとして、正常に通信ができなかった場合のエラーコードの一覧です。
API利用時に問題があった場合、HTTPステータスコードは正常時の”200”と異なり、エラーのコードで返ってきます。
またその際は、下記のようなエラーメッセージが含まれるjson形式のレスポンスが返ってきます。
HTTP/1.1 400 Bad Request
Server: api.webstorage.jp
Content-Type: application/json; charset=utf-8
X-RateLimit-Limit: 120
X-RateLimit-Reset: 60
X-RateLimit-Remaining: 107
{
"error":{
"code": 400,
"message": "リクエストされた内容がフォーマットエラーです。"
}
}
エラーが発生した場合に返ってくるエラーコードとその内容について説明します。
| HTTP Status Code | エラー コード | エラー メッセージ | 説明 |
|---|---|---|---|
| 400 Bad Request | 400 | リクエストされた内容がフォーマットエラーです。 | リクエストしたパラメータにおいて、不足、形式違いなどの問題がある場合にこのエラーとなります。 |
| 401 Unauthorized | 401 | 認証情報に誤りがあります。 | 指定されたAPI KEY、ログインID、パスワードのいずれかに間違いがある場合にこのエラーとなります。 |
| 403 Forbidden | 403 | HTTPSにて通信ください。 | APIに対してHTTPでアクセスするとこのエラーとなります。 各APIについてはHTTPSでのアクセスが必須となっております。 |
| 415 Unsupported Media Type | 415 | リクエストされた内容をJSON形式として扱えません | リクエストしたパラメータが正しいJSON形式になっていない場合にこのエラーとなります。 |
| 429 Too Many Requests | 429 | APIの利用上限を超過しています。 | 各APIで設定されているレートリミットの上限に達している場合にこのエラーとなります。 レスポンスヘッダのX-RateLimit-***の状況などをご確認の上で、しばらく時間をおいてアクセスしてください。 |
| 503 Service Unavailable | 503 | サーバ側の処理で問題が発生しました。 | 弊社サーバ側にて何らかの問題が発生している場合にこのエラーとなります。 しばらくして改めてアクセスするか、問題が継続する場合には弊社サポートまでお問い合わせください。 |
APIにより取得したGraph Data内のエラーコードについて。
| エラー コード |
エラー メッセージ |
説明 |
|---|---|---|
| E0 | Communication Error | 親機と子機との通信エラー時に発生 |
| E1 | Sensor Error | センサーが故障したり、接続されていない場合に発生 |
| E2 | Under Range Error | 測定範囲外(アンダー)の場合に発生 |
| E3 | Over Range Error | 測定範囲外(オーバー)の場合に発生 |