ndlsearch_api_20260331.pdf

Type: Document | Status: ready

外部提供インタフェース仕様書(第1.4 版) 2026.3.31

国立国会図書館サーチ

外部提供インタフェース仕様書

(第1.4 版) 2026.3.31

外部提供インタフェース仕様書(第1.4 版) 2026.3.31

目次 1. はじめに .......................................................................................................................... 1 2. 共通事項 .......................................................................................................................... 2 (1)アクセスURL ........................................................................................................... 2 (2)データプロバイダの一覧とID .................................................................................. 2 (3)データグループの一覧とID ...................................................................................... 2 (4)mediaType の一覧 ..................................................................................................... 2 (5)文字コード ................................................................................................................. 2 (6)本サービスの検索との関係 ....................................................................................... 3 (7)データの形式及び内容について ................................................................................ 3 3. SRU ................................................................................................................................. 4 (1) 概要 .......................................................................................................................... 4 (2) アクセスURL とリクエスト形式 ........................................................................ 4 (3) サポート範囲 ........................................................................................................... 4 (4) searchRetrieve の引数 ............................................................................................ 4 (5) CQL 仕様 ................................................................................................................. 5 (5) データの返戻件数 .................................................................................................... 8 (6) 返戻形式 ................................................................................................................... 8 (7) エラーメッセージ .................................................................................................. 10 (8) リクエスト例(CQL 例) ...................................................................................... 10 4. OpenSearch .................................................................................................................. 12 (1)概要 .......................................................................................................................... 12 (2)リクエスト形式 ....................................................................................................... 12 (3)引数([query])の形式 ........................................................................................... 12 (4)データの返戻件数 .................................................................................................... 13 (5)返戻形式 .................................................................................................................. 13 (6)リクエスト例 ........................................................................................................... 13 5. OpenURL ...................................................................................................................... 14 (1) 概要 ........................................................................................................................ 14 (2) リクエスト形式 ...................................................................................................... 14 (3)genre 指定と検索先 ................................................................................................. 14 (4)atitle,btitle 指定と検索先 ....................................................................................... 15 (5)指定可能な検索項目 ................................................................................................ 15 (6)データの返戻件数 .................................................................................................... 16 (7)返戻形式 .................................................................................................................. 16 (8)リクエスト例 ........................................................................................................... 16

外部提供インタフェース仕様書(第1.4 版) 2026.3.31

OAI-PMH ...................................................................................................................... 17 (1) 概要 ........................................................................................................................ 17 (2) リポジトリ基本情報 .............................................................................................. 17 (3) サポートリクエストと引数 ................................................................................... 18 (4) set .......................................................................................................................... 19 (5) データの返戻件数 .................................................................................................. 20 (6) 返戻形式 ................................................................................................................. 20 (7) identifier................................................................................................................ 20 (8) from、until ........................................................................................................... 20 (9) OAI-PMH のアクセス制限 .................................................................................... 20 (10) リクエスト例 ....................................................................................................... 21

外部提供インタフェース仕様書(第1.4 版) 2026.3.31 1

  1. はじめに

本資料は、各機関のアプリケーション等から「国立国会図書館サーチ」(以下、本システ ムという)を検索したり、メタデータを取得したりする際に利用するインタフェース仕様に ついて記述したものである。 本システムでは、以下の外部提供インタフェースを提供している。

表1-1 対応しているインタフェースの一覧と概要 No. インタフェ ースの種類 概要 入力形式 出力形式 1 SRU 情報検索のための通信規約である Z39.50 を 発展させた、REST を利用して情報内容を 検索する規約 URL XML 2 OpenSearch A9.com によって提唱された横断検索のため の通信規約 URL XML (RSS) 3 OpenURL コンテンツのリンク先を指定するため、メタ データ情報を URL 形式でリンクサーバに 送信するための規格 URL HTML 4 OAI-PMH OAI(Open Archives Initiative)が定め た、サーバ間でメタデータを機械的に収集す るための、要求と結果を授受するための通信 規約 URL XML

外部提供インタフェース仕様書(第1.4 版) 2026.3.31 2 2. 共通事項

(1)アクセスURL 各提供手段のアクセスURL(ベースURL)は以下である。

表2-1 アクセスURL No. 提供手段 URL 1 SRU https://ndlsearch.ndl.go.jp/api/sru 2 OpenSearch https://ndlsearch.ndl.go.jp /api/opensearch 3 OpenURL https://ndlsearch.ndl.go.jp/api/openurl https://mina.ndl.go.jp /api/openurl 4 OAI-PMH https://ndlsearch.ndl.go.jp/api/oaipmh HTTP でのアクセスをした場合はHTTPS にリダイレクトされる。 また、OpenSearch の設定ファイルであるOpenSearch Description Document は以 下のURL にてアクセス可能である。  https://ndlsearch.ndl.go.jp/api/opensearch_description

(2)データプロバイダの一覧とID 各提供手段において、リクエスト対象の検索対象データベース(以降、「データプロ バイダ」という)の指定はデータプロバイダID にて行う。データプロバイダは随時追 加されるため、最新のデータプロバイダとデータプロバイダID の一覧は本書附録1 (「データプロバイダ・データグループ一覧と外部提供インタフェース対応表」)を参照 のこと。

(3)データグループの一覧とID データプロバイダID を直接指定する以外に、データグループを指定することができ る。データグループは、メタデータに特定の情報が付与されているものをグループ化し、 データプロバイダを跨って横断的に取得する。最新のデータグループとデータグループ ID の一覧は本書附録2(「データグループID・mediaType 一覧」)を参照のこと。

(4)mediaType の一覧 提供手段のうち、SRU、OpenSearch、OpenURL についてはメタデータに付された 種別・形態を指定して検索することができる。最新のmediaType の一覧は本書附録2 (「データグループID・mediaType 一覧」)を参照のこと。 ※OAI-PMH はmediaType の指定はない。 (5)文字コード いずれの提供手段においても文字コードはUTF-8 である。

外部提供インタフェース仕様書(第 1.4版) 2026.3.31 3 (6)本サービスの検索との関係 各インタフェースで指定可能な検索項目、検索条件はインタフェースに依って異な る。また、本サービス(GUIでの各種検索)における検索項目、検索条件とも異なるた め、外部提供インタフェースでは、 基本的に本サービスで指定できる条件のうち一部に のみ対応していることに留意すること。 なお、検索用 API である SRU、OpenSearch、OpenURL では、同一と見なした資 料について同定を行ったメタデータを検索の対象としているのに対し(GUI での各種 検索対象と同等)、 ハーベスト用APIである OAI-PMHでは、 同定処理を行う前の各プ ロバイダに由来するメタデータを検索の対象としている。

(7)データの形式及び内容について 返戻されるデータの形式(スキーマ)及び内容に関しては、次項以降の各インタフェ ースの説明の中で記載する。 返戻されるデータ形式のうち、dcndl、dcndl_v3 は、 「国立国会図書館ダブリンコア メタデータ記述(DC-NDL) 」に基づき本サービスで定義した形式である。詳細につい ては 「DC-NDL(RDF)フォーマット仕様」(https://ndlsearch.ndl.go.jp/renkei/dcndl) を参照のこと。 dcndl は、 「DC-NDL( RDF)フォーマット仕様 ver.2 系」 (https://ndlsearch.ndl.go.jp/renkei/dcndl/version2) に、dcndl_v3は、 「DC-NDL(RDF) フォーマット仕様 ver.3系」(https://ndlsearch.ndl.go.jp/renkei/dcndl/version3)に基 づいた形式である。 なお、本サービスの内部項目である json ファイルは、下記のリクエスト形式で確認 することができる。 https://ndlsearch.ndl.go.jp/api/bib/external/search?cs=bib&f-token=[リポジトリ番 号-アイテム番号] ・ リクエスト例 https://ndlsearch.ndl.go.jp/api/bib/external/search?cs=bib&f-token=R100000039- I1000732
外部提供インタフェース仕様書(第 1.4版) 2026.3.31 4

  1. SRU

(1) 概要 SRU(Search/Retrieve Via URL)により、外部機関等が本サービスを検索し、結果を取 得するためのインタフェースである。

図 3-1 SRU 提供インタフェースの概要

SRUの基本仕様は以下に記述されている。 http://www.loc.gov/standards/sru/ 本サービス では SRU バージョン 1.1および 1.2をサポートする。 ZEEREXはサポートしない。

(2) アクセス URL とリクエスト形式 リクエスト形式は以下の URLである。  https://ndlsearch.ndl.go.jp/api/sru?operation=searchRetrieve&recordShema=[sch ema]&query=[......

(3) サポート範囲 本サービスでは SRU の主要なオペレーションである searchRetrieve をサポートする (explain 及び scan オペレーションはサポートしない) 。

(4) searchRetrieve の引数 表 3-1 searchRetrieve の引数 No. 引数名 指定すべき値 1 operation 必須 "searchRetrieve" 2 version 任意 1.1 または 1.2 (省略した場合は 1.2 とみなす) 国立国会図書館 サーチ 各機関 SRU 検索結果 ( XML ) SRU-API 検索 リクエスト ( URL ) 外部提供インタフェース仕様書(第1.4 版) 2026.3.31 5 3 query 必須 検索条件(CQL)、詳細は後述 4 startRecord 開始位置 省略した場合は1 とみなす 5 maximumRecords 最大取得件数 省略した場合は200 とみなす 6 recordPacking “xml”または”string” 省略した場合は”string”とみなす 7 recordSchema 取得データのスキーマ dc、dcndl、dcndl_v3 のいずれかを指定可能。省略した場合はdc と みなす 8 recordXpath 使用しない 9 resultSetTTL 使用しない 10 sortKeys ソートキー情報 version1.1 のときのみ有効 11 schema 使用しない 12 path title,creator,created_date,modified_date のいずれか sortKeys 指定がない場合はデフォルト(タイトル順) (version に1.1 を指定し、sortKeys を指定した場合にのみ利用可) 13 ascending “0”(降順),”1”(昇順) (version に1.1 を指定し、sortKeys を指定した場合にのみ利用可) 指定がない場合は”1” 14 stylesheet 使用しない 15 extraRequestData 使用しない 16 inprocess “true”を指定した場合、国立国会図書館新着書誌情報1のみを取得 17 onlyBib “true”を指定した場合、書誌情報(dcndl:BibResource)のみを取得 (recordSchema にdcndl、dcndl_v3 を指定した場合にのみ利用可)

(5) CQL 仕様 CQL は SRW における検索クエリの仕様である。本サービスでは CQL1.2 を基本とす る。CQL の基本仕様は「3.SRU (1) 概要」に示した URL で参照できる。CQL でクエリを 発行する際に利用できる項目は以下のとおりである。 表3-2 SRU 検索項目

1国立国会図書館が収集した国内刊行出版物及び外国刊行日本語出版物の作成中書誌情報 を、いち早く提供するサービス。 https://www.ndl.go.jp/jp/data/data_service/jnb/index.html

外部提供インタフェース仕様書(第1.4 版) 2026.3.31 6 No. 参照名 内容 1 dpid データプロバイダID、データグループID、コレクションコード、 AcessRights 2 dpgroupid データプロバイダグループID(2023 年12 月廃止) 3 title タイトル 4 creator 作成者 5 publisher 出版者 6 digitized_publisher デジタル化した製作者 7 ndc 分類(NDC、NDLC、LCC、DDC、UDC) 8 ndlc 分類(NDLC) 9 description 内容記述 10 subject 主題 11 isbn ISBN(10 桁、13 桁どちらの形式でも検索可能) 12 issn ISSN 13 jpno 全国書誌番号 14 from 開始出版年月日(YYYY、YYYY-MM、YYYY-MM-DD) 15 until 終了出版年月日(YYYY、YYYY-MM、YYYY-MM-DD) 16 anywhere 検索対象項目は国立国会図書館サーチの簡易検索と同一 17 itemno 国立国会図書館サーチ内部での書誌のトークン (トークン:リポジトリ番号-アイテム番号) 18 mediatype 本書附録2(「データグループID・mediaType 一覧」)参照 19 sortBy (searchRetrieve の 引数version に「1.2」 を指定した場合にの み利用可) ソートの基準となる参照名を記述する ただし、国立国会図書館サーチで有効なソート基準は「タイトル (title)」「作成者(creator)」「刊行年(issued_date)]」「メタデー タ作成日(created_date)」「メタデータ更新日(modified_date)」の いずれかとする。 昇順降順は続けて/sort.ascending、/sort.descendingと記述する。 CQL のクエリは、「AND」または「OR」によって連結する。検索キーワードに「AND」、 「OR」が含まれている場合(「andy」、「organic」なども含む)は検索エラーとなる。この場 合、「%3d」の前後に「%20」を付与して検索すると正常に検索が実行できる。

例:title に検索キーワード「book」かつpublisher に検索キーワード「library」を指 定する場合、「title%3dbook%20and%20publisher%3dlibrary」と指定する。 例:title に検索キーワード「andy」を指定する場合、 「title%20%3d%20%22andy%22」 と指定する。 いずれの項目も、完全一致や前方一致などの一致条件の指定はできない。項目ごとに、前

外部提供インタフェース仕様書(第1.4 版) 2026.3.31 7 方一致、部分一致、完全一致のいずれとみなされるかについては、「表3-3 SRU 項目毎に指 定可能な条件」を参照。 isbn,issn に関しては、一致条件は完全一致条件と看做される。isbn は10 桁または13 桁 で入力した場合に、10 桁と13 桁の両方に変換して完全一致検索を行う。それ以外の桁で入 力した場合も完全一致検索を行い、前方一致検索等は行わない。

from,until に関しては YYYY、YYYY-MM、あるいはYYYY-MM-DD 形式で指定し完全 一致条件とみなされる。from とuntil の両方を指定する場合、両方の指定フォーマットは 同じ(from がYYYY-MM なら、until もYYYY-MM 形式で指定する。)とする必要がある。 また、各項目内の論理条件としてand、or を指定可能である。同じ項目に対するand 検 索、or 検索は、それぞれall、any を用いて簡易に表記することができる。 (例えば、 「creator= 夏目 and creator=芥川」はall を用いて「creator all 夏目 芥川」、「title=夢十夜 or title= こころ」はany を用いて「title any 夢十夜 こころ」と表記することができる。) 以下に項目毎に指定可能な条件を示す。

表3-3 SRU 項目毎に指定可能な条件 No. 参照名 一致条件 論理条件指定 (all,any,=) 複数値指定 (デフォルトの 論理条件) 1 dpid 完全一致 =,any のみ ○(OR 検索) 2 dpgroupid 完全一致 =のみ × 3 title 部分一致 ○ ○(AND 検索) 4 creator 部分一致 ○ ○(AND 検索) 5 publisher 部分一致 ○ ○(AND 検索) 6 digitized_publisher 部分一致 ○ ○(AND 検索) 7 ndc 前方一致 =のみ × 8 ndlc 前方一致 =のみ × 9 description 部分一致 ○ ○(AND 検索) 10 subject 部分一致 ○ ○(AND 検索) 11 isbn 完全一致 =のみ × 12 issn 完全一致 =のみ × 13 jpno 完全一致 =のみ × 14 from 完全一致 =のみ × 15 until 完全一致 =のみ × 16 anywhere 部分一致 ○ ○(AND 検索) 17 itemno 完全一致 =のみ × 18 mediatype 完全一致 =のみ ○(OR 検索) 項目に対して複数の値を指定する場合、指定値は””で囲う必要がある(例:title="ruby

外部提供インタフェース仕様書(第1.4 版) 2026.3.31 8 python")。ただし、指定値が単一で式があいまいにならない場合は省略が可能である。 (例:title = architecture)。

(5) データの返戻件数 startRecord とmaximumRecords を指定することで、検索結果の取得開始位置及び取得 件数を指定できる。 startRecord は引数を省略した場合に1、maximumRecords は引数を省略した場合に200 が設定される。 maximumReords による取得件数は最大500 件まで指定できる。 ただし検索負荷回避のための制約により、両引数を指定した場合でも501 件目以降を取 得することはできない。 (例:検索結果の100 件目から20 件を取得する場合 startRecord=100&maximumRecords=20)

(6) 返戻形式

表3-4 SearchRetrieve Response 内容 No. 項目名 戻り値 1 Version “1.2” または “1.1”(リクエストで指定されたもの) 2 numberOfRecords 検索結果件数 3 resultSetId 使用しない 4 resultSetIdleTime 使用しない 5 nextRecordPosition 次レコード開始位置 startRecord=1,maximumRecords=200 の場合、検索結果数 が200 以上の場合は 201 が返戻される。検索結果数が200 以下(次ページがない)の場合は 0 が返戻される。 6 Diagnostics エラーメッセージリスト 7 extraResponseData 検索結果(ファセット) 8 echoedSearch retrieveRequest 使用しない 9 Records 検索結果リスト 10 Record 1 書誌の開始 11 recordSchema スキーマ 12 recordPacking “xml”ないし”string” 13 recordData 書誌情報の開始 14 recordPosition 当該書誌情報の位置 データの返戻形式は XML である。スキーマはリクエスト時に指定したものであり、dc、 dcndl、dcndl_v3 が指定可能である。

外部提供インタフェース仕様書(第 1.4版) 2026.3.31 9 extraResponseData として、検索した内容のファセットデータを返す。なお、ファセッ ト項目は以下の通りである。 (ただし、検索結果が0 のファセット項目は返戻データには含 まれない) ⚫ データプロバイダ データプロバイダごとの検索結果ヒット件数が返される。 なお、検索結果は dp要素内に、dpid=”データプロバイダ ID”で表現される。 データプロバイダ ID は本書附録1( 「データプロバイダ一覧と外部提供インタフェー ス対応表」 )を参照すること。 例: <lst name="REPOSITORY_NO">
<int name="R100000001">159</int>
<int name="R100000004">7</int> ・ ・ </lst> ※name=~で指定される数値は、データプロバイダのリポジトリ番号。リポジトリ 番号に関しては「本書附録1( 「データプロバイダ一覧と外部提供インタフェース 対応表」 )を参照のこと。 ⚫ NDC 資料の NDC 分類において、NDC コードの最初の桁の数値を分野と判断し、分野別に 検索ヒット数が返される。 例: <lst name=”NDC”> <int name=”7”>1</int> <int name=”9”>2</int> ・ ・ </lst> ⚫ 出版年 出版年ごとの検索ヒット件数を返す。 なお、出版年不明の場合は、ファセットの検索結果には含まれない。 例: <lst name=”ISSUED_DATE”> <int name=”1600”>1</int> <int name=”1650”>3</int> ・ ・ 外部提供インタフェース仕様書(第1.4 版) 2026.3.31 10 </lst>

(7) エラーメッセージ 引数(パラメータ)誤り、文法エラー、サーバーエラーなどエラーの場合、サーバはエラ ーメッセージを返礼する。 返戻形式は SRU 標準仕様「Diagnostics List」 ( https://www.loc.gov/standards/sru/diagnostics/diagnosticsList.html )の通りであるが、メ ッセージの内容は本システム独自のものが返戻される。 表3-5 SRU のエラーメッセージ No. メッセージ 説明 1 operation is not searchRetrieve operation にsearchRetrieve が指定されていない。 2 version must be 1.1 or 1.2 サポート外のversion が指定されている。 3 query must be present query が指定されていない。 4 illegal query syntax query の値の解析に失敗した。 5 illegal startRecord value startRecord に指定された値を数字として扱うこと ができない。 6 illegal maximumRecords value maximumRecordsに指定された値を数字として扱 うことができない。 7 illegal recordPacking value サポート外のrecordPackingが指定されている。 8 illegal recordSchema value サポート外のrecordSchemaが指定されている。 9 illegal sortKeys value version 1.1で使用できるsortKeysの指定値を正し く扱うことができない。 10 illegal mediaType value サポート外のmediaTypeが指定されている。 11 Record does not exist 条件に一致するレコードがない。

(8) リクエスト例(CQL 例)  例1. 2008 年に出版されていて、タイトルに「桜」を含むもの CQL は title="桜" AND from="2008" AND until="2008"となる。 ※ 実際の本サービスへの問い合わせURL は、これをエンコードしたもの ( title%3d%22%E6%A1%9C%22%20AND%20from%3d%222008%22%20AND%20until%3d%2 22008%22 ) をquery に付加し、 https://ndlsearch.ndl.go.jp/api/sru?operation=searchRetrieve&query=tit le%3d%22%e6%a1%9c%22%20AND%20from%3d%222008%22%20AND%20until%3d%222008 %22 となる。

・ 例2. 著者が「夏目漱石」のもの

外部提供インタフェース仕様書(第1.4 版) 2026.3.31 11 CQL は creator ="夏目漱石"となる 。 ※ 実際の本サービスへの問い合わせURL は、これをエンコードしたもの ( creator=%22%e5%a4%8f%e7%9b%ae%e6%bc%b1%e7%9f%b3%22 ) をquery に付加し、 https://ndlsearch.ndl.go.jp/api/sru?operation=searchRetrieve&query=cre ator=%22%e5%a4%8f%e7%9b%ae%e6%bc%b1%e7%9f%b3%22 となる。

外部提供インタフェース仕様書(第1.4 版) 2026.3.31 12 4. OpenSearch (1)概要 OpenSearch により、外部機関等が本サービスを検索し、結果を取得するためのインタフ ェースである。

図 4-1 OpenSearch 提供インタフェースの概要

OpenSearch はURL で検索リクエストを発行し、結果をRSS2.0 形式で取得するもので あり、その基本仕様は以下に記載されている。本サービス側の対応バージョンは1.0 であ る。 https://github.com/dewitt/opensearch

(2)リクエスト形式 リクエスト形式は以下のURL である。  https://ndlsearch.ndl.go.jp/api/opensearch?dpid=[dpid]&title=[title]&...

(3)引数([query])の形式 リクエストの中で指定できる項目は以下である。

表4-1 OpenSearch 検索項目 No. 参照名 内容 一致条件 複数 1 dpid データプロバイダID、データグループID、コレ クションコード、AcessRights 完全一致 ○ 2 dpgroupid データプロバイダグループID 完全一致 × 3 any 検索対象項目は国立国会図書館サーチの簡易検索 と同一 部分一致 ○ 4 title タイトル 部分一致 ○ 5 creator 作成者 部分一致 ○ 6 publisher 出版者 部分一致 ○ 7 digitized_publisher デジタル化した製作者 部分一致 ○ 8 ndc 分類(NDC、NDLC) 前方一致 × 9 from 開始出版年月日

× 国立国会図書館 サーチ 各機関 OpenSearch 検索結果 ( RSS 2 . 0 ) OpenSearch-API 検索 リクエスト ( URL)

外部提供インタフェース仕様書(第1.4 版) 2026.3.31 13 (YYYY、YYYY-MM、YYYY-MM-DD) 10 until 終了出版年月日 (YYYY、YYYY-MM、YYYY-MM-DD)

× 11 cnt 出力レコード上限値(省略時は200 とする)

× 12 idx レコード取得開始位置(省略時は1 とする)

× 13 isbn ISBN 10 桁または13 桁で入力した場合は、10 桁、13 桁 の両方に変換して完全一致検索を行う。 それ以外の桁で入力した場合は前方一致検索を行 う。 完全一致 または 前方一致 × 14 mediatype mediaType 一覧参照 完全一致 ○ 注)項目間の論理条件は全てAND である。 注)一つの検索項目内に空白区切り(半角スぺ―ス)でキーワードを複数指定することがで きる。 この場合、dpid とmediatype に関してはOR 検索、他はAND 検索となる。dpid のみ 指定した検索はできない。 注)引数(パラメータ)誤りの場合には検索結果ゼロ件となる。 注)from,until に関しては、YYYY、YYYY-MM、あるいは YYYY-MM-DD 形式で指定が 可能である。fromとuntilの両方を指定する場合、両方の指定フォーマットは同じ(from がYYYY-MM なら、until もYYYY-MM 形式で指定する。)とする必要がある。

(4)データの返戻件数 cnt パラメータで指定した件数までが返却される。デフォルトの返戻件数は200 件で、一 度に取得できる最大件数は500 件である。ただし、検索負荷回避のための制約により、idx パラメータとcnt パラメータと使って501件目以降を指定した場合でも該当のデータを取得 することはできない。

(5)返戻形式 データの返戻形式はRSS2.0 を本サービス用に拡張したものである。

(6)リクエスト例 ・ 例1.タイトルに「マリーアントワネット」を含むもの https://ndlsearch.ndl.go.jp/api/opensearch?title=%e3%83%9e%e3%83%aa%e 3%83%bc%e3%82%a2%e3%83%b3%e3%83%88%e3%83%af%e3%83%8d%e3%83%83%e3%83%88

・ 例2.青空文庫の中で、著者に「夏目」を含むもの https://ndlsearch.ndl.go.jp/api/opensearch?dpid=aozora&creator=%e5%a4%

外部提供インタフェース仕様書(第 1.4版) 2026.3.31 14 8f%e7%9b%ae 5. OpenURL

(1) 概要 OpenURLにより、外部機関等が 本サービス を検索し、結果を取得するためのインタフ ェースである。

図 5-1 OpenURL 提供インタフェースの概要

OpenURL は URL で発行されるリクエストに対して画面(HTML)で結果が返戻され るものであり、基本仕様は以下に既述されている。 https://www.niso.org/publications/z3988-2004-r2010-openurl-framework-context- sensitive-services

(2) リクエスト形式 リクエストは以下の形式の URL である。  https://ndlsearch.ndl.go.jp/api/openurl?genre=[genre]&…  https://mina.ndl.go.jp/api/openurl?au=[ au]&…

なお、この URL で返される検索結果 HTML は、本サービスの Web での検索結果画 面と同一のものであるため、本サービスの対応ブラウザでのみ表示が可能である。

(3)genre 指定と検索先 genre(またはrft.genre)を指定して記事レベルの書誌を対象とした検索が可能。 genre指定では、次の3パターンで検索対象を指定することができる。なお、genre=を指 定した場合と、rft.genre=を指定した場合の結果は同様である。 ・genre=articleを指定:記事レベルの書誌を対象に検索 ・genre=article以外を指定(titleまたはbook) :記事レベル以外の書誌(タイトルレ ベルと図書/巻号レベル)を対象に検索 ・genre指定なしの場合:全てのデータを対象に検索 なお、genre(または rft.genre)による指定と、atitle,btitle による指定に矛盾がある 国立国会図書館 サーチ OpenURL 検索結果 ( HTML ) OpenURL-API 検索 リクエスト ( URL ) クライアント 外部提供インタフェース仕様書(第1.4 版) 2026.3.31 15 場合はエラーメッセージを表示して、検索は中止する。 また、ndl_dpid で検索を指定した場合、genre によるデータプロバイダ指定も無効と なる。

(4)atitle,btitle 指定と検索先 ndl_dpid で検索を指定した場合、atitle,btitle による検索先指定は無効となり、title= 検索文字列&ndl_dpid=検索先を指定した場合と同様の動作となる。

(5)指定可能な検索項目 本サービスでは、OpenURL1.0 のパラメータ(キー)のうち一部をサポートする。 指定可能なパラメータを以下に示す。

表 5-1 OpenURL に関する検索項目 No. 項目 genre= article の場合 genre= article 以外 の場合 genre 指定無し の場合 一致 条件 検索方法 複数 指定 1 aulast (または rft.aulast) ○ ○ ○ 部分 一致 au(rft.au) と同様 ※1 × 2 aufirst (または rft.aufirst) ○ ○ ○ 3 au (または rft.au) ○ ○ ○ 部分 一致 作成者を検索 ○ 4 title, atitle (または rft.title, rft.atitle) ○ - ○ 部分 一致 (記事)タイトル を検索 ○ 5 btitle (または rft.btitle) - ○ ○ 部分 一致 タイトルを検索 ○ 6 jtitle (または rft.jtitle) ○ - ○ 部分 一致 ジャーナルタイト ルを検索 ○ 7 pub (または rft.pub) - ○ ○ 部分 一致 出版者を検索 ○ 8 issn (または rft.issn) ○ ○ ○ 前方 一致 ISSN を検索 ×

Page 1 of 2