分析API/栄養分析

FrontPage

分析API/栄養分析

分析APIシステムは、フロントエンドとして「実行部（＝API）」と「設定部（ルール指定）」で構成されています。
設定部についても json で規定される設定ルールをサーバーに送信するためAPIの概念がありますが、現状、エディターを含む SaaS 形式で提供しているため、ドキュメントは未だありません。
実行部の定義となる本ドキュメントでは、食事内容の指定方法を中心にしていますが、実行部が利用する分析エンジンでは検索APIの機能を内部で活用しているため、分析する栄養素を検索APIがレスポンスする必要があり、契約としても実装としても検索と分析はペアとなっているため、検索API分類の中に本APIを定義しています。
※つまり、本分析APIを利用される場合には、分析内容に見合った検索APIのご契約が必要です。

API情報†

概要†

予め設定されたルールに従って食事データを分析する

アクセス手順†

jsonで記述した食事データをリクエストボディに設定し、URLに対してPOSTを行う。

食事データフォーマット†

食事データはjsonで記述する。

食事データ†

アップロードする食事データを記述する。

プロフィールオブジェクト†

分析対象の人物属性を記述する。

食事群オブジェクト†

食事の集合を記述する。

食事オブジェクト†

食事を記述する。

食品オブジェクト†

食品を記述する。

食事データ例†

{
 {
  "ver": 1,
  "type": "nutranalyze",
  "analyzer": "testrule1",
  "authkey": "password0",
  "callbackdata": {
    "user-defined-data1": "ABCDEFG",
  },
  "profile": {
    "type": "profile",
    "data": {
      "name": "ユーザーの名前",
      "age": 25,
      "sex": "male",
      "height": 165,
      "weight": 60,
      "intensity": 1.3
    }
  },
  "meals": {
    "type": "meals",
    "data": [
      {
        "type": "meal",
        "date": "2020/08/21 11:00:00",
        "daypart": "00",
        "data": [
          {
            "type": "food",
            "data": {
              "objectid": "FO7de5bd6a4cec65c8213902c7",
              "quantity": 1.5
            }
          },
          {
            "type": "food",
            "data": {
              "objectid": "FO3cc1bb8745d44ff97ba8c6fe",
              "quantity": 1
            }
          }
        ]
      }
    ]
  }
 }
}

レスポンス†

レスポンスコードは200を返し、レスポンスはjson形式である。

栄養分析ルール情報オブジェクト†

分析結果オブジェクト†

レスポンス例†

{
 {
  "analyzer": {
    "analyzerid": "testrule1",
    "name": "テストデータその２",
    "comment": "開発用"
  },
  "callbackdata": {
    "user-defined-data1": "ABCDEFG",
  },
  "analyze": {
    "steps": 12,
    "text": "ユーザーの名前 さんの基礎代謝は1543kcalです。生活活動強度は1.3、１日の所要カロリー量は2006kcalです。\n T/U平均スコアは 3.5 でした。\nこの食事の糖質の総摂取量は378gでした。\nこの食事の中で最も糖質摂取量の多い食品は「チャーシューメン」において105.6gでした。\n糖質を最も多く含む素材は「ごはん」に121.3gでした。\n豚肉類を50g以上食べています。食べた量は142.3gでした。\nキャベツを最も多く含む食品は「餃子(5個)」で31.5gでした。\n食事のNutriscoreの加重平均値は3.5でした。\n野菜、海藻、豆製品やコンニャク類など、食物繊維なども意識して積極的に取りましょう。\n今週の津川スコア１の摂取量の平均値は 72.4gです。\n先週の津川スコア１の摂取量の平均値は 199.5gです。\nこの食事の添加糖は7.1gです。\nこの食事の良い脂肪は29354.2mgです。\n"
  },
  "result": true
 }
}

バージョン†

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

目次

• トップページ
• APIを使用する
• 各APIの詳細
• サンプルソース