ユーザーAPI/ユーザー付随データの保存の変更点

追加された行はこの色です。
削除された行はこの色です。
ユーザーAPI/ユーザー付随データの保存へ行く。
[[FrontPage]]

&size(24){ユーザーAPI/ユーザー付随データの保存};

* API情報 [#q6190828]

|~名称|ユーザー付随データの保存|
|~APIバージョン|1|
|~認証タイプ|ユーザー認証|
|~URL|&#104;&#116;&#116;&#112;&#115;&#58;&#47;&#47;&#40;&#65;&#80;&#73;&#12469;&#12540;&#12496;&#12540;&#21517;&#41;/services/api/(アクセスコード)/|
|~Method|POST|
|~データ形式|multipart/form-data|

* 概要 [#jfe13a2c]

ユーザーに付随する任意のデータを保存する。~
データの形式はアプリケーションが独自に定義して使用できる。~
データサイズの上限は10Mとする。~
本機能はオプション項目であり、許可されたアプリケーションのみ使用できる。


* パラメーター [#ya59d11f]

|引数名|値|型|必須|内容|h
|v|1(固定)|int定数|必須|バージョン番号&br;現在は1|
|c|Bu(固定)|string定数|必須|コマンド&br;Bu = ユーザー認証付きBBAPIを呼び出す|
|Category|UED(固定)|string定数|必須|オペレーションカテゴリー&br;UED = ユーザーエクストラデータ|
|Operation|poo(固定)|string定数|必須|オペレーション&br;poo = PUTオペレーション|
|AppKey|アプリケーションキー|string|必須|アプリケーションキーペアのアプリケーションキー|
|UserAuth|ユーザー認証タイプ|string|必須|userhashbb|
|uid|モバイルダイエットID|string|uidまたはloginidのいずれか必須|ユーザーのモバイルダイエットID|
|loginid|ログインID|string|uidまたはloginidのいずれか必須|ユーザーのログインID|
|password|パスワードハッシュ値|hash|必須|sha1(アプリケーションシークレット+パスワード) の値|
|StructData|アップロードデータ|xml|必須|アップロードする付随データの情報|
|(uploadid)|バイナリデータ|binary|任意|XML中で指定されたアップロードデータ|
|Format|json,yaml,xml|string定数|任意|出力フォーマット指定&br;省略時json(またはアプリケーションキー毎に指定のフォーマット)|
|Charset|UTF-8,SJIS,EUC-JP|string定数|任意|出力文字コード指定・省略時UTF8&br;出力フォーマットjson,xml時は常にUTF-8|
認証パラメーターAppKey,UserAuth,uid,passwordについては、[[API認証>API認証#authtype_user]]を参照~
出力指定パラメーターFormat,Charsetについては、[[出力フォーマット]]を参照~

* アップロードデータXML [#d1118dc6]

** データ定義XML構成 [#sbcdc85d]
 userdataタグ: ルートノード
 codeタグ: 保存するデータを識別する名称
 uploadidタグ: multipart/form-dataのバイナリデータを含むパートのパラメータ名 [必須]
 uploadhashタグ: アップロードするバイナリデータのsha1ハッシュ値 [必須]


** XML例 [#g9ecbe25]
#html{{
<pre class="brush:xml;">
}}
#htmlinsert(samxml_mobadaiapi_userextradata_put.xml)
#html{{
</pre>
}}

* 返値 [#e86e04c1]

|変数名|型|内容|h
|api_result|boolean|API実行結果&br;true:成功 false:失敗|

** JSONの例 [#a81f6668]
#html{{
<pre class="brush:xml;">
{
	"api_result":true,
	"api_rescode":1
}
</pre>
}}

** XMLの例 [#wb22f315]
#html{{
<pre class="brush:xml;">
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;response&gt;
    &lt;api_result&gt;1&lt;/api_result&gt;
    &lt;api_rescode&gt;1&lt;/api_rescode&gt;
  &lt;/response&gt;
</pre>
}}

* サンプル [#z5db7844]

PHPサンプル [[サンプル/PHP/ユーザーAPI/ユーザー付随データの保存]]

* バージョン [#o0becc47]

このドキュメントのバージョン情報
|Version|1|
|Revision|1|
|Editor|west|
ユーザーAPI/ユーザー付随データの保存 の変更点

ユーザーAPI/ユーザー付随データの保存の変更点
