OpenSearch

Table of Contents

• 1. URL
• 2. リクエスト形式
• 3. 参照例
• 4. データ返却形式
• 5. リクエスト例

1. URL

https://kn.ndl.go.jp/api/opensearch

2. リクエスト形式

https://kn.ndl.go.jp/api/opensearch? [参照名]=[値]
参照名を複数使用する場合は&で連結します。
https://kn.ndl.go.jp/api/opensearch? [参照名1]=[値]&[参照名2]=[値]&...

3. 参照例

参照名	内容	一致条件
any	ひなぎくの詳細検索画面のキーワード検索に相当	部分一致
title	タイトル	部分一致
creator	作成者	部分一致
publisher	出版者・公開者	部分一致
from	日付で絞込み検索を行う際の開始日付 （YYYY-MM-DD）
cnt	出力レコード上限値 （省略時は200とする）
idx	レコード取得開始位置 （省略時は1とする）
identifier	識別子。ISSトークンを指定。 ISSトークンは、詳細画面のURL:http://kn.ndl.gojp/xxxxのxxxxの部分。
mediatype	資料種別。値により資料種別を指定。 指定できる値は、1･･･文書資料, 2･･･Webサイト, 3･･･写真, 4･･･音声・動画, 99･･･その他
dpid	検索対象データベース。リポジトリIDを指定。
language	言語。ISO639-2形式で指定
openAccess	"1"を指定した場合、「Web閲覧可」のデータのみ対象

(備考)
・参照名間の論理条件はすべてANDである。
・参照名の値は、"(半角ダブルクォーテーション)で囲む必要はない。
ただし、複数値を指定する場合は、"で値を囲み、値は、△(半角スペース)区切りで区切る。
(例）title="津波 地震"
・URLエンコードは、値ごとに行う。
・参照名の値が不適切な場合には検索結果０件となる。
・複数（同一参照名内）、複数（同一リクエスト内）には対応していない

4. データ返却形式

4.1.基本構造

返戻されるデータは、下表のとおり

・ひなぎくで提供しているOpensearchの情報
・itemタグで繰り返す、個々の資料のメタデータ

からなります。

タグ名	内容	値
title	サービス名が返却されます。	NDL東日本大震災アーカイブ OpenSearch
link	RSS 発行元URLが返却されます。	http://kn.ndl.go.jp
description	検索条件が返却されます。形式は以下のとおりです。 Search result for [参照名]=[値] 参照名が複数存在する場合は、半角スペースで区切られて表示されます。	例： Search result for title= 防災 Search result for title= 防災 any=津波
language	使用している言語が返却されます。 言語はISO639-2形式で返却されます。	ja
openSearch:totalResults	取得リストのデータ数（検索結果件数）が返却されます。	-
openSearch:startIndex	参照名「idx」で指定したidxの値（レコード取得開始位置)が返却されます。指定を省略した場合、一律「1」が返却されます。	-
item	個々の資料に対するメタデータが返却されます。複数のメタデータが返却される場合、資料の数だけitemタグが繰り返されます。	-

4.2.itemタグの内訳

個々の資料のメタデータは

・RSS2.0 準拠項目･･･タグの属性値が"xmlns:xsi="で始まるもの。
・dc項目･･･タグの属性値が"xmlns:dc="で始まるもの。

からなります。

RSS2.0 準拠項目は、以下のとおりです。

タグ名	内容	値
title	資料のタイトル	-
link	資料の詳細情報画面のURL。形式は以下の通り。 http://kn.ndl.go.jp/ISSトークン]	例：http://kn.ndl.go.jp/R200200041-I000000398-00
description	メタデータの概要。形式は以下のとおりです。 <![CDATA[（メタデータの概要がここに記載）]]>
guid	ISSトークン	例：R200200041-I000000398-00
pubDates	出版年月日。yyyy-mm-dd形式。	例：2017-03-17
category	資料種別 mediatypeの値に対応する日本語名。	例：文書資料

5. リクエスト例

タイトルに「防災」の用語を含む資料を検索する場合
リクエスト形式は、以下のとおりとなります。

https://kn.ndl.go.jp/api/opensearch?title=防災

このままでは検索出来ないので、「防災」の文字列をURLエンコードする必要があります。
「防災」のURLエンコード値は、「%E9%98%B2%E7%81%BD」なので、実際のリクエストに用いるURLは以下のとおりとなります。
https://kn.ndl.go.jp/api/opensearch?title=%E9%98%B2%E7%81%BD