正式には、Withings Body Metrics Services API(WBS API)というらしい。
- 非商用の場合は無料。
- RESTベース、HTTP POSTもしくはGETでリクエストを送信。
リクエストフォーマット
http://wbsapi.withings.net/[service_name]?action=[action_name]&[parameters]
- [service_name]:リクエストするサービス名
- [action_name]:サービス上で実行するアクション(必須)
- 例えば, userサービスの場合、getbyuseridとupdateを持つ.
- [parameters]:サービスに渡す必須もしくはオプションのパラメータ. OAuth関連のパラメータはここに記述(必須)
レスポンスフォーマット
- JSON形式
{"status":0, "body":{} }
- bodyフィールドは、リクエストしたservice/actionに依存して空のこともある.
- statusフィールドはmandatory
- 0の場合はリクエスト成功を意味し、その他の数値は失敗を意味する.
- サンプル
- リクエスト
-
- レスポンス
{"status":0}
認証
- ユーザとアカウント
- 1アカウントは複数ユーザで使われていることもある
- ユーザはuseridでユニークに区別され、Oauth認証情報を通してユーザと紐付けされる
- 必須のOauthパラメータ
- oauth_consumer_key
- oauth_token
- oauth_nonce
- oauth_version
- oauth_signature_method
- oauth_timestamp
- oauth_signature
- 完全なリクエスト例
- パラメータの順番重要!
- クエリのすべてのパラメータはアルファベット順とする
通知
- 計測データ更新の通知
- モニタするユーザ毎にアプリケーションがsubscribeする
- 1ユーザがsubscribeできるアプリは16個まで
サービス一覧
- 詳細はドキュメントで.
- measure/getmeas
- user/getuserid
- notify/subscribe
- notify/revoke
- notify/get
- notify/list