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 = ユーザープロファイルデータ
Operationpoo(固定)string定数必須オペレーション
poo = PUTオペレーション
AppKeyアプリケーションキーstring必須アプリケーションキーペアのアプリケーションキー
UserAuthユーザー認証タイプstring必須userhashbb
uidモバイルダイエットIDstringuidまたはloginidのいずれか必須ユーザーのモバイルダイエットID
loginidログインIDstringuidまたはloginidのいずれか必須ユーザーのログインID
passwordパスワードハッシュ値hash必須sha1(アプリケーションシークレット+パスワード) の値
StructData登録データxml必須登録プロファイルデータ
Formatjson,yaml,xmlstring定数任意出力フォーマット指定
省略時json(またはアプリケーションキー毎に指定のフォーマット)
CharsetUTF-8,SJIS,EUC-JPstring定数任意出力文字コード指定・省略時UTF8
出力フォーマットjson,xml時は常にUTF-8

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

登録データXML

データ定義XML/JSON構成

ProfileSetタグ: ルートノード
sexタグ: 性別 男性=1 女性=2
birthタグ: 誕生年月日
weightタグ: 体重kg
heightタグ: 身長cm
lifelvタグ: 生活稼働強度
nicknameタグ: ニックネーム
nicknameタグ: ニックネーム
flagpublicタグ: 撮って栄養コース公開フラグ
flaghideweightタグ: 撮って栄養コース体重隠蔽フラグ

XML例

<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
<ProfileSet>
  <sex>1</sex>
  <birth>1970/11/22</birth>
  <weight>168.2</weight>
  <height>65.4</height>
  <lifelv>1.3</lifelv>
</ProfileSet>

JSON例

{
  'ProfileSet' : {
    'sex' : 1,
    'birth' : '1970/11/22',
    'weight' : 65.4,
    'height' : 168.2,
    'flagpublic' : true,
    'flaghideweight' : false,
  }
}

返値

変数名内容
api_resultbooleanAPI実行結果
true:成功 false:失敗

JSONの例

{
	"api_result":true,
	"api_rescode":1
}

XMLの例

<?xml version="1.0" encoding="UTF-8"?>
  <response>
    <api_result>1</api_result>
    <api_rescode>1</api_rescode>
  </response>

サンプル

PHPサンプル サンプル/PHP/ユーザーAPI/ユーザー属性情報の登録

バージョン

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

Version1
Revision1
Editorwest

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