APIについて

東京大学デジタルアーカイブポータルで提供するAPI

東京大学デジタルアーカイブポータルでは、次のAPIを提供しています。

  • 検索用API
    • 東京大学デジタルアーカイブポータルの検索ができます。
    • OpenSearchに対応しています。
  • ハーベスト用API
    • 東京大学デジタルアーカイブポータルに格納されたメタデータのダウンロードができます。
    • OAI-PMHで提供しています。

 

各APIの入力・出力形式、アクセスURL（ベースURL）は以下の通りです。

種類 プロトコル 入力形式 出力形式 アクセスURL
検索用API OpenSearch URL HTML, JSON, CSV他 https://da.dl.itc.u-tokyo.ac.jp/portal/search
ハーベスト用API OAI-PMH URL XML https://da.dl.itc.u-tokyo.ac.jp/portal/oai

 

東京大学デジタルアーカイブポータルで検索できるデータのうち、許諾が得られたもののみをAPIで提供しています。詳細は、「連携コレクション一覧」をご覧ください。

東京大学デジタルアーカイブポータルが持つメタデータは、「国立国会図書館ダブリンコアメタデータ記述（DC-NDL）」に従っています。したがって、各プロトコルで返戻されるデータの形式も、このDC-NDLを基本形としています。詳細は国立国会図書館のメタデータのページをご覧ください。

 

OpenSearch

OpenSearchクエリは以下の形式です

https://da.dl.itc.u-tokyo.ac.jp/portal/search?(パラメータ=値)& (パラメータ=値)&…&(パラメータ=値)です

パラメータ

内容

items_per_page

ページあたりの検索結果件数(20,50,100,200で指定。最大件数200件)

指定がない場合は200、指定値以外の場合は以下の検索結果件数を返す

  • items_per_page < 21 のとき 20
  • items_per_page < 51 のとき 50
  • items_per_page < 101 のとき 100
  • items_per_page > 201 のとき 200

collection

コレクションを指定

title

資料名を指定

author

編著者で検索

publisher

出版者で検索

DOI

DOIで検索

page

ページネーションの指定(検索結果の件数をitems_per_pageで割ってそのページ数)

sort_by

並び順を指定。以下を指定可能。

  • search_api_relevance ：関連順
  • field_title：資料名(降順)
  • field_title_1：資料名(昇順)
  • field_year_facet：関連年(降順)
  • field_year_facet_1：関連年(昇順)

_format

レスポンスの形式を指定。以下を指定可能。指定がない場合はHTML。

  • csv: csv形式
  • json : json形式
  • bix : refer/BibIX形式

 

OAI-PMH

東京大学デジタルアーカイブポータルでは、Webサービスや研究開発等にご活用いただくため、東京大学デジタルアーカイブポータルのメタデータをOAI-PMHで提供しています。OAI-PMHはデータベース中のまとまったメタデータの受け渡しを可能とするプロトコルです。setsによる取得範囲の指定や、from(開始日）やuntil(終了日)を指定することで、特定の日に作成・更新・削除されたメタデータを取り出すことができます。なお、東京大学デジタルアーカイブポータルのデータの各スキーマにおけるデータ項目のマッピング（紐づけ）は暫定的なものであり、今後変更となる可能性があります(2019年10月8日にマッピング設定を変更しました)。

デジタルアーカイブポータルのOAI-PMH Base URLは次のとおりです。これに主な動作を指定するverbと、そのverbのパラメータを付与することで各種リクエストを行えます。

https://da.dl.itc.u-tokyo.ac.jp/portal/oai

 

verb

verb 説明 例
Identify OAI-PMプロバイダ情報を取得する https://da.dl.itc.u-tokyo.ac.jp/portal/oai?verb=Identify
ListMetadataFormats 取得可能なメタデータ形式を取得する https://da.dl.itc.u-tokyo.ac.jp/portal/oai?verb=ListMetadataFormats
ListSets 取得可能なset（絞り込み条件）を取得する https://da.dl.itc.u-tokyo.ac.jp/portal/oai?verb=ListSets
ListIdentifiers メタデータID を取得する https://da.dl.itc.u-tokyo.ac.jp/portal/oai?verb=ListIdentifiers&metadataPrefix=dcndl_simple
ListRecords まとまったメタデータを取得する https://da.dl.itc.u-tokyo.ac.jp/portal/oai?verb=ListRecords&metadataPrefix=dcndl_simple
GetRecord identifierパラメータと組み合わせ、特定のメタデータの情報を取得する https://da.dl.itc.u-tokyo.ac.jp/portal/oai?verb=GetRecord&metadataPrefix=dcndl_simple&identifier=oai:da.dl.itc.u-tokyo.ac.jp:42219787-59b5-4570-b811-c3d1ff7ad321

 

verbのパラメータ

パラメータ 説明 当システムで利用可能な値 例
metadataPrefix 取得データのメタデータ形式を指定する

oai_dc, dcndl_simple, junii2, jpcoar

 https://da.dl.itc.u-tokyo.ac.jp/portal/oai?verb=ListRecords&metadataPrefix=dcndl_simple
identifier IDにより一意にデータを取得 "oai:da.dl.itc.u-tokyo.ac.jp:"の後に、各アイテム詳細ページURLの"https://da.dl.itc.u-tokyo.ac.jp/portal/assets/"以降の文字列を加えたものがID https://da.dl.itc.u-tokyo.ac.jp/portal/oai?verb=GetRecord&metadataPrefix=dcndl_simple&identifier=oai:da.dl.itc.u-tokyo.ac.jp:cf226493-0d04-2693-94c7-db99bb068777
set データの取得対象を絞る こちらでご確認ください。 https://da.dl.itc.u-tokyo.ac.jp/portal/oai?verb=ListRecords&metadataPrefix=dcndl_simple&set=gakken
from / until 取得する日付範囲を指定する YYYY-MM-DD 形式の日付 https://da.dl.itc.u-tokyo.ac.jp/portal/oai?verb=ListRecords&metadataPrefix=dcndl_simple&from=2021-10-01&until=2021-12-31

resumptionTokenによる複数ページのデータ取得

ListRecordsでは一度のリクエストに所得できるデータ件数に制限があります。デジタルアーカイブポータルでは1ページあたり100件が上限です。次のページがある場合、取得結果に含まれるresumptionTokenの値を使い、再度リクエストを行うことで次のページのデータを取得することができます。

  • resumptionTokenの例

    <resumptionToken expirationDate="2019-05-23T21:02:00Z" completeListSize="55951" cursor="100">1558602120512</resumptionToken>

  • resumptionTokenを使ったリクエスト例（ metadataPrefix 指定は必須。set, from, untilはパラメータに含めない）

https://da.dl.itc.u-tokyo.ac.jp/portal/oai?verb=ListRecords&metadataPrefix=dcndl_simple&resumptionToken=xxxxx

 

OAI-PMHに関する参考情報としては次があります。

各メタデータ形式については次をご参照ください。

metadataPrefix スキーマ名及び参照先
oai_dc Dubline Core
dcndl_simple DC-NDL (Simple)
junii2 junii2
jpcoar JPCOARスキーマ

 

ご不明な点は「お問合せフォーム」からご連絡ください。