ユーザーAPI/写真類似検索

API情報†

名称	写真類似検索
APIバージョン	1
認証タイプ	ユーザー認証
URL	https://(APIサーバー名)/services/api/(アクセスコード)/
Method	POST
データ形式	multipart/form-data

↑

概要†

過去の写真データに基づいて類似の食事を検索する。

↑

パラメーター†

引数名	値	型	必須	内容
v	1(固定)	int定数	必須	バージョン番号現在は1
c	Bu(固定)	string定数	必須	コマンド Bu = ユーザー認証付きBBAPIを呼び出す
Category	XST(固定)	string定数	必須	オペレーションカテゴリー XST = エクストラサービス
Operation	cal(固定)	string定数	必須	オペレーション cal = CALLオペレーション
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については、出力フォーマットを参照

↑

アップロードデータXML†

↑

データ定義XML構成†

CallServiceタグ: ルートノード
ServiceNameタグ: サービス指定子 UserRecognizePicture1固定 [必須]
pictsetタグ: 入力する写真 [必須]

(以下pictsetの中に配置可能)
pictobjectタグ: 写真オブジェクト [最低でも1つは必須]

(以下pictobjectの中に配置可能)
typeタグ: 写真タイプ 0固定 [必須]
dateタグ: アップロード日時 [必須]
uploadidタグ: multipart/form-dataの画像データを含むパートのパラメータ名 [必須]
uploadhashタグ: アップロードする画像データのsha1ハッシュ値 [必須]

↑

XML例†

<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
<CallService>
	<ServiceName>UserRecognizePicture1</ServiceName>
	<pictset>
		<pictobject>
			<type>0</type>
			<date>2014/01/14 09:18:06</date>
			<uploadid>VGVVNbEJQCHcniGQ</uploadid>
			<uploadhash>8015c4290c436279b24913fcf2930a00bca22722</uploadhash>
		</pictobject>
	</pictset>
</CallService>

↑

返値†

変数名	型	内容
api_result	boolean	API実行結果 true:成功 false:失敗
category	string	実行されたカテゴリー名 RGP固定
registed	integer	受信された写真数
struct	array	結果の配列

結果の配列

変数名	型	内容
feedingdate	date	食事日時
refpict	array	被参照写真
foodobject	array	食事を構成する食品

被参照写真

変数名	型	内容
pictid	string	画像オブジェクトID
type	string	画像ソース区分

食事を構成する食品

変数名	型	内容
objectid	string	食品オブジェクトID
quantity	float	分量

↑

JSONの例†

{
	"api_result":true,
	"api_rescode":1,"struct":[
		{
			"feedingdate":"2012\/12\/04 09:44:00",
			"refpict":{
				"pictid":"VyJfFZQpFoZvhlSC9jpA1EoB",
				"type":"userpictlib"
			},
			"foodobject":[
				{
					"objectid":"FO01192397471c08790585fb12",
					"quantity":"1.0000"
				},
				{
					"objectid":"FO9a58f57646c9455b3ecac928",
					"quantity":"1.0000"
				}
			]
		},
		{
			"feedingdate":"2013\/03\/11 07:40:56",
			"refpict":{
				"pictid":"a39J2RZygXFxnZyIyrm3162D",
				"type":"userpictlib"
			},
			"foodobject":[
				{
					"objectid":"FOffbf77ba470b1f767c74f581",
					"quantity":"1.0000"
				},
				{
					"objectid":"FO26a31797469c6a95232ff62c",
					"quantity":"1.0000"
				}
			]
		}
	]
}

↑

XMLの例†

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<api_result>1</api_result>
	<api_rescode>1</api_rescode>
	<struct>
		<item>
			<feedingdate>2012/12/04 09:44:00</feedingdate>
			<refpict>
				<pictid>VyJfFZQpFoZvhlSC9jpA1EoB</pictid>
				<type>userpictlib</type>
			</refpict>
			<foodobject>
				<item>
					<objectid>FO01192397471c08790585fb12</objectid>
					<quantity>1.0000</quantity>
				</item>
				<item>
					<objectid>FO9a58f57646c9455b3ecac928</objectid>
					<quantity>1.0000</quantity>
				</item>
			</foodobject>
		</item>
		<item>
			<feedingdate>2013/03/11 07:40:56</feedingdate>
			<refpict>
				<pictid>a39J2RZygXFxnZyIyrm3162D</pictid>
				<type>userpictlib</type>
			</refpict>
			<foodobject>
				<item>
					<objectid>FOffbf77ba470b1f767c74f581</objectid>
					<quantity>1.0000</quantity>
				</item>
				<item>
					<objectid>FO26a31797469c6a95232ff62c</objectid>
					<quantity>1.0000</quantity>
				</item>
			</foodobject>
		</item>
	</struct>
</response>

↑

サンプル†

PHPサンプルサンプル/PHP/ユーザーAPI/写真類似検索

↑

バージョン†

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

Version	1
Revision	1
Editor	west