現在位置

8. 外部提供インタフェース（API1.0,API2.0）

8-1. 外部提供インタフェースとは

レファレンス協同データベースに登録されているデータを検索し、取得するためのインタフェース（API：Application Programming Interface）をご利用いただけます。

  • レファレンス事例を対象としたAPI1.0の提供を開始しました（2010/3/30）。
  • レファレンス事例、調べ方マニュアル、特別コレクション、参加館プロファイルを対象とし、検索機能を強化したAPI2.0の提供を開始しました(2013/02/12)。

ご利用にあたって

利用条件

営利を目的としない（データを利用することにより、経済的な対価を一切受け取らない）場合に限り、どなたでもご利用いただけます。

利用のための手続き

ご利用にあたって手続きは必要ありません。

留意事項

ご利用にあたっては以下の点にご留意ください。

クレジットの表示
本APIを利用するサイトやアプリケーションには、レファレンス協同データベースのAPIを用いていることを明示してください。また、各レファレンス事例などのデータの著作権は、特記されていない限り、当該データの提供館に帰属します。各データを表示する際は、提供館名も明示してください。
APIご利用状況把握のためのお願い
継続的にアクセスを行われる場合には、事務局までご連絡先、ご利用内容等をお知らせくださいますよう、ご協力をお願いします。頂いた情報は、APIの仕様を変更した際のご案内や、サービスの改善等に活用します。

8-2. API1.0の利用方法

概要

アクセスURL
https://crd.ndl.go.jp/refapi/servlet/refapi.RSearchAPI
対象データ
レファレンス事例（一般公開データのみ）
検索
旧レファレンス協同データベース（～2013/2/11まで稼働）の詳細検索画面と同等の検索が可能です。
出力項目
すべてのデータを出力します。
取得可能データ数
現在上限値はありません。今後の状況により上限値を設定する場合があります。
「結果の何番目からのデータを取得するか」をユーザが指定できるので、1回目は1件目から、2回目は201件目からのような形でデータを取得することも可能です。
提供プロトコル
REST

仕様

レファレンス協同データベースシステム　検索用API 1.0 仕様書

概要

アクセスURL
https://crd.ndl.go.jp/api/refsearch
対象データ
レファレンス事例、調べ方マニュアル、特別コレクション、参加館プロファイル（すべて一般公開データのみ）
検索
CQL（the Contextual Query Language）形式でクエリーを作成することで様々な条件を指定して検索を行うことが可能です。詳細は仕様書をご覧ください。
出力項目
それぞれのデータ種別の出力項目については下記リンクの仕様書をご覧ください。
ソート順は詳細検索画面で指定可能な項目すべてに対応しています。キーワードの一致順でソートする「適合度順」がおすすめです。
取得可能データ数
現在上限値はありません。今後の状況により上限値を設定する場合があります。
「結果の何番目からのデータを取得するか」をユーザが指定できるので、1回目は1件目から、2回目は201件目からのような形でデータを取得することも可能です。
デフォルトでは1件目～200件目を取得します。
提供プロトコル
REST
返却形式
XML形式またはRSS形式（RSS2.0）

仕様

レファレンス協同データベースシステム　検索用API 2.0 仕様書

検索例

以下にAPI2.0の検索例を記載します。わかりやすいよう、URL変換前のURLも併記しています。

  • 質問（question）に「読書」を含むレファレンス事例を検索
    URL変換前
    https://crd.ndl.go.jp/api/refsearch?type=reference&query=question any 読書
    URL変換後
    https://crd.ndl.go.jp/api/refsearch?type=reference&query=question%20any%20%E8%AA%AD%E6%9B%B8検索結果を確認する
  • 質問（question）に「本」を含み、かつ、回答（answer）に「村上春樹」を含むレファレンス事例を検索
    URL変換前
    https://crd.ndl.go.jp/api/refsearch?type=reference&results_num=50&query=question any 本 and answer any 村上春樹
    URL変換後
    https://crd.ndl.go.jp/api/refsearch?type=reference&results_num=50&query=question%20any%20%E6%9C%AC%20and%20answer%20any%20%E6%9D%91%E4%B8%8A%E6%98%A5%E6%A8%B9検索結果を確認する
  • 質問（question）に「伝統芸能」または「音楽」を含み、かつ、解決／未解決（solution）が「解決」（=0またはresolved）を含むレファレンス事例を検索
    URL変換前
    https://crd.ndl.go.jp/api/refsearch?type=reference&query=question any 本 音楽 and solution = 0
    URL変換後
    https://crd.ndl.go.jp/api/refsearch?type=reference&query=question%20any%20%E6%9C%AC%20%E9%9F%B3%E6%A5%BD%20and%20solution%20=%200検索結果を確認する

8-4. 新着情報RSSの利用

新着情報RSS

レファレンス事例データなどの新規公開・更新に関する情報を、RSSで配信しています。ご利用ください。

レファレンス協同データベースのデータの新規公開・更新情報(RSS1.0)
https://crd.ndl.go.jp/jp/public/rss/rss.rdf（RDF）
レファレンス協同データベースのデータの新規公開・更新情報(RSS2.0)
https://crd.ndl.go.jp/jp/public/rss2/rss.xml（XML）

RSSのご利用について

RSSは、RSSリーダーやRSSに対応したブラウザなどでご覧いただけます。

本RSSは個人の責任の範囲でご利用ください。また、都合により、予告なく公開を中止したり、URLを変更することがあります。また、システム保守のため、RSSの公開を一時停止することがあります。

RSSの利用方法に関するご質問、RSSリーダーなど第三者が提供するソフトの機能や動作環境などに関するお問い合わせには応じられませんので、ご了承ください。