FrontPage - PukiWiki

食品検索系 API 仕様ドキュメント

本サンプルドキュメントは標準的な食品栄養データライセンスご契約に基づく、アクセス例及びレスポンス内容例を示すもので、
本番サービスご提供の際は、ご契約各社様毎にレスポンス内容等が異なることをご承知おき下さい。

NEW: カスタム食品文字列検索において食品(商品)名とは異なる俗称や略語で検索する選択肢オプションを追加 (Apr 2024)
NEW: リクエストAPIを公開 (Apr 2024)
NEW: カスタム食品文字列検索と食品詳細情報取得で異なる項目（栄養等）を選択できる契約形態を追加 (Sep 2021)
NEW: カスタム検索APIにおいて食材を参照した検索精度改善に対応した検索結果に対応 (Jan 2021)
NEW: カスタム検索APIにおいて指定統合タグ食品群を優先上位表示することに対応 (Oct 2020)

※弊社フードサーチ(LINE版)及びフードブラウザ(法人限定)では、本APIを活用しています。

APIを使用する†

↑

各APIの詳細†

Main

データAPI/カスタム食品文字列検索 ※最も汎用的にご利用頂けるフラグシップAPIです
データAPI/食品詳細情報取得 ※OIDを指定して食品栄養情報を取得します

Options

データAPI/カスタムJANCODE検索 ※JANコード検索ではありません
データAPI/JANCODEマップ検索 (JANコード検索、追加ご契約オプション)
データAPI/SIMWORD検索 (サジェスト検索、追加ご契約オプション）
データAPI/MMメニュー詳細情報取得 (追加ご契約オプション)
データAPI/構成食材による検索 (追加ご契約オプション)
データAPI/栄養素の範囲指定による検索 (追加ご契約オプション)
データAPI/基本素材リスト文字列検索 (追加ご契約オプション)
データAPI/栄養素加減算操作 (追加ご契約オプション)
分析API/栄養分析 (栄養と食材の分析機能）
リクエストAPI

↑

提供を終了したAPI†

データAPI/食品文字列検索＋＋
データAPI/食品文字列検索 ※旧式のため提供停止予定/新規利用停止（カスタム食品文字列検索へ統合済)
データAPI/食品文字列検索＋ ※旧式のため提供停止予定/新規利用停止（カスタム食品文字列検索へ統合済)
データAPI/新商品検索 ※旧式のため提供停止予定/新規利用停止（カスタム食品文字列検索へ統合済)

↑

サンプルソース†

↑

コンソールテストサンプル†

# Let's Encrypt ca-certificate 取得
% wget -O lets-encrypt-x3-cross-signed.pem "https://letsencrypt.org/certs/lets-encrypt-x3-cross-signed.pem.txt"
 
# 「野菜ラーメン」で食品文字列検索を実施し0番目から5個を取得
% wget --quiet --ca-certificate=lets-encrypt-x3-cross-signed.pem -O - "https://(your_server_name)/services/api2/(your_access_code)/search/simple/json/%E9%87%8E%E8%8F%9C%E3%83%A9%E3%83%BC%E3%83%A1%E3%83%B3/0/5/"
 
# 「野菜」「ラーメン」で食品文字列検索＋を実施し0番目から5個を取得
% wget --quiet --ca-certificate=lets-encrypt-x3-cross-signed.pem -O - "https://(your_server_name)/services/api2/(your_access_code)/search/concatand/json/%E9%87%8E%E8%8F%9C%20%E3%83%A9%E3%83%BC%E3%83%A1%E3%83%B3/0/5/"
 
# 「ラーメン」で新商品検索を実施し0番目から5個を取得
% wget --quiet --ca-certificate=lets-encrypt-x3-cross-signed.pem -O - "https://(your_server_name)/services/api2/(your_access_code)/search/newfood/json/%E3%83%A9%E3%83%BC%E3%83%A1%E3%83%B3/0/5/"