FrontPage

ユーザーAPI/ユーザー属性情報の取得

API情報

名称ユーザー属性情報の取得
APIバージョン1
認証タイプユーザー認証
URLhttps://(APIサーバー名)/services/api/(アクセスコード)/
MethodPOST
データ形式application/x-www-form-urlencoded

概要

ユーザー属性情報の取得

パラメーター

引数名必須内容
v1(固定)int定数必須バージョン番号
現在は1
cBu(固定)string定数必須コマンド
Bu = ユーザー認証付きBBAPIを呼び出す
CategoryUP(固定)string定数必須オペレーションカテゴリー
UP = ユーザープロファイルデータ
Operationgod(固定)string定数必須オペレーション
god = GETオペレーション
AppKeyアプリケーションキーstring必須アプリケーションキーペアのアプリケーションキー
UserAuthユーザー認証タイプstring必須userhashbb
uidモバイルダイエットIDstringuidまたはloginidのいずれか必須ユーザーのモバイルダイエットID
loginidログインIDstringuidまたはloginidのいずれか必須ユーザーのログインID
passwordパスワードハッシュ値hash必須sha1(アプリケーションシークレット+パスワード) の値
Formatjson,yaml,xmlstring定数任意出力フォーマット指定
省略時json(またはアプリケーションキー毎に指定のフォーマット)
CharsetUTF-8,SJIS,EUC-JPstring定数任意出力文字コード指定・省略時UTF8
出力フォーマットjson,xml時は常にUTF-8

認証パラメーターAppKey,UserAuth,uid,passwordについては、API認証を参照
出力指定パラメーターFormat,Charsetについては、出力フォーマットを参照

返値

変数名内容
api_resultbooleanAPI実行結果
true:成功 false:失敗
structarray取得したデータの配列

取得データ結果の配列

変数名内容
sexinteger性別 男性=1 女性=2
birthstring生年月日
weightfloat体重kg
heightfloat身長cm
lifelvfloat生活稼働強度

JSONの例

{
	"api_result":true,
	"api_rescode":1,
	"struct":{
		"birth":"1970\/11\/22",
		"sex":"1",
		"height":"65.40",
		"weight":"168.2000",
		"lifelv":"1.30"
	}
}

XMLの例

<?xml version="1.0" encoding="UTF-8"?>
  <response>
    <api_result>1</api_result>
    <api_rescode>1</api_rescode>
    <struct>
      <birth>1970/11/22</birth>
      <sex>1</sex>
      <height>65.40</height>
      <weight>168.2000</weight>
      <lifelv>1.30</lifelv>
    </struct>
  </response>

サンプル

PHPサンプル サンプル/PHP/ユーザーAPI/ユーザー属性情報の取得

バージョン

このドキュメントのバージョン情報

Version1
Revision1
Editorwest

トップ   差分 履歴 リロード   一覧 検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2018-06-22 (金) 08:00:52