メニュー
TOPページ
はじめに
関連コンテンツ設定
表示設定
解析
管理設定
テンプレート設定リファレンス

検索 API
PDFをダウンロード

テンプレートの設定で「API で使⽤する」にチェックを⼊れることにより、i-search の検索機能を API で利⽤することが出来ます。
API を使⽤して検索結果ページを作成する場合は、お客様側で以下のご対応いただく必要があります。

  1. 検索結果ページ（HTML・CSS など）を作成し、お客様の WEB サーバ上に配置してください。
  2. API への検索リクエスト、および API のレスポンスを検索結果ページに表⽰するプログラム（javascript など）を作成し、検索結果ページで実⾏してください。

API 仕様

エンドポイント

i-search 管理サイトに記載

  • 「テンプレート設定」＞「テンプレート名」のリンク先 URL がエンドポイントになります。

リクエスト⽅式

HTTP（GET ⽅式）

リクエストパラメータ

項⽬名 項⽬名（和名） 必須 種類 説明
temp テンプレート ○ ⽂字列 検索対象のテンプレート ID を指定する。
kw 検索キーワード ⽂字列 検索キーワードを指定する。
複数のキーワードを指定する場合は半⾓スペース区切りで指定する。
cpn 表⽰件数 半⾓数字 返却する検索結果件数（最⼤）を指定する。
  • デフォルト：10
  • 最⼤：100
page ページ番号 半⾓数字 検索結果のページ番号を指定する。
  • 例：[cpn]=10、[page]=2 の場合、11〜20 件⽬の検索結果を返却する。


ページ番号は、ページャー遷移の時だけ指定する。
  • ページ番号が指定された場合、管理サイトの各種集計の対象外となる。
ie ⽂字コード ○ 半⾓英字 API 呼び出し元ページの⽂字コードを指定する。
u UTF-8
s Shift_JIS
e EUC-JP
  • デフォルト：⾃動判別
ref リファラ ⽂字列 API 呼び出し元ページの URL を指定する。
URL エンコードした URL を指定する。
  • デフォルト：⾃動判別
sid セッション ID ⽂字列 セッション管理⽤ ID を指定する。
初回の API 呼び出し時は未指定とする。
2 回⽬以降の呼び出し時は初回に返却されたセッション ID（[search_info]->[sid]）を指定する。
pdf PDF 絞り込み ⽂字列 PDF ⽂書を検索対象に含めるか指定する。
on PDF ⽂書を検索対象に含める。
off PDF ⽂書を検索対象に含めない。
only PDF ⽂書のみ検索対象とする。
  • デフォルト：on
ord 並び順 ⽂字列 検索結果の表⽰順を指定する。
p ⼀致順
d 新着順
  • デフォルト：p
s_type 検索タイプ ⽂字列 検索タイプを指定する。
and AND 検索
or OR 検索
natural ⾃然⽂検索
  • デフォルト：and
- URL 絞り込み ⽂字列 管理サイトの「絞り込み条件設定」で設定した、検索結果の絞り込み条件を指定する。
項⽬名・値は管理サイトで設定したものを指定する。

リクエストサンプル

リクエストのサンプルについては、管理サイトの「テンプレート設定」＞「API 動作確認ページ」で検索実⾏後、「リクエスト URL」項⽬でご確認いただけます。

レスポンス⽅式

json データ

レスポンスパラメータ

項⽬名 項⽬名（和名） 種類 説明
response_code レスポンスコード 半⾓数字 リクエスト結果コード
200 正常
901 異常
search_info 検索基本情報 - 検索の基本情報
search_info.kw 検索キーワード ⽂字列 リクエスト時の検索キーワード
search_info.current_page ページ番号 半⾓数字 リクエスト時のページ番号
search_info.search_result_num 検索結果件数 半⾓数字 検索結果の合計件数
search_info.start_page_num 表⽰開始番号 半⾓数字 検索結果の開始番号
  • 例：「1〜10件を表⽰」の「1」に該当
search_info.end_page_num 表⽰終了番号 半⾓数字 検索結果の開始番号
  • 例：「1〜10件を表⽰」の「10」に該当
search_info.sid セッション ID ⽂字列 セッション管理⽤ ID
  • 次回以降のリクエストパラメータに付与
search_results 検索結果 - 検索結果のコンテンツ（繰り返し項⽬）
search_results.title タイトル ⽂字列 コンテンツのタイトル
search_results.body 本⽂ ⽂字列 コンテンツの内容
search_results.uri 表⽰⽤ URL ⽂字列 表⽰⽤ URL
search_results.link 遷移⽤ URL ⽂字列 遷移⽤ URL
  • こちらを使⽤することで管理サイトの統計情報に集計
search_results.icon アイコン 検索結果アイコンの情報（繰り返し項目）
search_results.icon.icon_text アイコン文字列 検索結果アイコンの文字列
search_results.icon.icon_text_color アイコン文字色 検索結果アイコンの文字色
search_results.icon.icon_bg_color アイコン背景色 検索結果アイコンの背景色
search_results.image_url サムネイルURL ⽂字列 コンテンツのサムネイル画像 URL
search_results.score 検索スコア ⽂字列 検索キーワードに対するコンテンツの⼀致スコア
search_results.mdate ⽇付 ⽂字列 コンテンツの登録⽇、もしくは更新⽇
related_contents 関連コンテンツ - 関連コンテンツ（繰り返し項⽬）
related_contents.url 遷移⽤ URL ⽂字列 遷移⽤ URL
  • こちらを使⽤することで管理サイトの統計情報に集計
related_contents.image_url サムネイルURL ⽂字列 関連コンテンツのサムネイル画像URL
related_contents.comment コメント ⽂字列 関連コンテンツに設定されたコメント
keyword_ranking キーワードランキング ⽂字列 キーワードランキング（繰り返し項⽬）
keyword_ranking.rank ランキング 半⾓数字 ランキングの順位
keyword_ranking.rank_word キーワード ⽂字列 ランキングのキーワード
predicted_words もしかしてワード - もしかしてワード（繰り返し項⽬）
predicted_words.predict_word キーワード ⽂字列 もしかしてキーワード
related_words 関連検索語 - 関連検索語（繰り返し項⽬）
related_words.related_word キーワード ⽂字列 関連キーワード

レスポンスサンプル

レスポンスのサンプルについては、管理サイトの「テンプレート設定」＞「API 動作確認ページ」で検索実⾏後、「リクエスト URL」リンクの遷移先でご確認いただけます。

API を利⽤した検索結果ページの作成サンプル

サンプル１（非同期型） https://search-sample.dga.jp/sample_1/
サンプル２（同期型） https://search-sample.dga.jp/sample_2/

Copyright © Scala Communications, Inc. All rights reserved.