FrontPage

データAPI/基本素材リスト文字列検索

API情報

名称基本素材リスト文字列検索
APIバージョン2
認証タイプなし
URLhttps://(APIサーバー名)/services/api2/(アクセスコード)/search/material/json/検索語/
https://(APIサーバー名)/services/api2/(アクセスコード)/search/material/json/検索語/開始位置/表示個数/
MethodGET
データ更新頻度目安1日

概要

文字列によって基本素材リストを検索する。

アクセス手順

クエリー

https://(APIサーバー名)/services/api2/(アクセスコード)/search/material/json/(検索文字列)/
(検索文字列) で検索した結果を返却する。

https://(APIサーバー名)/services/api2/(アクセスコード)/search/material/json/(検索文字列)/(開始位置)/(表示個数)/
(検索文字列) で検索した結果のうち、0から始まるインデックスの(開始位置)番目から、(表示個数)個のアイテムを返却する。

検索文字列がマルチバイトの場合は、文字コードをUTF-8としURLエンコードを施したものとする。

入力される検索文字列の取り扱い

入力された検索文字列は、全部分が採用され、切り捨てはない。
半角スペース(" ")で区切って複数の検索語を列挙した場合、AND検索となる。

クエリー例

https://(APIサーバー名)/services/api2/(アクセスコード)/search/material/json/%E3%83%A9%E3%83%BC%E3%83%A1%E3%83%B3%20%E9%87%8E%E8%8F%9C/

レスポンス

レスポンスコードは200を返し、レスポンスはjson形式である。レスポンスされる食品数の最大値は 500 である。 検索結果が存在しない場合は長さ0の配列が返される。クエリー書式誤り等の場合はレスポンスコード404が返される。

※以下の内容はサンプルであり、食品栄養データライセンスご契約内容によって異なります。

{
 "foods": [
   {
     "name": 食品名,
     "yomi": 食品名よみ,
     "objectid": オブジェクトID,
     "unit": 分量,
     "stuff_e": カロリー,
     :
     "categorytree": [
       第1階層カテゴリー名,
       第2階層カテゴリー名,
       第3階層カテゴリー名,
     ],
     "shopname": メーカー名,
     "elements": [
       {
         "elementid": 構成食材オブジェクトID,
         "elementunit": 構成食材分量
       },
       :
     ]
   },
   {
     (食品データ)
   },
   :
 ],
}

レスポンス例

※以下の内容はサンプルであり、食品栄養データライセンスご契約内容によって異なります。

{
  "foods": [
    {
      "name": "トマトピューレー(100g)",
      "yomi": "とまとぴゅーれー ひゃくぐらむ",
      "objectid": "FOb656cfb75e7be7af465da188",
      "unit": 100,
      "stuff_e": 41,
      "stuff_p": 1.9,
      "stuff_f": 0.1,
      "stuff_c": 9.9,
      "stuff_fiber": 1.8,
      "carbo": 8.1,
      "categorytree": [
        "その他",
        "基本素材",
        "調味料"
      ],
      "shopname": "",
      "elements": [
        {
          "elementid": "FOe218918346d3088b1792e8f6",
          "elementunit": 100
        }
      ]
    },
 ]
}

考慮事項

本APIの返却するデータは、クライアント側で適切にキャッシュ等を行い、アクセス量を低減させることで更に効率化されると考えられる。

バージョン

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

Version1
Revision1
Editorwest

トップ   リロード   一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2020-03-30 (月) 06:55:10 (415d)