ジャパンサーチ開発者向け簡易Web APIガイド
ジャパンサーチでは、SPARQL APIのほかに、登録されているメタデータを高速に検索・取得するための簡易的なWeb API機能を提供しています。
1章 簡易Web APIの概要
この章では、ジャパンサーチの簡易Web APIを利用する際に基本となる要素や、ジャパンサーチで取り扱われる概念を説明します。
1.1 用語について
1.2 APIの種類
1.3 APIのプロトコル
2章 参照API
この章では、ジャパンサーチ上のメタデータの情報を指定してアクセスするための参照APIについて、各エンドポイントとレスポンスのデータ形式を説明します。
2.1 アイテム参照API
2.1.1 commonプロパティ
2.1.2 rdfindexプロパティ
2.1.3 データソース項目
2.2 ギャラリー参照API
2.2.1 組織ページ情報の参照
2.3 連携データベース参照API
2.4 連携機関参照API
2.5 テーマ別検索参照API
3章 検索API
この章では、ジャパンサーチ上のメタデータを探索するための検索APIについて、各エンドポイントの概要及びレスポンスのファセットに含まれるコード値について説明します。
3.1 検索APIのエンドポイント
3.1.1 空検索
3.1.2 データベースIDを利用した絞り込み
3.2 JSONレスポンスのデータ構造
3.2.1 検索APIレスポンスのプロパティ
3.2.2 アイテム検索APIのfacetsプロパティ
3.2.3 ギャラリー検索APIのfacetsプロパティ
3.3 利用可能なクエリパラメータの対応早見表
4章 検索APIの基本クエリパラメータ
この章では、検索APIについて、各エンドポイントに共通するクエリパラメータ(検索キーワード及びページネーションの指定)を説明します。
4.1 検索キーワード
4.1.1 検索条件の結合方法について
4.1.2 アイテム検索
4.1.3 ギャラリー検索
4.1.4 連携データベース検索
4.1.5 連携機関検索
4.1.6 テーマ別検索に対する検索
4.2 ページネーション
4.2.1 ページネーション(fromとsize)
4.2.2 全件取得(scroll)
5章 フィルタによる絞り込み
この章では、検索APIについて検索結果を絞り込むためのクエリの作り方やファセットの見方を説明します。