IMD Inc.
https://imd.jp/
q u e r y ＠ imd . jp

24th

IMD APIシステムの利用 TypeA

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

TypeA 概要 snapshot
読み込み中・・・・

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

一連のAPI動作のためには、次のAPIと付帯情報が必要になります。
API 1) ユーザ作成API 2) 検索API 3) 記録API 4) 分析API クライアント認証情報（全APIに必要） ・APIサーバー名・アクセスコード ・アクセス認証/制限用の（貴社側アプリサーバーの）代表IPアドレス（またはトークン方式　※追加有料・条件あり） ユーザ認証情報（記録API及びユーザ作成に必要） ・アプリケーションキー ・アプリケーションシークレット
補足： 上記 1.ユーザ作成APIは、3.記録APIと同一分類として提供されており、 https://api.mobadai.jp/docs/record/に仕様が定義されています。 ※Basic認証は別途担当から入手下さい。 ※同上仕様リンクにはその他の機能も定義されていますが、TypeA ご契約の場合に動作を保証するものではありません。 ※同上仕様リンク内に食品文字列検索機能が定義されていますが、同仕様はXML版のみとなり、継続性について保障致しません。 上記 2.検索API及び分析APIは、 https://api.mobadai.jp/docs/search/に仕様が定義されています。 ※Basic認証は別途担当から入手下さい。 最新となる上記 2.検索APIや分析APIには多彩な機能が定義されていますが、 ご利用になれる検索機能はご契約時に指定されたもののみとなりますので、ご了承下さい。

検索APIチェックリスト

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

主要検索APIの機能比較

No.検索API区分名文字列検索複数検索語新商品unlimitedフィルタ・ソート備考
1食品文字列検索〇----シンプル
2食品文字列検索＋〇〇---汎用
3新商品検索〇-〇--新商品専用
4カスタム食品文字列検索〇〇〇〇〇推奨
5サジェスト検索〇----検索補助用
6食品詳細情報取得-----OIDの詳細取得
※ 全APIについてレスポンス最大数は 500 件に制限しております (カスタム食品文字列検索のみ、指定件数毎にページング処理でのレスポンスにも対応しております） ※「unlimited」は、コンビニ商品など同一社店名で数万件ある場合でもフィルタを通じ全商品対象にリーチできる機能です ※ 詳しくは仕様をご確認下さい

ステップ２　分析のルール設定解説

※担当にお問合せ下さい

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

「ご契約書雛形」をベースに、貴社のご都合に最適なプランを弊社担当と共に調整させて頂きます。 API利用方法にある通り、この事務手続きには、貴社法務のご都合が関連するため、 弊社では関知できませんが、一般的に数日から一か月程度で完了するものです。 ※ご契約内容については各社さまのご意向等を経ておりますので、一般的な内容と認識しております。
ご契約の最終段階（双方法務チェックが完了し、一方から捺印書類が送信・郵送された段階）で、 ご要望があれば先行して、APIの各種情報を先行納品させて頂くことは可能です。 ※但し、APIの構成内容が「確定後」に実装期間は 1 週間程度かかりますので、ご容赦下さい。 （変更時も同様に、最低一週間程度の変更処理期間を要します） ※この点は、応相談ですので、御見積・御請求書に本件事項記載をご確認下さい。 原則として、お取引に関しては前金でお願い致しております。 ※ライセンス更新の場合、ライセンス更新前日までのご入金をお願い致しております。 ※翌月末入金についてもご要望に応じておりますが、事務手数料を頂戴致しております。

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

APIについては、弊社では全て外部VPSを利用しておりますので、 必要に応じてご契約時に外部業者をご確認下さい。 ※AWSなど、ご指定のVPSがあれば、追加費用と追加実費などでお承り致します。 また、原則としてVPSは占有型でご提供致しますので、貴社負荷のみとなりますので、 エンドユーザさまが増加された場合には、VPSを増強して頂ければ対応可能です。 ※記録APIについては単純な追加ではないため、ご相談下さい。 特に検索・分析APIについては、独自の高速冗長化分散システムの構築により、 Oracle や MySQL のようなデータベースをVPSには搭載しておりませんので、 発生しやすい障害としてのデータベースの齟齬や停止等は物理的に生じません。
弊社ではお電話サポート（営業時間外は留守番電話の音声認識でメールが送信されるシステムを利用しております）、 メール、Webにてご対応しており、ご契約書に記載の対応時間で処置致しております。 またアプリケーションレイヤにおいても、24時間自動監視システムで、異常時は速やかに対処致します。

FAQ

☑　検索APIのレスポンス時間は、どの程度を見込めば良いか？ ✅　フィルタやソート機能は動的に実施し、規模や状況に依存しますので、一概には確約できませんが、 LinuxベースのOSにおいて稼働するApacheが、静的な json ファイルをレスポンスする速度を最短とし、 それにフィルタやソートを実施する時間が加算された程度ですので、数十から数百msec 程度で運用しています。 なお、標準VPS は SSD/12core CPU の VPS となっております。 ※実装上、レスポンスのCPUパワーよりも、伝送のための時間（レスポンスサイズ）を考慮されるべきで 検索APIにおいては、フィルタを活用してレスポンス数を減らし、 冗長的な栄養素のレスポンスは契約段階でお控え頂く方が得策とご提案いたします。 なお、同APIを弊社サンプルサービス（LINE版フードサーチ、同Web版フードサーチ）にて、 実証利用しておりますので、ユーザとしての反応速度は体感・検証頂けると思います。

©IMD.jp 2022