![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
ユーザーAPI/ユーザー付随データの保存
| 名称 | ユーザー付随データの保存 |
|---|---|
| APIバージョン | 1 |
| 認証タイプ | ユーザー認証 |
| URL | https://(APIサーバー名)/services/api/(アクセスコード)/ |
| Method | POST |
| データ形式 | multipart/form-data |
ユーザーに付随する任意のデータを保存する。
データの形式はアプリケーションが独自に定義して使用できる。
データサイズの上限は10Mとする。
本機能はオプション項目であり、許可されたアプリケーションのみ使用できる。
| 引数名 | 値 | 型 | 必須 | 内容 |
| v | 1(固定) | int定数 | 必須 | バージョン番号 現在は1 |
| c | Bu(固定) | string定数 | 必須 | コマンド Bu = ユーザー認証付きBBAPIを呼び出す |
| Category | UED(固定) | string定数 | 必須 | オペレーションカテゴリー UED = ユーザーエクストラデータ |
| Operation | poo(固定) | string定数 | 必須 | オペレーション 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定数 | 任意 | 出力フォーマット指定 省略時json(またはアプリケーションキー毎に指定のフォーマット) |
| Charset | UTF-8,SJIS,EUC-JP | string定数 | 任意 | 出力文字コード指定・省略時UTF8 出力フォーマットjson,xml時は常にUTF-8 |
認証パラメーターAppKey,UserAuth,uid,passwordについては、API認証を参照
出力指定パラメーターFormat,Charsetについては、出力フォーマットを参照
userdataタグ: ルートノード codeタグ: 保存するデータを識別する名称 uploadidタグ: multipart/form-dataのバイナリデータを含むパートのパラメータ名 [必須] uploadhashタグ: アップロードするバイナリデータのsha1ハッシュ値 [必須]
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?> <userdata> <code>MyApplicationData</code> <uploadid>G9ECBAHDF25</uploadid> <uploadhash>8015c4290c436279b24913fcf2930a00bca22722</uploadhash> </userdata>
| 変数名 | 型 | 内容 |
| api_result | boolean | API実行結果 true:成功 false:失敗 |
{
"api_result":true,
"api_rescode":1
}
<?xml version="1.0" encoding="UTF-8"?>
<response>
<api_result>1</api_result>
<api_rescode>1</api_rescode>
</response>
PHPサンプル サンプル/PHP/ユーザーAPI/ユーザー付随データの保存
このドキュメントのバージョン情報
| Version | 1 |
| Revision | 1 |
| Editor | west |
