Health Planet API 仕様書 Ver1.0.1

事前に必要なもの

  APIを使用するためには登録画面にてアプリケーション登録を行い下記の情報を入手してください。
・client_id
・client_secret

認証

  当APIはOAuth 2.0に準じて作成されております。
  各APIにおいてSSL通信が必須条件となります。

対応環境

  PC - Internet Explorer 8及び9、Mozilla Firefox 6、Google Chorme 13、Safari 5
  iPhone - iOS 4

メソッド一覧

OAuth関連:
/oauth/auth
/oauth/token
ステータス関連のAPI:
/status/innerscan
/status/sphygmomanometer
/status/pedometer
/status/smug　2020/6/29で提供を終了いたしました。

リダイレクトURL

  Webアプリケーション の場合は登録されたドメイン内でのURL及び https://www.healthplanet.jp/success.html が指定可能になります。
  クライアントアプリケーション の場合は https://localhost 及び https://www.healthplanet.jp/success.html が指定可能になります。

OAuthのAPI

/oauth/auth

ユーザに(Webブラウザ経由で)アクセス許可を求める。

URL :
  https://www.healthplanet.jp/oauth/auth

引数 :
client_id (必須)
アプリケーションの client_id

redirect_uri (必須)
処理完了時、もしくはエラー発生時のリターンURL。アプリケーション登録にて指定したドメインのURLもしくは
https://www.healthplanet.jp/success.html が指定可能

scope (必須)
APIの使用を許可する範囲。innerscan（体組成情報）、sphygmomanometer（血圧情報）、pedometer（歩数情報）、smug（尿糖情報）
が指定可能であり、カンマ区切りで指定する

response_type (必須)
APIのレスポンスを指定する。現仕様では code のみ指定可能


メソッド : 
  GET・POST

API制限 : 
  適用対象外

例 : 
  https://www.healthplanet.jp/oauth/auth?client_id=0.demo.apps.healthplanet.jp&redirect_uri=https://www.karadakarute.jp/tanita/&scope=innerscan,pedometer&response_type=code

/oauth/token

リクエストトークンを取得する。/oauth/auth を完了してから10分以内に完了させる必要がある

URL :
  https://www.healthplanet.jp/oauth/token

引数 :

client_id (必須)
アプリケーションの client_id

client_secret (必須)
アプリケーションの client_secret

redirect_uri (必須)
処理完了時、もしくはエラー発生時のリターンURL。アプリケーション登録にて指定したドメインのURLもしくは
https://www.healthplanet.jp/success.html が指定可能

code (必須)
/oauth/auth にて取得したコード

grant_type (必須)
APIの付与タイプを指定する。現仕様では authorization_code のみ指定可能


メソッド : 
  POST

API制限 : 
  適用対象外

例 : 
  https://www.healthplanet.jp/oauth/token.?client_id=0.demo.apps.healthplanet.jp&client_secret=131156965920-RVcaOpgM7gelLJyFlprogo7VbvCLKBWxebANt&redirect_uri=https://www.karadakarute.jp/tanita/&code=qjzknJTyQPCdSj12Bq4xjGEe7RPnRUuMHRFwU5SdwRqa8&grant_type=authorization_code

StatusのAPI

/status/innerscan

体組成測定情報を取得する。日付指定の from to は必ず3ヶ月以内を指定する必要がある。
3ヶ月を超える日付を指定した場合は、自動的に3ヶ月に補正される。
このAPIを使用する場合は、/oauth/auth にて scope : innerscan を指定する必要がある。

URL :
  https://www.healthplanet.jp/status/innerscan.format
  (format は xml, json のうちのいずれかを指定)

引数 :
access_token (必須)
/oauth/token にて取得したトークン

date (必須)
from to の日付タイプを指定する。
0 : 登録日付
1 : 測定日付

from
取得期間 from を指定する。yyyyMMddHHmmss 形式で指定し、必ず from < to でなければならない
未指定の場合は3ヶ月前が指定される

to
取得期間 to を指定する。yyyyMMddHHmmss 形式で指定し、必ず from < to でなければならない
未指定の場合は現時刻が指定される

tag
取得する測定部位を指定する。未指定の場合はデフォルトの値を取得する。カンマ区切りで指定する
6021 : 体重 (kg)
6022 : 体脂肪率 (%)

下記項目は2020/6/29で連携を終了いたしました。
6023 : 筋肉量 (kg)
6024 : 筋肉スコア
6025 : 内臓脂肪レベル2(小数点有り、手入力含まず)
6026 : 内臓脂肪レベル(小数点無し、手入力含む)
6027 : 基礎代謝量 (kcal)
6028 : 体内年齢 (才)
6029 : 推定骨量 (kg)


メソッド : 
  GET・POST

API制限 : 
  適用対象（1時間あたり60回まで可能)

例 : 
  https://www.healthplanet.jp/status/innerscan.xml?access_token=131183293071/fYgcbI20e9EHxP3zFCeUtmUj8CZU9C8fb0Ces&tag=6021,6022&date=0&from=20110820150130&to=20110822150130

応答例 : 
  XMLの場合

<?xml version="1.0" encoding="UTF-8"?>
<status>
  <birth_date>19200709</birth_date>
  <data>
    <date>201008200628</date>
    <keydata>62.15</keydata>
    <model>01000023</model>
    <tag>6021</tag>
  </data>
  <data>
    <date>201008200628</date>
    <keydata>13.00</keydata>
    <model>01000023</model>
    <tag>6022</tag>
  </data>
  <data>
    <date>201008200443</date>
    <keydata>20</keydata>
    <model>00000000</model>
    <tag>6021</tag>
  </data>
  <data>
    <date>201008200443</date>
    <keydata>20</keydata>
    <model>00000000</model>
    <tag>6022</tag>
  </data>
  <height>170</height>
  <sex>male</sex>
</status>


戻り値 : 
birth_date : 誕生日
height     : 身長
sex        : 性別
date       : 測定日付
keydata    : 測定データ
model      : 測定機器名
tag        : 測定部位


測定機器 : 
00000000 : 手入力データ
01000001 : BC-501
01000002 : BC-502
01000003 : BC-503
01000022 : MC-180
01000023 : MC-190
01000024 : DC-320
01000067 : WB-510
01000072 : BC-504
01000074 : BC-567
01000075 : BC-569
01000076 : BC-308
01000077 : BC-309
01000079 : SC-330
01000080 : MC-980A/MC-980A plus/MC-980A-N plus
01000081 : BC-505
01000088 : RD-900
01000089 : RD-901
01000091 : DC-217A
01000092 : MC-780A/MC-780A-N
01000098 : RD-902
01000099 : RD-903
01000100 : BC-508
01000101 : RD-904
01000102 : RD-905
01000115 : DC-430A
01000117 : RD-800
01000124 : RD-E02
01000125 : RD-E03
01000121 : RD-E04
01000137 : RD-908
01000138 : RD-909
01000139 : DC-13C
01000140 : DC-270A/DC-270A-N
01000141 : RD-801
01000143 : BC-766
01000144 : BC-767
01000145 : BC-768
01000150 : RD-910
01000151 : RD-911
01000152 : RD-912
01000153 : RD-913
01000154 : RD-802
01000162 : BC-332L
01000163 : BC-333L
01000164 : BC-334L
01000165 : RD-914L
01000166 : RD-915L
01000167 : RD-916L
01000168 : RD-917L
01000169 : RD-803L
01000170 : RD-804L
01000173 : RD-930L
01000174 : RD-931L

/status/sphygmomanometer

血圧測定情報を取得する。日付指定の from to は必ず3ヶ月以内を指定する必要がある。
3ヶ月を超える日付を指定した場合は、自動的に3ヶ月に補正される。
このAPIを使用する場合は、/oauth/auth にて scope : sphygmomanometer を指定する必要がある。

URL :
  https://www.healthplanet.jp/status/sphygmomanometer.format
  (format は xml, json のうちのいずれかを指定)

引数 :
access_token (必須)
/oauth/token にて取得したトークン

date (必須)
from to の日付タイプを指定する。
0 : 登録日付
1 : 測定日付

from
取得期間 from を指定する。yyyyMMddHHmmss 形式で指定し、必ず from < to でなければならない
未指定の場合は3ヶ月前が指定される

to
取得期間 to を指定する。yyyyMMddHHmmss 形式で指定し、必ず from < to でなければならない
未指定の場合は現時刻が指定される

tag
取得する測定部位を指定する。未指定の場合はデフォルトの値を取得する。カンマ区切りで指定する
622E : 最高血圧 (mmHg)
622F : 最低血圧 (mmHg)
6230 : 脈拍 (bpm)


メソッド : 
  GET・POST

API制限 : 
  適用対象（1時間あたり60回まで可能)

例 : 
  https://www.healthplanet.jp/status/sphygmomanometer.xml?access_token=131183293071/fYgcbI20e9EHxP3zFCeUtmUj8CZU9C8fb0Ces&tag=622E,622F&date=0&from=20110820150130&to=20110822150130

測定機器 : 
00000000 : 手入力データ
01000004 : BP-300
01000005 : BP-301
01000041 : A&D TM2655
01000078 : BP-900
01000097 : BP-302
01000161 : BP-224L
01000171 : BP-910
01020172 : A&D UA-1200BLE

/status/pedometer

歩数測定情報を取得する。日付指定の from to は必ず3ヶ月以内を指定する必要がある。
3ヶ月を超える日付を指定した場合は、自動的に3ヶ月に補正される。
このAPIを使用する場合は、/oauth/auth にて scope : pedometer を指定する必要がある。

URL :
  https://www.healthplanet.jp/status/pedometer.format
  (format は xml, json のうちのいずれかを指定)

引数 :
access_token (必須)
/oauth/token にて取得したトークン

date (必須)
from to の日付タイプを指定する。
0 : 登録日付
1 : 測定日付

from
取得期間 from を指定する。yyyyMMddHHmmss 形式で指定し、必ず from < to でなければならない
未指定の場合は3ヶ月前が指定される

to
取得期間 to を指定する。yyyyMMddHHmmss 形式で指定し、必ず from < to でなければならない
未指定の場合は現時刻が指定される

tag
取得する測定部位を指定する。未指定の場合はデフォルトの値を取得する。カンマ区切りで指定する
6331 : 歩数 (歩)

下記項目は2020/6/29で連携を終了いたしました。
6335 : エクササイズ (Ex)
6336 : 活動エネルギー量 (kcal)


メソッド : 
  GET・POST

API制限 : 
  適用対象（1時間あたり60回まで可能)

例 : 
  https://www.healthplanet.jp/status/pedometer.xml?access_token=131183293071/fYgcbI20e9EHxP3zFCeUtmUj8CZU9C8fb0Ces&tag=6331&date=0&from=20110820150130&to=20110822150130

00000000 : 手入力データ
01000006 : FB-723
01000059 : FB-730
01000087 : AM-150
01000090 : AM-160
01000103 : AM-161