リニューアルに伴う国立国会図書館サーチのAPIの変更点について

2024年1月のリニューアルを受けた国立国会図書館サーチのAPIに関する変更点をまとめてお知らせします。

0. 全体案内

1. データプロバイダ別の変更一覧

2024年1月のリニューアルに際して生じたデータプロバイダ別の変更点は下表のとおりです。
現在のAPI提供データプロバイダについては「API提供データプロバイダ一覧」をご覧ください。
国立国会図書館サーチで検索できる連携データベースの一覧は「連携データベース一覧」をご覧ください。

リポジトリ番号データプロバイダIDデータプロバイダ変更内容
R100000002iss-ndl-opac国立国会図書館蔵書出力メタデータ範囲に雑誌の巻号レベルの書誌を追加
R100000002iss-ndl-opac-bib国立国会図書館蔵書(巻号以外)巻号レベルの書誌を含まない国立国会図書館蔵書を出力するデータプロバイダIDとして新設
R100000004
R100000039
(R100000040)
ndl-article-online国立国会図書館オンライン資料(記事)国立国会図書館雑誌記事索引オンライン資料編(zassaku-online)の書誌と、国立国会図書館デジタルコレクション(ndl-dl)、国立国会図書館デジタルコレクション(電子書籍・電子雑誌)(ndl-dl-online)の書誌のうち記事レベルの書誌を出力するデータプロバイダとして新設
R100000039
(R100000040)
ndl-dl
ndl-dl-online
国立国会図書館デジタルコレクション
国立国会図書館デジタルコレクション(電子書籍・電子雑誌)
データプロバイダを統合し、R100000040を廃止
※データプロバイダID(ndl-dl、ndl-dl-online)を指定しての検索では2023年12月までと同じ範囲を検索可能
R000000006refkyoレファレンス協同データベースAPI提供の対象外に変更。横断検索での連携に変更。
※レファレンス協同データベースが提供する検索用APIについては、外部提供インタフェース(API1.0,API2.0)のぺージを参照。
R000000020warpインターネット資料収集保存事業(WARP)横断検索での連携からAPI連携へ切替。API提供の提供対象に変更
R000000023アジア歴史資料データベース連携終了
R000000024ciniiCiNii Articles連携終了(2024年1月以降はCiNii Researchとして連携)。
R000000025jairo学術機関リポジトリデータベース(IRDB)(機関リポジトリ)データプロバイダIDを「jairo」から「irdb」へ変更
R000000033webcont国立国会図書館電子展示会連携終了
R100000049tenroku障害者用資料総合目録データプロバイダ名を「点字図書・録音図書全国総合目録」から「障害者用資料総合目録」へ変更(データプロバイダIDは変更無し)
R000000063インターネットマガジン バックナンバーアーカイブ連携終了
R000000066国立情報学研究所 「東洋文庫所蔵」貴重書デジタルアーカイブ連携終了
R000000067hukuoka福岡県立図書館 デジタルライブラリ連携終了(ADEACとして連携中)
R000000068tottori鳥取県立図書館所蔵絵図連携終了(とっとりデジタルコレクションとして連携中)
R000000184researchリサーチ・ナビAPI提供の対象外に変更。横断検索での連携に変更。
R000000189yamagatashi山形県立図書館デジタルライブラリーデータプロバイダIDを、「yamagatashi」から「yamagata」へ変更
R000000192奈良国立博物館収蔵品データベース連携終了
R000000197e国宝 - 国立博物館所蔵 国宝・重要文化財連携終了
R100000027韓国国立中央図書館蔵書連携終了
R100000028国会会議録検索システム連携終了
R100000029帝国議会会議録検索システム連携終了
R100000030日本法令索引連携終了
R100000031hourei-meiji日本法令索引(明治前期編)連携終了
R100000034衆議院HP連携終了
R100000035参議院HP連携終了
R100000036裁判官弾劾裁判所HP連携終了
R100000037裁判官訴追委員会HP連携終了
R100000067kinkan出版情報登録センター(JPRO)新規データプロバイダ出版情報登録センター(JPRO)(R100000137、jpro)に統合。
R100000076JapanKnowledge横断検索での連携に変更。(API提供は変わらず提供無し)
R100000096ciniibCiNii Books連携終了(2024年1月以降はCiNii Researchとして連携)
R100000130jpro-online 他出版情報登録センター(JPRO)(電子書籍)新規データプロバイダ出版情報登録センター(JPRO)(R100000137、jpro)に統合。
R100000136ciniirCiNii Research新設
R100000137jpro出版情報登録センター(JPRO)新設
※JPROからの連携データ全体を対象とするリポジトリ
※紙書籍の連携データを、近刊書籍を対象とする「発売予定日から60日間のデータ」から、期間の限りなく提供するように変更。
R100000141irdb-pub国立情報学研究所読書バリアフリー資料メタデータ共有システム新設
NDLイメージバンク横断検索で新規連携
NDLギャラリー横断検索で新規連携
ジャパンサーチ横断検索で新規連携

2. データグループ・資料種別の指定値の変更

データグループIDの変更は下表のとおりです。APIのご利用にあたってはデータプロバイダIDだけでなくデータグループIDによってもデータベースを指定いただくことが可能です。

データグループ名称データグループID説明
オープンデータopenメタデータの二次利用条件がCC0またはCC BYであるオープンなデータを対象としたデータグループを新設
タイトル書誌群title逐次刊行物のタイトルやシリーズものの図書など巻号をまとめる書誌を対象としたデータグループを新設
図書/巻号書誌群book雑誌の各巻、図書や地図など資料を利用する場合の基本単位となる書誌を対象としたデータグループを新設
記事書誌群article雑誌に掲載されている記事や論文の書誌を対象としたデータグループを新設
NDCOAI-PMHについてNDCによる指定を廃止
mediatypemediaType(値“1”~“9”)による資料種別の指定を廃止。代わりに、(5-1)に記載の資料種別・資料形態による指定の開始。
データプロバイダグループIDdigitalcontents、catalogue、site、reference、science、humanities、library、child、ndl左記のデータプロバイダグループによる指定を廃止

3. 提供するデータフォーマットの変更

「DC-NDL(Simple)」の提供を停止しました。
「DC-NDL(RDF)」の提供には、変更ございませんが、2024年1月のリニューアルに伴い軽微なフォーマット仕様の改訂を行いました。変更箇所は、フォーマット仕様の末尾の変更履歴をご確認ください。
国立国会図書館サーチの連携について>DC-NDL(RDF)フォーマット仕様

4.収集用API(OAI-PMH)に関する変更点

(4-0) すべてのデータベース共通の変更点

(A) アクセスURLの変更

下記のとおりアクセスURL(ベースURL)を変更しました。

  • 旧URL:https://iss.ndl.go.jp/api/oaipmh?
  • 新URL:https://ndlsearch.ndl.go.jp/api/oaipmh?

旧URLから新URLへのリダイレクトを行っております。リダイレクトについては、現時点で特に終期を予定しておりません。

(B) identifierの変更

  • 旧identifier:oai:iss.ndl.go.jp:【Rから始まるリポジトリ番号】-【Iから始まる数字】-00
  • 新identifier:oai:ndlsearch.ndl.go.jp:【Rから始まるリポジトリ番号】-【Iから始まる数字】

変更内容は次のとおりです。

  • 形式:旧identifierの「oai:iss.ndl.go.jp:」部分が「oai:ndlseaarch.ndl.go.jp:」に変更となり、旧identifier末尾の「-00」がなくなりました。
  • 値:Iから始まる数字部分に変更があるデータプロバイダと変更がないデータプロバイダがあります。利用されるデータプロバイダに応じて該当項目をご確認ください。

(C) OAI-PMHのidentifierの新旧対照表(2024年1月23日追記)

以下のURLからidentifierの新旧対照表を、データプロバイダごとに以下のURLからダウンロードいただけます。

https://ndlsearch.ndl.go.jp/files/idlist/[リポジトリ番号].gz
例)https://ndlsearch.ndl.go.jp/files/idlist/R100000002.gz

[リポジトリ番号]の部分を、新旧対照表を取得したいデータプロバイダの番号に変更ください。
リニューアルに伴い、リポジトリ番号が変更となっている場合は、旧国立国会図書館サーチでのリポジトリ番号を指定ください。
1. データプロバイダ別の変更一覧」に連携終了と記載しているデータプロバイダについては新旧対照表の提供はありません。
2024年1月5日時点で公開していた新旧ID対照表には、2023年12月11日以降に更新されたデータが含まれておりませんでした。また、一部改行位置が不正なデータも含まれておりました。不足分を補い、改行位置を修正したものに差し替えました。(2024年1月23日追記)

(D) 旧identifierのdeleteレコード配布

identifierの変更に伴い、旧国立国会図書館サーチのOAI-PMHで提供していたデータのdeleteレコードを、データプロバイダごとに以下のURLからダウンロードいただけます。旧国立国会図書館サーチのOAI-PMHから取得したメタデータの削除等にご利用ください。

https://ndlsearch.ndl.go.jp/files/deleterecords/[リポジトリ番号].gz
例)https://ndlsearch.ndl.go.jp/files/deleterecords/R100000002.gz

[リポジトリ番号]の部分を、deleteレコードを取得したいデータプロバイダの番号に変更ください。

(E) 新しい国立国会図書館サーチのデータ起点日

新しい国立国会図書館サーチのデータ起点日は、「2023-12-16」です。「from=2023-12-16」を指定することで新identifierの全件をOAI-PMHを使って取得することができます。
国立国会図書館蔵書等の当館のデータベースについては、下記のページにもデータの起点日を掲載しています。
ヘルプ>国立国会図書館サーチが提供するOAI-PMH>4-4. 国立国会図書館作成書誌データの起点日

(F) 新identifierの全件データの一括取得

新identifierのデータの全件を一括取得したい場合は「5. OAI-PMHの全件ファイル提供について」をご確認ください。

(4-1) 国立国会図書館蔵書、国立国会図書館雑誌記事索引の変更点

国立国会図書館蔵書(iss-ndl-opac等の当館作成書誌、R100000002)、国立国会図書館雑誌記事索引(zassaku、R000000004)に関する変更点は下記のとおりです。

(A) OAI-PMHのidentifierの変更

identifierの形式を変更しました。旧identifierの「oai:iss.ndl.go.jp:」部分が「oai:ndlseaarch.ndl.go.jp:」に変更となり、旧identifier末尾の「-00」がなくなりました。Iから始まる数字部分には変更はありません。
identifierの新旧対照表も提供しております。詳しくは、(4-0)を確認ください。

例)国立国会図書館蔵書(iss-ndl-opac、R100000002)のデータのOAI-PMHの<identifier>の出力
これまでの値:<identifier>oai:iss.ndl.go.jp:R100000002-I000000511306-00</identifier>
新しい値:<identifier>oai:ndlsearch.ndl.go.jp:R100000002-I000000511306</identifier>

(B) 削除レコード・全件データの取得

削除レコードと 全件データを取得可能です。詳しくは、(4-0)を確認ください。

(4-2) 国立国会図書館デジタルコレクション、視覚障害者等用デジタル資料の変更点

国立国会図書館デジタルコレクション(ndl-dl、ndl-dl-online、R100000039)、視覚障害者等用デジタル資料(ndl-dl-daisy、R100000073)に関する変更点は下記のとおりです。

(A) OAI-PMHのidentifierの変更

identifierの形式・値をともに変更しました。

例)国立国会図書館デジタルコレクション(ndl-dl、R100000039)のデータ
これまでのidentifier:<identifier>oai:iss.ndl.go.jp:R100000039-I000690430-00</identifier>
新しいidentifier:<identifier>oai:ndlsearch.ndl.go.jp:R100000039-I1302584</identifier>

(B) OAI-PMHのidentifierの新旧対照表

国立国会図書館デジタルコレクション(ndl-dl、ndl-dl-online)、視覚障害者等用デジタル資料(ndl-dl-daisy)のidentifierの新旧対照表を提供しております。詳しくは、(4-0)を確認ください。

(C) 削除レコード・全件データの取得

旧identifierの削除レコードと、新identifierの全件データを取得可能です。詳しくは、(4-0)を確認ください。

(D) コレクションの指定値の変更

OAI-PMHでsetとして指定することができるコレクションコードの値を変更しました。
新しいコレクションコードについては、API仕様書を確認ください。
ヘルプ>API仕様の概要>3. API仕様書(日本語版)

例)古典籍資料(貴重書等)
旧システムでの値:D02
旧システムでのOAI-PMHでのリクエスト例:https://iss.ndl.go.jp/api/oaipmh?verb=ListRecords&metadataPrefix=dcndl&set=ndl-dl:D02&from=2023-01-01&2023-01-31
新しい値:A00003 (参考)https://dl.ndl.go.jp/collections/A00003
OAI-PMHでのリクエスト例:https://ndlsearch.ndl.go.jp/api/oaipmh?verb=ListRecords&metadataPrefix=dcndl&set=A00003&from=2024-01-01&2024-01-31

(4-3) 上記以外のデータプロバイダの変更点

(A) OAI-PMHのidentifierの変更

identifierの形式・値をともに変更しました。identifierの新旧対照表を提供しております。詳しくは、(4-0)を確認ください。

(B) 削除レコード・全件データの取得

旧identifierの削除レコードと、新identifierの全件データを取得可能です。詳しくは、(4-0)を確認ください。

(4-4) OAI-PMHのタイムゾーンについて(2024年1月16日追加)

2023年12月までの旧・国立国会図書館サーチのOAI-PMHでは、datastampのタイムゾーンはUTC(協定世界時)を採用していましたが、2024年1月のリニューアルにより、国立国会図書館サーチのOAI-PMHのタイムゾーンはJST(日本標準時)となりました。
OAI-PMHで指定したfrom/untilの値はJSTとしてリクエストされ、JSTのdatestampの更新データが取得されます。(例えば、OAI-PMHを「from=2024-01-10T00:00:00Z」とリクエストした場合、JSTの2024-01-10の0時以降のdatestampを持つ更新データが取得されます。その際返戻される各メタデータのdatestampの値もJSTの時間を示します。)
ご承知おきいただければ幸いです。

5. 検索用API(SRU、OpenSearch、OpenURL)に関する変更点

(5-0) アクセスURLの変更

下記のとおりアクセスURL(ベースURL)を変更しました。(例はSRUでリクエストする場合です。そのほかの検索用APIについても同様に変更しました。)

  • 旧URL:https://iss.ndl.go.jp/api/sru?
  • 新URL:https://ndlsearch.ndl.go.jp/api/sru?

旧URLから新URLへのリダイレクトを行っております。リダイレクトについては、現時点で特に終期を予定しておりません。

また、2023年1月にリニューアルしたNDLサーチではID体系の変更を行いました。変更内容は、(4-0)の(B) identifierの変更を確認ください。

(5-1) 資料形態・資料種別の指定値の変更

検索用APIで資料形態・資料種別を指定するためのmediatypeのパラメータを変更・拡充しました。変更後の資料形態・資料種別は、下記の一覧のとおりです。
なお、mediatypeのパラメータ拡充に伴い、これまで提供してきたデータプロバイダグループ IDによる指定を廃止しました。

【資料形態】

  • booklet: 紙
  • micro: マイクロ
  • media: 記録メディア
  • digital: デジタル

【資料種別】

  • books: 図書
  • periodicals: 雑誌
  • articles: 記事
  • newspapers: 新聞
  • oldmaterials: 和古書・漢籍
  • maps: 地図
  • electronic: 電子資料
  • video: 映像資料
  • audio: 録音資料
  • online: 電子資料・電子雑誌
  • doctoral: 博士論文
  • reports: 規格・テクニカルリポート類
  • web: webサイト
  • scores: 楽譜
  • manuscripts: 文書・図像類

【コレクション】

  • children: 児童書
  • repository: リポジトリ収録資料
  • mina: 障害者(全体)
  • mina-daisy: 障害者-DAISY
  • mina-audio: 録音資料
  • mina-braille: 点字資料
  • mina-text: テキストデータ
  • mina-video: 映像資料
  • mina-booklet: 冊子体資料

(5-2) 現在確認している不具合(2024年1月31日現在)

(A) SRUのitemnoを用いた検索について(2024年1月31日解消)

SRUのitemnoを用いた検索について、itemnoの指定値が旧システムと異なっていることを確認しました。
2024年1月31日現在、修正を行い、itemnoとして「リポジトリ番号-アイテム番号」を指定することで、書誌データの1件検索ができるようになりました。

  • 旧システムの仕様
     itemnoとして「リポジトリ番号-アイテム番号-00」を指定
    https://iss.ndl.go.jp/api/sru?operation=searchRetrieve&version=1.2&query=itemno=R100000049-I032691189-00
  • 修正前の実装
     itemnoとして「アイテム番号」を指定
    https://ndlsearch.ndl.go.jp/api/sru?operation=searchRetrieve&version=1.2&query=itemno=032691189
  • 修正後の実装
     itemnoとして「リポジトリ番号-アイテム番号」を指定
    https://ndlsearch.ndl.go.jp/api/sru?operation=searchRetrieve&version=1.2&query=itemno=R100000049-I032691189

(B) Opensearchのanyを用いた複数語検索について(2024年1月31日解消)

Opensearchのanyを用いた複数語検索に不具合を確認しました。
2024年1月31日現在、修正を行い、検索語を半角スペース区切りにすることで、複数語のAND検索ができるようになりました。

(C) SRUのonlyBibを指定した検索について(2024年1月31日解消)

現在、SRUのonlyBibの指定に不具合があることをを確認しました。
2024年1月31日現在、修正を行い、onlyBibの指定によって書誌情報のみが取得できるようになりました。

(D) ARrekionのAccess Rightsによるメタデータ指定について(2024年1月16日追加)

現在OAI-PMH について、Access Rightsとしてset=ARrekionを設定した場合、返戻が0件となることを確認しています。
set=ARrekionを指定すると、国立国会図書館/歴史的音源配信参加館内公開の範囲のメタデータが取得できるよう修正を予定しています。
※ARrekionは、歴史的音源のうち、国立国会図書館/歴史的音源配信参加館内公開のコンテンツを対象としており、インターネット公開されている歴史的音源のコンテンツを含んでいません。
歴史的音源で提供する全データを取得される場合には、コレクションコード(set=A00024)を指定ください。

(E) SRUのsortByを指定した検索について(2024年1月24日追加)

現在、SRUのsortByを指定した検索について、取得件数(maximumRecords)で大きめの値を指定した際に、検索結果が0件となる場合があることを確認しています。
事象解消に向けて対応中です。

6. 書影APIに関する変更点

書影APIについて、アクセスURLの形式を下記のとおり変更しました。

  • これまでのアクセスURL:https://iss.ndl.go.jp/thumbnail/[isbn又はJP-eコード]
  • 新しいURL:https://ndlsearch.ndl.go.jp/thumbnail/[isbn又はJP-eコード].jpg
    ※アクセスURLの末尾に拡張子「.jpg」が必要になります。
    旧URLから新URLへのリダイレクトを行っております。リダイレクトについては、現時点で特に終期を予定しておりません。