1
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

Withings APIの使い方|オリジナル健康アプリの第一歩

Last updated at Posted at 2024-02-23

はじめに

健康て大事ですよね。
リモートワークで動く機会が減り、体重が増えました。
ダイエットのためWithingsというメーカーの体重計を買いまして、
価格はおよそ1万円(ちょっとお高め)

Withings Body + フランス生まれのスマート体重計 ブラック Wi-Fi/Bluetooth対応 体組成計

このメーカーのデバイスはWebAPIを通じて自分の計測データを取得できるそうです。
自分だけのオリジナルなアプリが作れると思うとワクワクしますね。

Withings APIを使って体重データを取得する方法を紹介します。

Withings APIとは

Withins APIを使うとWithingsデバイスで集められた健康データにアクセスができます。

私であれば登録した基礎データ(身長など)や体重データを取得できるでしょう。

APIを通じて得られるデータは購入したデバイスによって変わります。
Withingsでは体重計以外にもスマートウォッチやスマート睡眠パッドが売られていて、扱いたいデータによって購入するデバイスを変えても面白いかもしれません。

APIを利用するには開発用アカウントを作成しアプリケーションを登録する必要があります。

開発用アカウントを作成する

はじめにWithingsの開発者ポータルにアクセスし、開発用アカウントを作成します。

アカウントを作成するときはSing In/Go to Developer Dashboard をクリックします。
スクリーンショット 2024-02-23 11.59.48.png

アプリケーションを作成する

アカウントを作るとAPIキーを発行できます。
Developer DashboardからCreate an applicationをクリックしアプリケーションを作成します。

スクリーンショット 2024-02-23 12.03.08.png

1.Application creationでは「Pubic API integration」を選びます。
スクリーンショット 2024-02-23 12.05.54.png

2.Informationではアプリ名、アプリ詳細、そしてリダイレクトURLを入力します。
リダイレクトURLについて私はlocalhostを指定しました。
認証コードを受け取れるアクセス先を指定してあげましょう。

リダイレクトURLの設定方法はこちらで紹介しているので是非見てください。
リダイレクトURLとは?URLを作成しアクセストークンを受け取る方法を紹介

スクリーンショット 2024-02-23 12.08.02.png

以上でアプリケーションの設定は完了です。
ClientIDとSecretキーが発行されました。

スクリーンショット 2024-02-23 12.11.14.png

OAuth2.0認証でアクセストークンを取得する

Withins APIではOAuth2.0を使いユーザーを認証します。

認証方法は2通りありますが、今回はWeb認証フロー(Web Authorization Flow)を実施します。

OAuth2について詳しくは公式リファレンスを確認ください。

認証コードを取得する

認証コードを得るには認証URLをブラウザで実行する必要があります。
実行するURLはこちらです。

https://account.withings.com/oauth2_user/authorize2?response_type=code&client_id=YOUR_CLIENT_ID&scope=user.info,user.metrics,user.activity&redirect_uri=YOUR_REDIRECT_URI&state=YOUR_STATE

一部変数を置き換えましょう。

  • YOUR_CLIENT_ID:先ほど作成したアプリケーションのclient_id
  • YOUR_REDIRECT_URI:アプリケーションで指定したredirect_url
  • YOUR_STATE:なんでも良い(今回はhoge)

認証URLを実行すると承認を求められるので許可します。

スクリーンショット 2024-02-23 12.22.21.png

許可したことでURLが変化しました。
code以下が認証コードです。
このコードを使い次はリクエストトークン(アクセストークン)を取得します。

スクリーンショット 2024-02-23 12.24.36.png

※注意

Please note that the authorization code is only valid for 30 seconds.

認証コードの有効時間は30秒しかありません。
30秒を過ぎると再度認証コードを取得しないといけないので先にリクエストトークンを受け取る用のスクリプトを用意するのが良いでしょう。

有効時間を過ぎるとこのようなエラーが返ります。

{
  "status": 503,
  "body": {},
  "error": "Invalid Params: invalid code"
}

リクエストトークンを取得する

エンドポイント:https://wbsapi.withings.net/v2/oauth2 にクライアント情報と認証コードを送りリクエストトークンを取得します。

# クライアントID
CLIENT_ID="xxxxxxxxxxxxx"
# クライアントシークレット
CLIENT_SECRET="yyyyyyyyyyyyyyyyy"
# 認証コード
CODE="zzzzzzzzzzzzzzzzz"
# リダイレクトURI
REDIRECT_URI="http://localhost:8080/oauth2/callback"

curl -X POST "https://wbsapi.withings.net/v2/oauth2" \
     -d "action=requesttoken" \
     -d "grant_type=authorization_code" \
     -d "client_id=${CLIENT_ID}" \
     -d "client_secret=${CLIENT_SECRET}" \
     -d "code=${CODE}" \
     -d "redirect_uri=${REDIRECT_URI}" | jq

実行結果
スクリーンショット 2024-02-23 12.35.41.png

アクセストークンやリフレッシュトークが返ってきましたね。

体重データを取得する

2023年12月1日~12月7日の体重データを取得します。
開始日時(startdate)と終了日時(enddate)はUNIXタイムスタンプである必要があります。
そしてmeastype=1を指定します。

パラメーターや指定する数値で戻り値が変わるので詳しくはリファレンスを確認ください。
Measure - Getmeas

curl --header "Authorization: Bearer ACCESS_TOKEN" \
		--data "action=getmeas" \
        --data "meastype=1" \
        --data "startdate=1701388800" \
        --data "enddate=1701907200" \
        --data "category=1" \
        'https://wbsapi.withings.net/measure' | jq

実行結果
スクリーンショット 2024-02-23 14.13.27.png

体重はmeasuresのvalueを確認します。
65600は65.6kgを意味します。

作成時間(created=1701905483)を日本時間に直すと2023年12月07日です。

IMG_4518.jpg

0.1kgズレていますが平均とあるのでこの日は複数回計測したようです。
そのうちの1回が65.6kgだったのでしょう。

正しく取得できていますね!

まとめ

今回はWithings APIを使って体重データを取得する方法を紹介しました。

体重以外にも体脂肪率、他のデバイスを購入すれば睡眠データなどもAPIで取れるそうです。

このAPIを使ったオリジナル健康アプリでも作ろうかと思いました。

1
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?