サイト内検索 APIの使い方 || OSS iPedia

サイト内検索 APIの使い方

サイト内検索APIは、OSS iPediaで公開されているページを検索する機能を提供します。

リクエスト例

http://ossipedia.ipa.go.jp/webapi/search?key=XXXXXXXX&query=Linux&target=all&startIndex=1&count=10

リクエストURL

http://ossipedia.ipa.go.jp/webapi/search

リクエストパラメータ

パラメータ	説明	値	デフォルト値
key(必須)	OSS iPedia webAPIの利用キー	string
query	検索に用いるキーワード	string
target	検索対象。"all", "article", "case", "report", "pdf", "kb"から選択する	string	all
startIndex	検索結果の先頭位置	integer	1
count	検索結果の数	integer	10

レスポンス例

<rss version="2.0" 
	xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom">
	<channel>
		<title>OSS iPedia Search: Linux target:all order:byscore</title>
		<link>http://ossipedia.ipa.go.jp/webapi/search?key=PHD452A6KV&target=all&order=byscore&startIndex=1&count=10&query=Linux target:all order:byscore</link>
		<description>Search results for "Linux target:all order:byscore" at OSS iPedia</description>

		<opensearch:totalResults>393</opensearch:totalResults>
		<opensearch:startIndex>1</opensearch:startIndex>
		<opensearch:itemsPerPage>10</opensearch:itemsPerPage>
		<atom:link rel="search" type="application/opensearchdescription+xml"
			href="http://ossipedia.ipa.go.jp/webapi/opensearchdescription.xml"/>
		<opensearch:Query
			xmlns:ossipedia="http://ossipedia.ipa.go.jp/webapi/opensearchextensions/1.0/"
			role="request"
			searchTerms="linux"
			startIndex="1"
			count="10"
			ossipedia:target="all" />
		<item>
			<title>旧式ＰＣ等活用のためのOSSオフィスアプリケーションの性能調査</title>
			<link>http://crab412.rs-dom.mizuho-ir.co.jp/report/CS0806100376/</link>
			<description>旧式PC等活用のためのOSSオフィスアプリケーションの性能調査 OSS iPedia オープンソース情報データベー......、留意点についてまとめます。また、章の最後に旧式PCのLinuxによる再活用に係わる有識者によるコメントを示します。......Hz、メモリ:128MB オペレーティングシステム(OS) Turbolinux FUJI(SP2)あるいはWindows XP(SP2) アプリケーションソ......Hz、メモリ:128MB オペレーティングシステム(OS) Turbolinux FUJI(SP2)あるいはWindows XP(SP2) アプリケーションソ......向けのドライバが提供されているものが必要です。特に、Linux等OSS OSを採用する場合は、正式にドライバをリリースし......</description>

			<pubDate>2008-06-10 10:03:34</pubDate>
		</item>
	</channel>
</rss>

レスポンス

フィールド	説明	親要素
rss	レスポンスの全てを含む要素	なし
channel	配信元を示す要素	rss
title	配信元の名称	channel
link	配信元のURL	channel
description	配信元の簡単な説明	channel
opensearch:totalResults	現在の検索で得られる検索結果の個数	channel
opensearch:startIndex	最初の検索結果のインデックス	channel
opensearch:itemsPerPage	ページあたりに返される検索結果の個数	channel
opensearch:Query	検索クライアントが実行できる検索クエリの定義	channel
item	配信物を示す要素	channel
title	配信物のタイトル	item
link	配信物の存在するURL	item
description	配信物の簡単な説明	item
pubDate	配信物が公開された時刻	item

サイト内検索APIの記述文書

エラーレスポンス例

<Error>
	403: Forbidden.
</Error>

エラーレスポンス

フィールド	説明	親要素
Error	エラーコード+エラーメッセージ	なし

エラーコード

コード	説明
400	Bad request. 渡されたパラメータが期待されたものと異なる場合
403	Forbidden. アクセスを許されていない場合
404	Not Found. 指定されたリソースが見つからない場合

サンプルコード

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html lang="ja">
  <head>
    <title>サイト内検索API使用例</title>
  </head>
  <body>
<?php
function getContent()
{
    // URLの作成
    $request_url = "http://ossipedia.ipa.go.jp/webapi/search";
    $key = "XXXXXXXX";
    $query = "Linux+tag:Apache";
    $target = "case";
    $count = "5";
    $request_url .= "?query=".$query."&target=".$target."&key=".$key."&count=".$count;

    // APIへの接続
    $content = file_get_contents($request_url);
    if (!$content) {
      return "<p>情報の取得に失敗しました</p>";
    }

    // 取得XMLの解析
    $xml = simplexml_load_string($content);
    if (!$xml) {
      return "<p>情報の取得に失敗しました</p>";
    }

    // 出力の作成
    $ns = $xml->getNamespaces(true);
    $result = "<ul>\n";
    foreach ($xml->channel->item as $item) {
      $result .= "<li>";
      $result .= "<a href=\"".(string)htmlspecialchars($item->link)."\">";
      $result .= (string)htmlspecialchars($item->title);
      $result .= "</a>";
      $result .= "<p>".(string)htmlspecialchars($item->description)."</p>";
      $result .= "</li>\n";
    }
    $result .= "</ul>\n";
    return $result;
}
?>
    <h1>サイト内検索API使用例</h1>
    <?php echo getContent(); ?>
  </body>
</html>

Web APIの利用申請について

Web APIを利用したい方はこちらからWeb API利用キーの利用申請をしてください。

サイト内検索例

メール配信システム「MailPublisher Mobile Edition」
導入企業・団体名前 : エイケア・システムズ株式会社業種 : IT事業システム概要概要 Linuxとオープ...... ブレード CPUタイプ: IA32 ソフトウェア構成利用OSS: Linux: Red Hat Enterprise Linux, Apache, OpenLDAP, Postg......本電気株式会社関連URL http://www.express.nec.co.jp/linux/links/jirei.html#top......
ＴＲＰ交通費システム
導入企業・団体名前 : 社内(NECソフト)、NECソフトグループ各社、NEC関連会社、某自動車メーカー計9社......ress5800 CPUタイプ: IA32 ソフトウェア構成利用OSS: Linux: RedHatEnterpriseLinuxAS, Linux: RedHatEnterpriseL......inuxES, Linux: Red Hat Linux 7.1/7.2, Apache 1.3, PostgreSQL 7.1...... 商用アプリケーション: 駅すぱあとイントラ版 Win版・Linux版開発言語/ツール商用その他: Java 1.3 システム構築......
インターネットショッピング・システム
導入企業・団体名前 : 株式会社京王百貨店業種 : 流通システム概要概要富士通エフ・アイ・ピーの「......er shop service」の採用できめ細かなサービスが可能。Linuxをベースにシステムを構築、ASPサービスの利用で初期コス......減。富士通のIAサーバ「PRIMERGY TS220」を使って高信頼Linuxシステムを構築、3年で25倍の売上拡大を安定稼働で支える......。 Linuxベースで構築コスト削減と安定稼働を実現したインターネ......PRIMERGY CPUタイプ: IA32 ソフトウェア構成利用OSS: Linux, Apache システム構築を担当した企業・団体富士通株式......
教育情報ネットワークソリューション
導入企業・団体名前 : ほっかいどうスクールネット業種 : 文教システム概要概要 [1]約9割のサーバに......ェアサーバ名: CPUタイプ: ソフトウェア構成利用OSS: Linux: Red Hat Enterprise Linux, Apache 開発言語/ツール ......
履修情報管理
導入企業・団体名前 : 早稲田大学業種 : 文教システム概要概要オープンソースを活用し、大学内の全......ress5800 CPUタイプ: IA32 ソフトウェア構成利用OSS: Linux: MIRACLE LINUX Standard Edition 2.1, Apache, Postg......