FrontPage

データAPI/新商品文字列検索

API情報

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

概要

文字列によって新規食品を検索する。
新規食品とは、以下の通り。

  • 過去1ヶ月間にデータが新しく追加、または更新された食品
  • 1ヶ月前から1ヶ月後までの間に発売日が設定されている食品

アクセス手順

クエリー

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

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

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

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

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

クエリー例

https://(APIサーバー名)/services/api2/(アクセスコード)/search/newfood/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,
      "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,
      "stuff_fiber":0.3,
      "polyphenol":0,
      "vegiunit":0,
      "gi":76,
      "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,
      "stuff_fiber":0.1,
      "polyphenol":0,
      "vegiunit":0,
      "gi":74,
      "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の返却するデータは、クライアント側で適切にキャッシュ等を行い、アクセス量を低減させることで更に効率化されると考えられる。

バージョン

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

Version1
Revision1
Editorwest

トップ   リロード   一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2018-10-09 (火) 15:46:51 (871d)