![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
ユーザーAPI/写真のライブラリ保存
| 名称 | 写真のライブラリ保存 |
|---|---|
| APIバージョン | 1 |
| 認証タイプ | ユーザー認証 |
| URL | https://(APIサーバー名)/services/api/(アクセスコード)/ |
| Method | POST |
| データ形式 | multipart/form-data |
写真データをユーザーピクチャーライブラリに保存する
| 引数名 | 値 | 型 | 必須 | 内容 |
| v | 1(固定) | int定数 | 必須 | バージョン番号 現在は1 |
| c | Bu(固定) | string定数 | 必須 | コマンド Bu = ユーザー認証付きBBAPIを呼び出す |
| Category | UPL(固定) | string定数 | 必須 | オペレーションカテゴリー UPL = ユーザーピクチャーライブラリ |
| 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 | 必須 | アップロードする写真データの情報 |
| Pict(uploadid) | 画像データ | binary | 必須 | XML中で指定されたアップロードデータ 1ファイルは最大で2Mバイトまで (uploadid)部分は任意の文字列であって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については、出力フォーマットを参照
pictsetタグ: ルートノード pictタグ: 1処理セッションの写真データ [最低でも1つは必須] (以下pictの中に配置可能) pictobjectタグ: 写真オブジェクト [最低でも1つは必須]
(以下pictobjectの中に配置可能) typeタグ: 写真タイプ 0固定 [必須] dateタグ: アップロード日時 [必須] uploadidタグ: multipart/form-dataの画像データを含むパートのパラメータ名 [必須] uploadhashタグ: アップロードする画像データのsha1ハッシュ値 [必須]
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?> <pictset> <pict> <pictobject> <type>0</type> <date>2014/01/14 09:18:06</date> <uploadid>VGVVNbEJQCHcniGQ</uploadid> <uploadhash>8015c4290c436279b24913fcf2930a00bca22722</uploadhash> </pictobject> </pict> </pictset>
| 変数名 | 型 | 内容 |
| api_result | boolean | API実行結果 true:成功 false:失敗 |
| category | string | 実行されたカテゴリー名 RGP固定 |
| registed | integer | 受信された写真数 |
| struct | array | 結果データの配列 |
結果データの配列
| 変数名 | 型 | 内容 |
| uploadid | string | 写真のアップロード識別ID |
| result | boolean | 処理結果 |
| objectid | string | ピクチャーライブラリオブジェクトID |
| xml | string | 結果食事データ |
{
"api_result":true,
"api_rescode":1,
"registed":1,
"struct":[
{
"uploadid":"1395700396",
"result":true,
"objectid":"Kv4LQ0EfDlv6jspofKlv2lS1"
}
]
}
<?xml version="1.0" encoding="UTF-8"?> <response> <api_result>1</api_result> <api_rescode>1</api_rescode> <registed>1</registed> <struct> <item> <uploadid>1395700550</uploadid> <result>1</result> <objectid>HAhdoB0gDH0AfBMt6O8Z3vWg</objectid> </item> </struct> </response>
PHPサンプル サンプル/PHP/ユーザーAPI/写真のライブラリ保存
このドキュメントのバージョン情報
| Version | 1 |
| Revision | 1 |
| Editor | west |
