クエリ仕様
CiNii Articles論文検索のOpenSearchクエリは以下の形式です。
https://ci.nii.ac.jp/opensearch/search?(パラメータ=値)& (パラメータ=値)&…&(パラメータ=値)です。
クエリを構成する各パラメータは以下のとおりです。
| No. | パラメータ | 内容 |
|---|---|---|
| 1 | q | フリーワードを指定するパラメータ（項6～18が指定されない場合は必須） |
| このパラメータはURLエンコードされている必要がある。 | ||
| 2 | count | ページあたりの検索結果件数を指定するパラメータ（任意） |
| デフォルトは20。0以下もしくは200を越える値が指定された場合、もしくは指定されない場合はデフォルト設定とみなす。（200：論文検索結果画面の最大表示件数） | ||
| 3 | lang | 検索結果の言語を指定するパラメータ（任意） |
| デフォルトはja。日本語(ja)もしくは英語(en)を指定。ja、en以外の文字列、または指定がない場合はデフォルト設定とみなす。 | ||
| 4 | start | 取得する検索結果一覧の開始番号（任意） |
| 0以下もしくは検索件数を越える値が指定された場合は空データを返す。 | ||
| 5 | format | レスポンスの形式を指定するパラメータ（任意） |
| デフォルトはxhtml（通常の検索一覧画面）。rss・atom・jsonを指定できる。それぞれのレスポンス仕様は後述。 | ||
| 6 | title | 論文名で検索する。URLエンコードされている必要がある。 |
| 7 | author | 著者名で検索する。URLエンコードされている必要がある。 |
| 8 | authorid | 著者ID (NRID) で検索する。 |
| 9 | issn | ISSNで検索する。 |
| 10 | publisher | 出版者で検索する。URLエンコードされている必要がある。 |
| 11 | affiliation | 著者所属で検索する。URLエンコードされている必要がある。 |
| 12 | journal | 刊行物名で検索する。URLエンコードされている必要がある。 |
| 13 | volume | 巻で検索する |
| 14 | issue | 号（通号）で検索する。 |
| 15 | page | ページで検索する。 |
| 16 | references | 参考文献名で検索する。URLエンコードされている必要がある。 |
| 17 | year_from | 出版年（From）で検索する。 |
| 18 | year_to | 出版年（To）で検索する。 |
| 19 | range | 検索対象オプションを指定する |
| デフォルトは0。0：すべて／1：CiNiiに本文あり／2：CiNiiに本文あり、または連携サービスにリンクあり | ||
| 20 | sortorder | ソート条件を指定する。デフォルトは1。 |
| 出版年降順→「1」／昇順→「2」 | ||
| 論文名降順→「3」／昇順→「4」 | ||
| 刊行物降順→「5」／昇順→「6」 | ||
| 被引用文献数降順→「7」 | ||
| 21 | appid | 必須です。 |
レスポンス仕様
クエリでレスポンスのフォーマットを、RSS, Atom, JSON-LD, HTMLから選択できます。
レスポンスの際のhttpヘッダに「Access-Control-Allow-Origin: *」を指定していますので、クロスドメイン間での非同期通信をご利用いただけます。
RSS1.0 レスポンスフォーマット仕様
| No. | タグ名 | 必須 | 内容 | 備考 | |||||
|---|---|---|---|---|---|---|---|---|---|
| 第1階層 | 第2階層 | 第3階層 | 第4階層 | 第5階層 | 属性 | ||||
| 1 | xml | 必須 | XML文書であることを宣言 | <?xml version="1.0" encoding="utf-8" ?> | |||||
| 2 | rdf:RDF | 必須 | 文書のルート要素 | xml:lang属性には返却する言語を記述する。xml:lang以外の属性は以下の文字列を記述する。 | |||||
| <rdf:RDF | |||||||||
| xmlns | xmlns="http://purl.org/rss/1.0/" | ||||||||
| xmlns:rdf | xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" | ||||||||
| xmlns:rdfs | xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" | ||||||||
| xmlns:dc | xmlns:dc="http://purl.org/dc/elements/1.1/" | ||||||||
| xmlns:prism | xmlns:prism="http://prismstandard.org/namespaces/basic/2.0/" | ||||||||
| xmlns:opensearch | xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" | ||||||||
| xml:lang | xml:lang=”ja”> | ||||||||
| 3 | channel | rdf:about | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。「&」で連結する。パラメータからappidは取り除かれる | ||||
| 4 | title | 必須 | タイトル | 「CiNii OpenSearch -」にクエリを連結したもの。 例： <title>CiNii OpenSearch - インタラクション+大向</title> |
|||||
| 5 | description | 必須 | タイトル | titleと同じ内容 | |||||
| 6 | link | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。「&」で連結する。パラメータからappidは取り除かれる | |||||
| 7 | dc:date | 必須 | 検索が行われた日時 | W3CDTF表記 | |||||
| 8 | opensearch:totalResults | 必須 | 検索結果総数 | ||||||
| 9 | opensearch:startIndex | 開始番号 | 検索結果のうち、何件目のデータから記述しているかを表示する | ||||||
| 10 | opensearch:itemsPerPage | 件数 | レスポンスに何件の検索結果が含まれているかを表示する | ||||||
| 11 | items | ||||||||
| 12 | rdf:Seq | ||||||||
| 13 | rdf:li | rdf:resource | 書誌詳細ページのURI | レスポンスに含まれる論文へのパーマリンクを列挙。最大でopensearch:itemsPerPageの数まで繰り返す | |||||
| 14 | item | rdf:about | 論文情報 | 最大でopensearch:itemsPerPageの数まで繰り返す。rdf:aboutにはパーマリンクを記述。 <item rdf:about="https://ci.nii.ac.jp/naid/1234567890"> |
|||||
| 15 | title | タイトル | |||||||
| 16 | link | 書誌詳細ページのURI | 書誌詳細ページのパーマリンクを表示 <link>https://ci.nii.ac.jp/naid/1234567890</link> |
||||||
| 17 | rdfs:seeAlso | rdf:resource | 書誌RDFのURI | 書誌RDFのURIを表示(ただしappidのパラメータは除く） <rdfs:seeAlso rdf:resource="https://ci.nii.ac.jp/naid/1234567890.rdf" /> |
|||||
| 18 | dc:creator | 著者名 | 複数ある場合は列挙する | ||||||
| 19 | dc:publisher | 出版者 | |||||||
| 20 | prism:publicationName | 刊行物名 | |||||||
| 21 | prism:issn | ISSN | |||||||
| 22 | prism:volume | 巻 | |||||||
| 23 | prism:number | 号（通号） | |||||||
| 24 | prism:startingPage | 開始ページ | |||||||
| 25 | prism:endingPage | 終了ページ | |||||||
| 26 | prism:pageRange | ページ | |||||||
| 27 | prism:publicationDate | 出版年月日 | W3CDTF表記 | ||||||
| 28 | description | 抄録 | 表示する内容は未ログイン状態のものとする | ||||||
| 29 | dc:date | 出版年月日 | prism:publicationDateと同じ内容 | ||||||
Atom1.0 レスポンスフォーマット仕様
| No. | タグ名 | 必須 | 内容 | 備考 | ||||
|---|---|---|---|---|---|---|---|---|
| 第1階層 | 第2階層 | 第3階層 | 第4階層 | 属性 | ||||
| 1 | xml | 必須 | XML文書であることを宣言 | <?xml version="1.0"encoding="UTF-8" ?> | ||||
| 2 | feed | 必須 | 文書のルート要素 | xml:lang属性には返却する言語を記述する。xml:lang以外の属性は以下の文字列を記述する。 | ||||
| <feed | ||||||||
| xmlns | xmlns="http://www.w3.org/2005/Atom" | |||||||
| xmlns:dc | xmlns:dc="http://purl.org/dc/elements/1.1/" | |||||||
| xmlns:prism | xmlns:prism="http://prismstandard.org/namespaces/basic/2.0/" | |||||||
| xmlns:opensearch | xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" | |||||||
| xml:lang | xml:lang=”ja”> | |||||||
| 3 | title | 必須 | フィードのタイトル | 「CiNii OpenSearch - 」 に検索語を連結したもの。 <title>CiNii OpenSearch - インタラクション+大向</title> |
||||
| 4 | link | href | 必須 | 同等内容の検索をHTMLで行う場合のURL | ||||
| 5 | link | rel | 必須 | 参照先の文書との関係 | 固定値(self) | |||
| 6 | type | 必須 | 参照先の文書のMIMEタイプ | 固定値（application/atom+xml） | ||||
| 7 | href | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。「&」で連結する。パラメータからappidは取り除かれる | ||||
| 8 | id | 必須 | リクエストされたURI | link要素と同じ | ||||
| 9 | updated | 必須 | 検索が行われた日時 | W3CDTF表記 | ||||
| 10 | opensearch:totalResults | 必須 | 検索結果総数 | |||||
| 11 | opensearch:startIndex | 開始番号 | 検索結果のうち、何件目のデータから記述しているかを表示する | |||||
| 12 | opensearch:itemsPerPage | 件数 | レスポンスに何件の検索結果が含まれているかを表示する | |||||
| 13 | entry | 検索結果の論文情報を格納するコンテナ | 最大でopensearch:itemsPerPageの数まで繰り返す。 | |||||
| 14 | title | タイトル | ||||||
| 15 | link | href | 書誌詳細ページのURI | 書誌詳細ページのパーマリンクを表示 <link href="https://ci.nii.ac.jp/naid/1234567890"/> |
||||
| 16 | link | rel | 参照先の文書との関係 | 固定値(alternate) | ||||
| 17 | type | 参照先の文書のMIMEタイプ | 固定値（application/rdf+xml） | |||||
| 18 | href | 書誌RDFのURI | 書誌RDFのURIを表示(ただしappidのパラメータは除く) href="https://ci.nii.ac.jp/naid/1234567890.rdf" |
|||||
| 19 | id | 書誌詳細ページのURI | 書誌詳細ページのパーマリンクを表示 <id>https://ci.nii.ac.jp/naid/1234567890</id> |
|||||
| 20 | author | 著者に関する記述 | 複数ある場合は列挙する | |||||
| 21 | name | 著者名 | ||||||
| 22 | dc:publisher | 出版者 | ||||||
| 23 | prism:publicationName | 刊行物名 | ||||||
| 24 | prism:issn | ISSN | ||||||
| 25 | prism:volume | 巻 | ||||||
| 26 | prism:number | 号（通号） | ||||||
| 27 | prism:startingPage | 開始ページ | ||||||
| 28 | prism:endingPage | 終了ページ | ||||||
| 29 | prism:pagePange | ページ | ||||||
| 30 | prism:publicationDate | 出版年月日 | W3CDTF表記 | |||||
| 31 | content | type | 抄録 | 表示する内容は未ログイン状態のものとする <content type="text">[抄録の内容]</content> |
||||
| 32 | updated | 出版年月日 | prism:publicationDateと同じ内容 | |||||
JSON-LD（ベータ版） レスポンスフォーマット仕様
| No. | タグ名 | 型 | 必須 | 内容 | 備考 | ||||
|---|---|---|---|---|---|---|---|---|---|
| 第1階層 | 第2階層 | 第3階層 | 第4階層 | 第5階層 | |||||
| 1 | @context | オブジェクト | 必須 | 文書のルート要素 | "@context": { "dc": "http://purl.org/dc/elements/1.1/", "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#", "opensearch": "http://a9.com/-/spec/opensearch/1.1/", "rdfs": "http://www.w3.org/2000/01/rdf-schema#", "prism": "http://prismstandard.org/namespaces/basic/2.0/", "@vocab": "http://purl.org/rss/1.0/" }, |
||||
| 2 | @vocab | 必須 | http://purl.org/rss/1.0/ | ||||||
| 3 | dc | 必須 | http://purl.org/dc/elements/1.1/ | ||||||
| 4 | rdf | 必須 | http://www.w3.org/1999/02/22-rdf-syntax-ns# | ||||||
| 5 | opensearch | 必須 | http://a9.com/-/spec/opensearch/1.1/ | ||||||
| 6 | rdfs | 必須 | http://www.w3.org/2000/01/rdf-schema# | ||||||
| 7 | prism | 必須 | http://prismstandard.org/namespaces/basic/2.0/ | ||||||
| 8 | @id | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。パラメータからappidは取り除かれる | |||||
| 9 | @graph | 配列 | 必須 | 配列の要素数は1 | |||||
| 10 | @id | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。パラメータからappidは取り除かれる | |||||
| 11 | @type | 必須 | 固定："channel" | ||||||
| 12 | title | 必須 | タイトル | 「CiNii OpenSearch -」にクエリを連結したもの。 例： "title":"CiNii OpenSearch - 検索エンジン 順位", |
|||||
| 13 | description | 必須 | タイトル | titleと同じ内容 | |||||
| 14 | link | オブジェクト | 必須 | ||||||
| 15 | @id | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。パラメータからappidは取り除かれる | |||||
| 16 | dc:date | 必須 | 検索が行われた日時 | W3CDTF表記 | |||||
| 17 | opensearch:totalResults | 必須 | 検索結果総数 | ||||||
| 18 | opensearch:startIndex | 開始番号 | 検索結果のうち、何件目のデータから記述しているかを表示する | ||||||
| 19 | opensearch:itemsPerPage | 件数 | レスポンスに何件の検索結果が含まれているかを表示する | ||||||
| 20 | items | 配列 | |||||||
| 21 | @id | 書誌詳細ページのURI | レスポンスに含まれる論文へのパーマリンク | ||||||
| 22 | @type | 固定:"item" | |||||||
| 23 | title | タイトル | |||||||
| 24 | link | オブジェクト | |||||||
| 25 | @id | 書誌詳細ページのURI | 書誌詳細ページのパーマリンクを表示 "link": {@id:"https://ci.nii.ac.jp/naid/1234567890"}, |
||||||
| 26 | rdfs:seeAlso | オブジェクト | |||||||
| 27 | @id | 書誌JSON-LDのURI | 書誌JSON-LDのURIを表示(ただしappidのパラメータは除く） "rdfs:seeAlso":{@id:"https://ci.nii.ac.jp/naid/1234567890.json"}, |
||||||
| 28 | dc:creator | 配列 | 著者名 | 複数ある場合は列挙する | |||||
| 29 | dc:publisher | 出版者 | |||||||
| 30 | prism:publicationName | 刊行物名 | |||||||
| 31 | prism:issn | ISSN | |||||||
| 32 | prism:volume | 巻 | |||||||
| 33 | prism:number | 号（通号） | |||||||
| 34 | prism:startingPage | 開始ページ | |||||||
| 35 | prism:endingPage | 終了ページ | |||||||
| 36 | prism:pageRange | ページ | |||||||
| 37 | prism:publicationDate | 出版年月日 | W3CDTF表記 | ||||||
| 38 | description | 抄録 | 表示する内容は未ログイン状態のものとする | ||||||
| 39 | dc:date | 出版年 | prism:publicationDateと同じ内容 | ||||||
改訂履歴
2013年4月以降の改訂履歴をご確認いただけます。
2015年3月13日
JSON-LD レスポンスフォーマットを一部変更しました。詳細は以下のとおりです。
- "items"タグをオブジェクトから配列に変更しました。
- "rdf:Seq"と"rdf:li" タグを採用しない形式に変更しました。
- JSON-LDによるCiNii ウェブAPIをベータ版としていましたが、上記の変更をもって正式版としました。
2014年11月4日
- クエリ仕様にパラメータ「著者ID（authorid）」を追加しました。
2013年10月29日
- クエリ仕様の「出力フォーマット（format）」にJSON-LD形式（json）を追加しました。
- レスポンスフォーマット仕様にJSON-LD（ベータ版）を追加しました。
- クロスドメイン間の非同期通信に対応しました。