データ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;/api/(アクセスコード)/|
|~Method|POST|
|~データ形式|application/x-www-form-urlencoded|

* 概要 [#jfe13a2c]

指定食品と組み合わされることの多い食品を検索する


* パラメーター [#ya59d11f]

|引数名|値|型|必須|内容|h
|v|1(固定)|int定数|必須|バージョン番号&br;現在は1|
|c|Az(固定)|string定数|必須|コマンド&br;Az = APIを呼び出す|
|Category|RFL(固定)|string定数|必須|オペレーションカテゴリー&br;RFL = 食品リレーションデータ|
|Operation|god(固定)|string定数|必須|オペレーション&br;god = GETオペレーション|
|AppKey|アプリケーションキー|string|必須|アプリケーションキーペアのアプリケーションキー|
|IDseed|認証シード|string|必須|認証に使う毎回変わるランダムの文字列|
|IDval|認証ハッシュ値|hash|必須|sha1(アプリケーションシークレット+認証シード)の値|
|StructData|要求食品データ|xml|必須|要求食品データ|
|Format|json,yaml,xml|string定数|任意|出力フォーマット指定&br;省略時json(またはアプリケーションキー毎に指定のフォーマット)|
|Charset|UTF-8,SJIS,EUC-JP|string定数|任意|出力文字コード指定・省略時UTF8&br;出力フォーマットjson,xml時は常にUTF-8|
認証パラメーターAppKey,IDseed,IDvalについては、[[API認証>API認証#authtype_client]]を参照~
出力指定パラメーターFormat,Charsetについては、[[出力フォーマット]]を参照~

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

** データ定義XML構成 [#sbcdc85d]
 objectsetタグ: ルートノード
 idタグ: 食品ID [必須]
 prefixタグ: IDに 'FO' を付加するフラグ 1=on [任意]

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

* 返値 [#e86e04c1]

|変数名|型|内容|h
|api_result|boolean|API実行結果&br;true:成功 false:失敗|
|struct|array|結果データの配列|

結果データの配列
|変数名|型|内容|h
|objectid|string|食品オブジェクトID|
|related|array|食品オブジェクトIDの列挙|

** JSONの例 [#a81f6668]
#html{{
<pre class="brush:xml;">
{
	"api_result":true,
	"struct":[
		{
			"objectid":"FO29240fd24566d0583eace35c",
			"related":[
				"FO602dd9eb47944ae36e71e45e",
				"FOf47edc2e462da61c2e7f6e4a",
				"FOc3571f944566d05841da4085",
				"FO3cc1bb8745d44ff97ba8c6fe",
				"FO9a58f57646c9455b3ecac928",
				"FO53e252d245d44ff7718e3607"
			]
		}
	]
}
</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;struct&gt;
		&lt;item&gt;
			&lt;objectid&gt;FO29240fd24566d0583eace35c&lt;/objectid&gt;
			&lt;related&gt;
				&lt;item&gt;FO602dd9eb47944ae36e71e45e&lt;/item&gt;
				&lt;item&gt;FOf47edc2e462da61c2e7f6e4a&lt;/item&gt;
				&lt;item&gt;FOc3571f944566d05841da4085&lt;/item&gt;
				&lt;item&gt;FO3cc1bb8745d44ff97ba8c6fe&lt;/item&gt;
				&lt;item&gt;FO9a58f57646c9455b3ecac928&lt;/item&gt;
				&lt;item&gt;FO53e252d245d44ff7718e3607&lt;/item&gt;
			&lt;/related&gt;
		&lt;/item&gt;
	&lt;/struct&gt;
&lt;/response&gt;
</pre>
}}

* サンプル [#z5db7844]

PHPサンプル [[サンプル/PHP/データAPI/食品リレーション検索(アプリ向け)]]

* バージョン [#o0becc47]

このドキュメントのバージョン情報
|Version|1|
|Revision|1|
|Editor|west|