![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
データAPI/食品リレーション検索(アプリ向け)
| 名称 | 食品リレーション検索(アプリ向け) |
|---|---|
| APIバージョン | 1 |
| 認証タイプ | クライアント認証 |
| URL | https://(APIサーバー名)/api/(アクセスコード)/ |
| Method | POST |
| データ形式 | application/x-www-form-urlencoded |
指定食品と組み合わされることの多い食品を検索する
| 引数名 | 値 | 型 | 必須 | 内容 |
| v | 1(固定) | int定数 | 必須 | バージョン番号 現在は1 |
| c | Az(固定) | string定数 | 必須 | コマンド Az = APIを呼び出す |
| Category | RFL(固定) | string定数 | 必須 | オペレーションカテゴリー RFL = 食品リレーションデータ |
| Operation | god(固定) | string定数 | 必須 | オペレーション god = GETオペレーション |
| AppKey | アプリケーションキー | string | 必須 | アプリケーションキーペアのアプリケーションキー |
| IDseed | 認証シード | string | 必須 | 認証に使う毎回変わるランダムの文字列 |
| IDval | 認証ハッシュ値 | hash | 必須 | sha1(アプリケーションシークレット+認証シード)の値 |
| StructData | 要求食品データ | xml | 必須 | 要求食品データ |
| Format | json,yaml,xml | string定数 | 任意 | 出力フォーマット指定 省略時json(またはアプリケーションキー毎に指定のフォーマット) |
| Charset | UTF-8,SJIS,EUC-JP | string定数 | 任意 | 出力文字コード指定・省略時UTF8 出力フォーマットjson,xml時は常にUTF-8 |
認証パラメーターAppKey,IDseed,IDvalについては、API認証を参照
出力指定パラメーターFormat,Charsetについては、出力フォーマットを参照
objectsetタグ: ルートノード idタグ: 食品ID [必須] prefixタグ: IDに 'FO' を付加するフラグ 1=on [任意]
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?> <objectset> <id>FO29240fd24566d0583eace35c</id> <prefix>1</prefix> </objectset>
| 変数名 | 型 | 内容 |
| api_result | boolean | API実行結果 true:成功 false:失敗 |
| struct | array | 結果データの配列 |
結果データの配列
| 変数名 | 型 | 内容 |
| objectid | string | 食品オブジェクトID |
| related | array | 食品オブジェクトIDの列挙 |
{
"api_result":true,
"struct":[
{
"objectid":"FO29240fd24566d0583eace35c",
"related":[
"FO602dd9eb47944ae36e71e45e",
"FOf47edc2e462da61c2e7f6e4a",
"FOc3571f944566d05841da4085",
"FO3cc1bb8745d44ff97ba8c6fe",
"FO9a58f57646c9455b3ecac928",
"FO53e252d245d44ff7718e3607"
]
}
]
}
<?xml version="1.0" encoding="UTF-8"?> <response> <api_result>1</api_result> <struct> <item> <objectid>FO29240fd24566d0583eace35c</objectid> <related> <item>FO602dd9eb47944ae36e71e45e</item> <item>FOf47edc2e462da61c2e7f6e4a</item> <item>FOc3571f944566d05841da4085</item> <item>FO3cc1bb8745d44ff97ba8c6fe</item> <item>FO9a58f57646c9455b3ecac928</item> <item>FO53e252d245d44ff7718e3607</item> </related> </item> </struct> </response>
PHPサンプル サンプル/PHP/データAPI/食品リレーション検索(アプリ向け)
このドキュメントのバージョン情報
| Version | 1 |
| Revision | 1 |
| Editor | west |
