IMD APIシステムの利用
Type C
API利用方法を前提に Type C についてご説明します。
Type C 概要
ステップ１：必要事項の確認
一連のAPI動作のためには、次のAPIと付帯情報が必要になります。
API
- 検索API
クライアント認証情報（全APIに必要）
- APIサーバー名・アクセスコード
- アクセス認証/制限用の（貴社側アプリサーバーの）代表IPアドレス（またはトークン方式 ※追加有料・条件あり）
補足
検索APIは、https://api.mobadai.jp/docs/search/に仕様が定義されています。（※Basic認証は別途担当から入手下さい）
最新となる検索APIには多彩な機能が定義されていますが、ご利用になれる検索機能はご契約時に指定されたもののみとなりますので、ご了承下さい。
検索APIチェックリスト
- 同時利用想定人数を弊社に伝える（※スケーラビリティのご相談に乗りますが、数千未満であれば概ね問題ありません）
- 利用する検索API種別を選定する（※アプリのU/Iや操作導線を考慮してご検討下さい）
- 利用する検索API種別の中でのオプションを選定する（※仕様書をご確認下さい）
- 検索APIがレスポンスする「栄養素」などを選択する (データ仕様表)
- 栄養素以外のオプションデータを選択する（※メーカー名や三階層カテゴリなど）
主要検索APIの機能比較
| No. | 検索API区分名 | 文字列検索 | 複数検索語 | 新商品 | unlimited | フィルタ・ソート | 備考 |
|---|---|---|---|---|---|---|---|
| 1 | 食品文字列検索 | ○ | - | - | - | - | シンプル |
| 2 | 食品文字列検索＋ | ○ | ○ | - | - | - | 汎用 |
| 3 | 新商品検索 | ○ | - | ○ | - | - | 新商品専用 |
| 4 | カスタム食品文字列検索 | ○ | ○ | ○ | ○ | ○ | 推奨 |
| 5 | サジェスト検索 | ○ | - | - | - | - | 検索補助用 |
| 6 | 食品詳細情報取得 | - | - | - | - | - | OIDの詳細取得 |
検索APIにおいては「特定検索語システム」機能も付帯しております。
※ 全APIについてレスポンス最大数は 500 件にさせて頂いております。(カスタム食品文字列検索のみ、指定件数毎にページング処理でのレスポンスにも対応しております）
※「unlimited」は、コンビニ商品など同一社店名で数万件ある場合でもフィルタを通じ全商品対象にリーチできる機能です。
※ 詳しくは仕様をご確認下さい。
ステップ２：ご契約とご利用開始
「ご契約書雛形」をベースに、貴社のご都合に最適なプランを弊社担当と共に調整させて頂きます。
ご契約の最終段階でご要望があれば、APIの各種情報を先行納品させて頂くことも可能です。
原則として、お取引に関しては前金でお願い致しております。
ステップ３：運用とサポート
APIは原則として占有型VPSでご提供致しますので、貴社負荷のみとなり、エンドユーザさまの増加にもVPS増強で対応可能です。
弊社独自の高速冗長化分散システムにより、データベースの齟齬や停止等は物理的に生じません。
お電話、メール、Webにてサポートしており、24時間自動監視システムで異常時は速やかに対処致します。
FAQ
☑ 検索APIのレスポンス時間は、どの程度を見込めば良いか？
✅ フィルタやソート機能は動的に実施し、規模や状況に依存しますので、一概には確約できません。LinuxベースのOSにおいて稼働するApacheが、静的な json ファイルをレスポンスする速度を最短とし、それにフィルタやソートを実施する時間が加算された程度が目安となります。
弊社は常に占有型VPSでご提供致しますので、他社アクセス等に影響されることもなく、数十万同時アクセスなどに対しても、VPS を並列増強することで対応できるアーキテクチャを採用致しております。（AWS各種にも対応致しており、ご相談下さい。）
なお、標準VPS は SSD/12core CPU の VPS となっております。
そのため、実際の実装動作を検証するに、レスポンスのCPUパワーなど VPS の課題よりも、伝送のための時間（レスポンスサイズ）を考慮頂くことが重要になっております。
お問い合わせ
API利用に関するご質問・お見積りは、お気軽にお問い合わせください。
Webでお問い合わせ電話: 050-5848-1465 (平日13時～17時)