API機能に関するサービス影響・変更点について
国立国会図書館サーチが提供するAPI機能に関するサービス影響・変更点は次の通りです(内容は随時更新しています)。
-
目次
- 提供中のAPI機能へのサービス影響(2023年8月18日公開)
- API機能に関する変更点
- お問い合わせ先(お問合せフォーム)(2023年8月18日公開)
-
(1)全般的な変更点(2023年9月14日更新)
(2)データベース毎の変更点(2023年8月24日更新)
※リニューアルに伴う国立国会図書館サーチ全体の変更点については、下記のページでお知らせします。
国立国会図書館サーチ > リニューアルに伴う変更点について
https://iss.ndl.go.jp/information/2024renewal-general/
1. 提供中のAPI機能へのサービス影響
リニューアルに伴うデータ移行作業に際して、現行国立国会図書館サーチでのAPI提供機能に制約が生じる可能性がございます。
(2023年11~12月 ※現時点での予定です)
システムリニューアルによるAPIへの影響や、新しいサービスのAPI仕様等については、本ページをはじめとする国立国会図書館サーチのサイト上、及び、国立国会図書館サーチ公式X(Twitter)(@iss_ndl)でお知らせしていく予定です。
API利用申請フォームにてご連絡先等をお知らせいただいている方には、そちらにもシステムリニューアルに関するAPIへの影響についてご連絡を差し上げます。もし未申請で、国立国会図書館サーチのAPIをご利用されていて、ご連絡をご希望される方がいらっしゃいましたら、以下のページをご確認のうえ、利用申請をご検討いただけますと幸いです。
国立国会図書館サーチ > 国立国会図書館サーチについて > APIのご利用について
https://iss.ndl.go.jp/information/api/
2. API機能に関する変更点
(1) 全般的な変更点
(1-1)URL変更
現行のURL「https://iss.ndl.go.jp/」を変更します。(2024年1月予定)※リダイレクトは実施します。リダイレクトについては、現時点で終了の予定はありません。
これに伴い、API出力の一部も変更が生じます。
現行の書誌詳細画面のURLは、新しい書誌詳細画面URLへのリダイレクトを設定します。
※サービスの仕様変更により、一部、リダイレクトされないデータが生じる可能性があります。
(1-2)提供フォーマットの変更
現在APIを通じて提供しているフォーマットのうち「DC-NDL(Simple)」の提供を停止します。なお、「DC-NDL(RDF)」の提供には、変更ございません。
(1-3)データのID・OAI-PMHのidentifierの変更
一部のデータについて、データの「identifier」を変更します。OAI-PMHで返戻されるidentifierにも変更が生じます。
※国立国会図書館サーチの提供するデータのIDは、これまで国立国会図書館サーチで任意に払い出していましたが、IDの永続性の担保を容易にするため、提供機関が払い出す識別子(永続的識別子)を用いるように変更します。
※リニューアル後、変更前のidentifierについては、OAI-PMH でdeleteレコードを出力するよう調整中です。
(1-4)資料種別の指定値の変更
検索用APIで資料種別を指定するためのmediatypeのパラメータを変更・拡充します。詳細な変更内容については、確定次第、更新します。なお、mediatypeのパラメータ拡充に伴い、これまで提供してきたデータプロバイダグループIDによる指定を廃止します。
(2)データベース毎の変更点
(2-1)国立国会図書館蔵書(iss-ndl-opac等の当館作成書誌、R100000002)、国立国会図書館雑誌記事索引(zassaku、R000000004)
(A)ID(identifier)の変更
国立国会図書館蔵書、国立国会図書館雑誌記事索引のidentifierは、形式のみの変更となり、IDの数字部分には変更が生じません。例)国立国会図書館蔵書(iss-ndl-opac、R100000002)のデータ
これまでのID:https://iss.ndl.go.jp/books/R100000002-I000000511306-00
新しいID:https://xxxxxx.ndl.go.jp/books/R100000002-I000000511306
※ID末尾の「-00」がなくなります。新URLについては、確定次第、更新します(以下同様)。
また、OAI-PMHで返戻されるidentifierにも形式上の変更が生じます。
例)国立国会図書館蔵書(iss-ndl-opac、R100000002)のデータのOAI-PMHの<identifier>の出力
これまでの値:<identifier>oai:iss.ndl.go.jp:R100000002-I000000511306-00</identifier>
新しい値:<identifier>oai:xxxxxx.ndl.go.jp:R100000002-I000000511306</identifier>
(B)データプロバイダの名称変更
サービスリニューアルに伴い、データプロバイダ名を変更いたします。・「R100000002:国立国会図書館オンライン」を、「国立国会図書館蔵書」に変更。
・「R000000004:国立国会図書館オンライン(雑誌記事索引)」を、「国立国会図書館雑誌記事索引」に変更。
※なお、iss-ndl-opac等のデータプロバイダIDには変更ありません。
(2-2)国立国会図書館デジタルコレクション(ndl-dl、R100000039)、国立国会図書館デジタルコレクション(電子書籍・電子雑誌)(ndl-dl-online、R100000040)、視覚障害者等用デジタル資料(ndl-dl-daisy、R100000073)
(A)ID(identifier)の変更
データに付与するIDに、国立国会図書館デジタルコレクションの永続的識別子(info:ndljp/pid/1302584等)の値を採用するように変更します。例)国立国会図書館デジタルコレクション(ndl-dl、R100000039)のデータ
これまでのID:https://iss.ndl.go.jp/books/R100000039-I000690430-00
新しいID:https://xxxxxx.ndl.go.jp/books/R100000039-I1302584
上記の変更に伴い、OAI-PMHで返戻されるidentifierにも変更が生じます。
例)国立国会図書館デジタルコレクション(ndl-dl、R100000039)のデータのOAI-PMHの<identifier>の出力
これまでの値:<identifier>oai:iss.ndl.go.jp:R100000039-I000690430-00</identifier>
新しい値:<identifier>oai:xxxxxx.ndl.go.jp:R100000039-I1302584</identifier>
※国立国会図書館デジタルコレクション(ndl-dl)については、新旧IDの対照表を提供可能です(2024年1月予定)。
ご要望がありましたら、お問合せフォームよりご連絡ください。
(B)データプロバイダの変更
・「R100000040:国立国会図書館デジタルコレクション(電子書籍・電子雑誌)」を廃止し、「R100000039:国立国会図書館デジタルコレクション」へ統合。※データプロバイダID (ndl-dl、ndl-dl-online)の変更は生じません。データプロバイダIDを指定したAPI利用では、これまでと同じ範囲のデータが対象となります。
(C)コレクションコードによる指定の変更
現在、OAI-PMHでsetとして指定することができるコレクションコードの値(「D」または「I」始まりの値)を変更します。※変更は、国立国会図書館デジタルコレクションが定義するコレクション体系に沿った変更となります。
例)古典籍資料(貴重書等)
これまでの値:D02
新しい値:A00003 (参考)https://dl.ndl.go.jp/collections/A00003
※詳細な仕様については、次の仕様書を更新し、掲載予定です。
インタフェース仕様書附録4 コレクションコード・Access Rights一覧(PDF)
(2-3)その他のデータベース
(A)ID(identifier)の変更
データに付与するIDを変更します。また、OAI-PMHで返戻されるidentifierにも変更が生じます。例)デジタルアーカイブシステムADEAC(adeac、R100000094)のデータ
これまでのID:https://iss.ndl.go.jp/books/R100000094-I000081280-00
新しいID:https://xxxxxx.ndl.go.jp/books/R100000094-I75662
例)デジタルアーカイブシステムADEAC(adeac、R100000094)のデータのOAI-PMHの<identifier>の出力
これまでの値:<identifier>oai:iss.ndl.go.jp:R100000094-I000081280-00</identifier>
新しい値:<identifier>oai:xxxxxx.ndl.go.jp:R100000094-I75662</identifier>
(B)データプロバイダIDの変更
下記の通り、一部のデータプロバイダIDを変更します。・「R000000025:学術機関リポジトリデータベース(IRDB)(機関リポジトリ)」のデータプロバイダIDを、「jairo」から「irdb」へ変更。
・「R000000189:山形県立図書館デジタルライブラリー」のデータプロバイダIDを、「yamagatashi」から「yamagata」へ変更。
3. お問い合わせ先(お問合せフォーム)
国立国会図書館ホーム > お問い合わせ
https://www.ndl.go.jp/form/jp/service/contact/index.html
※「国立国会図書館サーチの技術仕様」を選択のうえ送信ください。