データAPI/食品文字列検索++ API情報 †
概要 †食品文字列検索 を実施し、弊社独自のルール(上位4番手までに可能性が高いものを位置づける)に従い順番を並べ替える。 ※通常は食品文字列検索をご利用下さい。(食品文字列検索++より食品文字列検索の方が高速です) アクセス手順 †クエリー †https://(APIサーバー名)/services/api2/(アクセスコード)/search/slot4/json/(検索文字列)/ https://(APIサーバー名)/services/api2/(アクセスコード)/search/slot4/json/(検索文字列)/(開始位置)/(表示個数)/ 検索文字列がマルチバイトの場合は、文字コードをUTF-8としURLエンコードを施したものとする。 検索文字列ルール †
入力される検索文字列の取り扱い †検索文字列は、半角スペース(" ")で区切られた複数の語によって構成される。 クエリー例 †https://(APIサーバー名)/services/api2/(アクセスコード)/search/slot4/json/%E3%83%A9%E3%83%BC%E3%83%A1%E3%83%B3%20%E5%A1%A9/ レスポンス †レスポンスコードは200を返し、レスポンスはjson形式である。レスポンスされる食品数の最大値は 500 である。 検索結果が存在しない場合は長さ0の配列が返される。クエリー書式誤り等の場合はレスポンスコード404が返される。 { foods :[ { "name" : 食品名, "yomi" : 食品名読み, "objectid" : オブジェクトID, "unit" : 分量, "stuff_e" : エネルギー, "stuff_p" : たんぱく質, "stuff_f" : 脂質, "stuff_c" : 炭水化物, "categorytree" : [ 第1階層カテゴリー名, 第2階層カテゴリー名, 第3階層カテゴリー名 ], "subsubattr" : { "gaishoku" : 外食フラグ 0 or 1, "kakou" : 加工食品フラグ 0 or 1, "takeout" : テイクアウトフラグ 0 or 1, }, "shopname" : メーカー名 }, { (食品データ) }, : ] } レスポンス例 †{ "foods":[ { "name":"\u30aa\u30fc\u30eb\u30a2\u30ba\u30ad(1\u679a)(\u6771\u30cf\u30c8)", "yomi":"\u304a\u30fc\u308b\u3042\u305a\u304d\u3044\u3061\u307e\u3044\u3068\u3046\u306f\u3068", "objectid":"FOd6e9f772488019ac014f6f5b", "unit":8, "stuff_e":29, "stuff_p":0.5, "stuff_f":0.6, "stuff_c":5.5, "categorytree":[ "\u305d\u306e\u4ed6", "\u83d3\u5b50\u985e", "\u30af\u30c3\u30ad\u30fc\u30fb\u30d3\u30b9\u30b1\u30c3\u30c8\u30fb\u30d1\u30a4" ], "shopsubattr":{ "gaishoku":0, "kakou":1, "takeout":0 }, "shopname":"\u6771\u30cf\u30c8" }, { "name":"\u30aa\u30fc\u30eb\u30a2\u30c3\u30d7\u30eb(1\u679a)(\u6771\u30cf\u30c8)", "yomi":"\u304a\u30fc\u308b\u3042\u3063\u3077\u308b \u3044\u3061\u307e\u3044 \u3068\u3046\u306f\u3068", "objectid":"FOe30783f5474d2d7228624ecc", "unit":7.6, "stuff_e":29, "stuff_p":0.3, "stuff_f":0.6, "stuff_c":5.5, "categorytree":[ "\u305d\u306e\u4ed6", "\u83d3\u5b50\u985e", "\u30af\u30c3\u30ad\u30fc\u30fb\u30d3\u30b9\u30b1\u30c3\u30c8\u30fb\u30d1\u30a4" ], "shopsubattr":{ "gaishoku":0, "kakou":1, "takeout":0 }, "shopname":"\u6771\u30cf\u30c8" } ] } 考慮事項 †本APIの返却するデータは、クライアント側で適切にキャッシュ等を行い、アクセス量を低減させることで更に効率化されると考えられる。 バージョン †このドキュメントのバージョン情報
|