外部提供インタフェース仕様書(第1.4 版) 2026.3.31 16 9 isbn (または rft.isbn) - ○ ○ 完全 一致 また は 前方 一致 ISBN を検索 (10 桁または13 桁で入力した場合 は、10 桁、13 桁の 両方に変換して完 全一致検索を行 う。それ以外の桁 で入力した場合は 前方一致検索を行 う。) × 10 any ○ ○ ○ 部分 一致 すべてを検索 (簡易検索相当) ○ 11 ndl_jpno - ○ ○ 前方 一致 全国書誌番号を検 索(独自拡張) × 12 ndl_dpid ○ ○ ○ 完全 一致 データプロバイダ ID、コレクション コ ー ド 、 AccessRights のみ の検索 (独自拡張) ○ 13 mediatype ○ - ○ 完全 一致 資料種別を検索 (独自拡張) ○ 注)検索項目間の論理条件は全てAND である。 注)isbn, issn, ndl_jpno 以外は空白区切りで複数ワードを指定することができる。 複数指定した場合、ndl_dpid はOR 検索、他はAND 検索となる。 ※1:aufirtst とaulast が同時に指定された場合は、2つの条件でAND 検索を行う。
(6)データの返戻件数 10,000 件までという制限がある。
(7)返戻形式 リクエストクライアントに対しHTML で返戻され、GUI でブラウザに表示される。
(8)リクエスト例 ・ 例1. タイトルに「電子図書館」を含むもの https://ndlsearch.ndl.go.jp/api/openurl?btitle=%e9%9b%bb%e5%ad%90%e5%9 b%b3%e6%9b%b8%e9%a4%a8
・ 例2.著者に「夏目漱石」を含むもの https://ndlsearch.ndl.go.jp/api/openurl?au=%e5%a4%8f%e7%9b%ae%e6%bc%b1 %e7%9f%b3
外部提供インタフェース仕様書(第 1.4版) 2026.3.31 17 6. OAI-PMH
(1) 概要 OAI-PMH(Open Archives Initiative Protocol for Metadata Harvesting)により、本サ ービスが収集したメタデータを提供するインタフェースである。
図 6-1 OAI-PMH 提供インタフェースの概要
OAI-PMHはメタデータ交換のために OAI(Open Archives Initiative)によって開発が 進められているプロトコルである。基本仕様は以下のページに記述されている。 http://www.openarchives.org/OAI/openarchivesprotocol.html また、国立情報学研究所が日本語訳を公開している。 https://www.nii.ac.jp/irp/archive/translation/oai-pmh2.0/
OAI-PMHでは以下の 6つの操作(verbと呼ぶ)によってリポジトリにアクセスする。 「アイテム」とは 1 件のデータ(本サービスの場合では検索結果として表示される情報の 単位)のことである。 ・GetRecord(特定のアイテム 1件のメタデータを取得する) ・Identify(リポジトリについての情報を取得する) ・ListIdentifiers(全アイテムの識別子を取得する) ・ListMetadataFormats(サポートしているメタデータの形式を取得する) ・ListRecords(全アイテムのメタデータを取得する) ・ListSets(サポートしている set(グループ:絞込み条件)を取得する)
以下、 本サービスのリポジトリ (OAI-PMH外部提供インタフェース)の仕様を記述する。
(2) リポジトリ基本情報 リポジトリ基本情報として、Identifyリクエストに対する返戻内容を記述する。 国立国会図書館 サーチ 各機関 OAI
PMH メタデータ ( XML ) OAI-PMH-API ハーベストリクエスト ( URL ) 外部提供インタフェース仕様書(第1.4 版) 2026.3.31 18 表6-1 リポジトリ基本情報 タグ名 内容 応答値 repositoryName リポジトリ名 国立国会図書館サーチ baseURL リポジトリのベー スURL https://ndlsearch.ndl.go.jp/api/oaipmh protocolVersion リポジトリがサポ ートする OAI- PMH のバージョ ン Version 2.0 earliestDatestamp リポジトリ内の変 更、修正、削除を記 録するすべての日 付スタンプの保証 下限。この日付よ り前の日付スタン プを持つアイテム は存在しない。 リポジトリの初期構築日付ないし全面 再構築日付 deletedRecord リポジトリの削除 済みレコードに対 する処理法。 persistent granularity リポジトリがサポ ートする日付精度 YYYY-MM-DDThh:mm:ssZ
(3) サポートリクエストと引数 以下のリクエスト、引数をサポートする。 表6-2 リクエストと引数 No. リクエスト 引数 identifier Metadata Prefix from until set Resumption Token 1 GetRecord ◎ ◎
2 Identify
3 ListIdentifiers
◎ ◎ ○ ○ ○ 4 ListMetadataFormats ○
5 ListRecords
◎ ◎ ○ ○ ○ 6 ListSets
○ ◎:必須、○:任意(後述するようにfrom,until の期間には制約がある)
外部提供インタフェース仕様書(第 1.4版) 2026.3.31 19 (4) set setは選択的ハーベストを実現するためにアイテムをグループ化する定義である。特定の 属性を持つアイテム群に関するメタデータのみを取得する際に利用されるものである。set を指定した場合、データプロバイダ ID、データグループID、コレクションコード、公開範 囲(Access Rights)に該当するデータの情報のみが返戻される。 本サービスにおける setは、下記のとおりである。 ・ データプロバイダ ID ※1 ・ データグループ ID ※1 ・ コレクションコード ※2 ・ 公開範囲(Access Rights)※2 ※1 … 最新のデータプロバイダ・データグループおよびその ID の一覧は本書附録1 ( 「データプロバイダ・データグループ一覧と外部提供インタフェース対応表」 ) を参照 のこと。 ※2 … データプロバイダ 「国立国会図書館デジタルコレクション」 (ndl-dl)または「国 立国会図書館デジタルコレクション(電子書籍・電子雑誌) 」 (ndl-dl-online)にのみ付 与される。最新のコレクションコードならびに公開範囲(Access Rights)の一覧は、 附録 3( 「コレクションコード・Access Rights一覧」 )を参照のこと。 コレクションコードで指定可能な資料の概要については次のページに記述されている。 https://dl.ndl.go.jp/ja/intro.html#idx4
コレクションコードと公開範囲(Access Rights)など set を複数掛け合わせて検索する ことはできない。例えば、コレクションコードで検索する場合は、 「国立国会図書館デジタ ルコレクション」 (ndl-dl)の指定は行わず、コレクションコードのみを set として指定す る。 例1. コレクションコードを指定し検索する。 https://ndlsearch.ndl.go.jp/api/oaipmh?verb=ListIdentifiers&metadataPre fix=oai_dc&from=2024-01-05&set=A00001 例2. 公開範囲(Access Rights)を指定し検索する。 https://ndlsearch.ndl.go.jp/api/oaipmh?verb=ListIdentifiers&metadataPre fix=oai_dc&from=2024-01-10&set=ARinternet
なお、本システムでは set に指定するデータグループ ID、コレクションコード、公開範 囲(Access Rights)について、メタデータ上の値に変更があった場合でも変更前のメタデ ータの削除レコードは出力されない。例えば、setに公開範囲(Access Rights) 「インター ネット公開」を指定して収集している場合、ある時点で「インターネット公開」から「国立 国会図書館内公開」 に変更されたメタデータがあっても、 削除レコードが出力されないため 変更を検知できない。従ってset を指定して収集している場合は、定期的に全件または指定 外部提供インタフェース仕様書(第 1.4版) 2026.3.31 20 した set で全件を収集し、洗い替える必要がある。
(5) データの返戻件数 ListIdentifiers、ListRecordsにおいて一度に返戻されるデータの件数は200件である。 201件以降を取得したい場合には、200件を取得した際に通知されるresumptionToken を 指定してリクエストする。
(6) 返戻形式 データの返戻形式はXML である。スキーマ (metadataPrefix) はoai_dc 、dcndl、 dcndl_v3のいずれかを指定する。
(7) identifier OAI-PMH ではリポジトリ側のユニークなアイテム識別子をサービスプロバイダ側と授 受できる。これを利用して差分ハーベスト時にサービスプロバイダ側でデータの更新を行 うことなどができる(「(3)サポートリクエストと引数」でidentifier として記述したパ ラメータである)。 本サービスでは、このidentifier としてメタデータID を利用している(本サービスの全 メタデータに対して一意に付与されているID で、以下の構成である)。 oai(ドメイン名) :[リポジトリ番号]-[アイテム番号]
(8) from、until from に年月日(YYYY-MM-DD または YYYY-MM-DDThh:mm:ssZ)を指定した場合、 指定した年月日以降に更新された書誌を返戻し、 until に年月日(YYYY-MM-DD または YYYY-MM-DDThh:mm:ssZ)を指定した場合、指定した年月日以前に更新された書誌を返 戻する。本サービスのタイムゾーンは JSTのため、指定した from、untilは JSTとしてリ クエストされ、返戻されるデータの datestampも JSTとなる。 from,untilの期間に関する制約は「(9) OAI-PMHのアクセス制限」を参照のこと。
(9) OAI-PMH のアクセス制限 OAI-PMH のアクセスでは大量のデータ取得アクセスによって本サービスへの負荷が高 くなることを避けるために、以下の制限を設けている。 ListRecords 及びListIdentifier におけるfrom は必須とする。また、そのfrom、until によって指定可能な範囲(期間)には以下の制約条件がある。 ・ 1年を超える期間を指定することはできない ・ untilを指定しない場合には、上記の最大の期間がuntilに指定されたものとみなす
外部提供インタフェース仕様書(第1.4 版) 2026.3.31 21 (10) リクエスト例 例1. Identify リクエスト https://ndlsearch.ndl.go.jp/api/oaipmh?verb=Identify
例2. ListMetadataFormats リクエスト https://ndlsearch.ndl.go.jp/api/oaipmh?verb=ListMetadataFormats
例3. ListIdentifiers リクエスト https://ndlsearch.ndl.go.jp/api/oaipmh?verb=ListIdentifiers&met adataPrefix=oai_dc&from=2024-01-05
例4. ListRecords リクエスト https://ndlsearch.ndl.go.jp/api/oaipmh?verb=ListRecords&metadat aPrefix=oai_dc&set=aozora&from=2024-01-05 例5. GetRecord リクエスト https://ndlsearch.ndl.go.jp/api/oaipmh?verb=GetRecord&metadataP refix=oai_dc&identifier=oai:ndlsearch.ndl.go.jp:R100000002-I000 001287827
例6. ListSets リクエスト https://ndlsearch.ndl.go.jp/api/oaipmh?verb=ListSets
外部提供インタフェース仕様書(第 1.4版)
2026.3.31
22
改版履歴
No. 版数 発行日 改版内容
1 第 1.0 版 2024.1.5 初版作成
2 第 1.1 版 2024.2. 9 ・2 .共通事項
内部 json のリクエスト形式を追記
・3 .SRU
itemno の内容を修正
表 3-3 に複数値指定時の論理条件を追記
表 3-5 SRU のエラーメッセージ を追加
・4.OpenSearch
表 5-1 の注記に複数値指定は半角スペースで区切ること 、及び、
mediatyp e を複数指定した場合 は OR 検索となることを追記
・6 .OAI -PMH
datestamp を含む タイムゾーン が JST であることを追記 (2023.12
までは UTC で提供 )
3 第 1.2 版 2024. 7.12 ・3 .SRU
表 3-2 の dpid について説明を補足
表 3-2 の sortBy について説明を補足
表 3-3、本文中から前方一致、完全一致検索演算子の記載の削除
・4 .OpenSearch 表 4-1 の ndc について説明を補足
表 5-1 の dpid について説明を補足
・5.OpenURL
表 6-1 の dpid について説明を補足
4 第 1.3 版 2025.3.2 6 ・2 .共通事項
(7)に dcndl_v3 について説明を記載
・3.SRU
表 3-1、(6)返戻形式 に dcndl_v3 について説明を記載
・6 .OAI -PMH
(6)返戻形式 に dcndl_v3 について説明を記載
5 第 1.4 版 2026.3.31 ・2 .共通事項
(6)本サービスの検索との関係に補足説明を追加
書影 API に関する記述を削除
(7)に dcndl_v3 (正式版)について説明を記載
・3.SRU
表 3-1、(6)返戻形式 に dcndl_v3 (正式版)について説明を記載
・4. OpenSearch
(3)引数( [query] )の形式 表 4-1 any についての説明を修正
・6 .OAI -PMH
(1)概要に返戻対象メタデータについての説明を補足
(6)返戻形式 に dcndl_v3 (正式版)について説明を記載 、補足説
明を共通事項に移動
・7 .書影 API
削除