IMD APIシステムの利用
Type D

API利用方法を前提に Type D についてご説明します。

Type D 概要

ステップ１：必要事項の確認

一連のAPI動作のためには、次のAPIと付帯情報が必要になります。

API

ユーザ作成API
検索API
記録API

クライアント認証情報（全APIに必要）

APIサーバー名・アクセスコード
アクセス認証/制限用の（貴社側アプリサーバーの）代表IPアドレス（またはトークン方式 ※追加有料・条件あり）

ユーザ認証情報（記録API及びユーザ作成に必要）

アプリケーションキー
アプリケーションシークレット

補足

ユーザ作成API・記録APIは記録系API仕様に、検索APIは検索系API仕様に定義されています。（※Basic認証は別途担当から入手下さい）

検索APIチェックリスト

同時利用想定人数を弊社に伝える（※スケーラビリティのご相談に乗りますが、数千未満であれば概ね問題ありません）
利用する検索API種別を選定する（※アプリのU/Iや操作導線を考慮してご検討下さい）
利用する検索API種別の中でのオプションを選定する（※仕様書をご確認下さい）
検索APIがレスポンスする「栄養素」などを選択する (データ仕様表) ※typeDでは分析する栄養素と異なって問題ありません。
栄養素以外のオプションデータを選択する（※メーカー名や三階層カテゴリなど）

ステップ２：アウトプットの確認

エクセル形式で納品する分析結果について、分析代行サービスにての説明やサンプルと同じく、ご契約した内容にて、csv ファイル形式で納品致します。(エクセル形式/.xlsx になる場合があります）

納品までの流れ

APIを利用して被験者ID(UID)を作成し、当該UIDに食事記録を保存して下さい。
分析をするタイミングにおいて弊社担当に被験者 UID をメールで通知して下さい。
被験者UIDについて分析を実施し、分析結果ファイルを返信いたします。（最大 3 営業日を頂く場合があります）

※分析結果のリクエストについて、原則としては１回でお見積り致しております。複数回、検証途中でのリクエストにも応じますが、事前に追加ご料金をご確認下さい。

ステップ３：ご契約とご利用開始

「ご契約書雛形」をベースに、貴社のご都合に最適なプランを弊社担当と共に調整させて頂きます。
ご契約の最終段階でご要望があれば、APIの各種情報を先行納品させて頂くことも可能です。
原則として、お取引に関しては前金でお願い致しております。

ステップ４：運用とサポート

APIは原則として占有型VPSでご提供致しますので、貴社負荷のみとなり、エンドユーザさまの増加にもVPS増強で対応可能です。
弊社独自の高速冗長化分散システムにより、データベースの齟齬や停止等は物理的に生じません。
お電話、メール、Webにてサポートしており、24時間自動監視システムで異常時は速やかに対処致します。

FAQ

☑ 検索APIのレスポンス時間は、どの程度を見込めば良いか？

✅ フィルタやソート機能は動的に実施し、規模や状況に依存しますので、一概には確約できませんが、LinuxベースのOSにおいて稼働するApacheが、静的な json ファイルをレスポンスする速度を最短とし、それにフィルタやソートを実施する時間が加算された程度です。なお、標準VPS は SSD/12core CPU の VPS となっております。

☑ 利用状況の把握はできるか？

✅ 本 TypeD のケースにおいて、利用状況が任意のユーザ状態とした場合、開発者さま自身が状態を把握できるため、ご用意はありません。分析代行システムのご利用時などにおいては、対象者を事前に確定するための「認証コード」の発行を致して行いますので、利用状況が把握できるシステムのご提供が可能です。

お問い合わせ

API利用に関するご質問・お見積りは、お気軽にお問い合わせください。

Webでお問い合わせ

電話: 050-5848-1465 (平日13時～17時)