クエリ仕様
CiNii Articles 著者検索のOpenSearchクエリは以下の形式です。
https://ci.nii.ac.jp/opensearch/author?(パラメータ=値)& (パラメータ=値)&…&(パラメータ=値)です。
クエリを構成する各パラメータは以下のとおりです。
| No. | パラメータ | 内容 |
|---|---|---|
| 1 | q | 著者名の検索、または著者IDの完全一致検索を行うパラメータ（必須） |
| このパラメータはURLエンコードされている必要がある。 | ||
| 2 | count | ページあたりの検索結果件数を指定するパラメータ（任意） |
| デフォルトは20。0以下もしくは200を越える値が指定された場合、もしくは指定されない場合はデフォルト設定とみなす。（200：論文検索結果画面の最大表示件数） | ||
| 3 | lang | 検索結果の言語を指定するパラメータ（任意） |
| デフォルトはja。日本語(ja)もしくは英語(en)を指定。ja、en以外の文字列、または指定がない場合はデフォルト設定とみなす。 | ||
| 4 | start | 取得する検索結果一覧の開始番号（任意） |
| デフォルトは0。0以下もしくは検索件数を越える値が指定された場合はデフォルト設定とみなす。 | ||
| 5 | format | レスポンスの形式を指定するパラメータ（任意） |
| デフォルトはxhtml（通常の検索一覧画面）。rss・atomを指定できる。rss・atomのフォーマットは後述。 | ||
| 6 | sortorder | ソート条件を指定する。デフォルトは1。 |
| 著者名降順→「1」／昇順→「2」 | ||
| 論文数降順→「3」 | ||
| 7 | 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#" | ||||||||
| xxmlns:dc | xmlns:dc="http://purl.org/dc/elements/1.1/" | ||||||||
| 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 Author OpenSearch -」にクエリを連結したもの。 例：<title>CiNii Author 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/nrid/1234567890123"> |
|||||
| 15 | title | 著者名 | |||||||
| 16 | link | 著者詳細ページのURI | 著者詳細ページのパーマリンクを表示 <link>https://ci.nii.ac.jp/nrid/1234567890123</link> |
||||||
| 17 | rdfs:seeAlso | rdf:resource | 著者RDFのURI | 著者RDFのURIを表示（ただしappidのパラメータは除く） <rdfs:seeAlso rdf:resource="https://ci.nii.ac.jp/nrid/1234567890123.rdf" /> |
|||||
| 18 | description | 所属機関名 | |||||||
| 19 | dc:subject | 研究分野名 | |||||||
| 20 | dc:date | 出版年月日 | この著者による最新の論文の出版年月日 | ||||||
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:opensearch | xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" | |||||||
| xml:lang | xml:lang=”ja”> | |||||||
| 3 | title | 必須 | フィードのタイトル | 「CiNii Author OpenSearch - 」 に検索語を連結したもの。 <title>CiNii Author 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 | 検索結果の論文情報を格納するコンテナ | ||||||
| 14 | title | 著者名 | ||||||
| 15 | link | href | 著者詳細ページのURI | 著者詳細ページのパーマリンクを表示 <link>https://ci.nii.ac.jp/nrid/1234567890123</link> |
||||
| 16 | link | rel | 参照先の文書との関係 | 固定値(alternate) | ||||
| 17 | type | 参照先の文書のMIMEタイプ | 固定値（application/rdf+xml） | |||||
| 18 | href | 著者RDFのURI | 著者RDFのURIを表示(ただしappidのパラメータは除く） href="https://ci.nii.ac.jp/nrid/1234567890123.rdf" |
|||||
| 19 | id | 著者詳細ページのURI | 著者詳細ページのパーマリンクを表示 <id>https://ci.nii.ac.jp/nrid/1234567890123</id> |
|||||
| 20 | content | 所属機関名 | 表示する内容は未ログイン状態のものとする | |||||
| 21 | type | 固定値（text） | ||||||
| 22 | dc:subject | 研究分野名 | ||||||
| 23 | updated | 出版年月日 | この著者による最新の論文の出版年月日 | |||||
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#", "@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 | @id | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。パラメータからappidは取り除かれる | |||||
| 8 | @graph | 配列 | 必須 | 配列の要素数は1 | |||||
| 9 | @id | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。パラメータからappidは取り除かれる | |||||
| 10 | @type | 必須 | 固定："channel" | ||||||
| 11 | title | 必須 | タイトル | 「CiNii Author OpenSearch -」にクエリを連結したもの。 例： "title":"CiNii Books Author - 国情+太郎", |
|||||
| 12 | description | 必須 | タイトル | titleと同じ内容 | |||||
| 13 | link | オブジェクト | 必須 | ||||||
| 14 | @id | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。パラメータからappidは取り除かれる | |||||
| 15 | dc:date | 必須 | 検索が行われた日時 | W3CDTF表記 | |||||
| 16 | opensearch:totalResults | 必須 | 検索結果総数 | ||||||
| 17 | opensearch:startIndex | 開始番号 | 検索結果のうち、何件目のデータから記述しているかを表示する | ||||||
| 18 | opensearch:itemsPerPage | 件数 | レスポンスに何件の検索結果が含まれているかを表示する | ||||||
| 19 | items | 配列 | |||||||
| 20 | @id | 著者詳細ページのURI | 著者詳細ページのパーマリンクを表示 | ||||||
| 21 | @type | 固定:"item" | |||||||
| 22 | title | 著者名 | |||||||
| 23 | link | オブジェクト | |||||||
| 24 | @id | 著者詳細ページのURI | 著者詳細ページのパーマリンクを表示 "link": {"@id":"https://ci.nii.ac.jp/nrid/1234567890123"}, |
||||||
| 25 | rdfs:seeAlso | オブジェクト | |||||||
| 26 | @id | 著者JSON-LDのURI | 著者JSON-LDのURIを表示(ただしappidのパラメータは除く） "rdfs:seeAlso":{"@id":"https://ci.nii.ac.jp/nrid/1234567890123.json"}, |
||||||
| 27 | description | 所属機関名 | |||||||
| 28 | dc:subject | 研究分野名 | |||||||
| 29 | dc:date | 出版年月日 | この著者による最新の論文の出版年月日 | ||||||
改訂履歴
2013年4月以降の改訂履歴をご確認いただけます。
2015年3月13日
JSON-LD レスポンスフォーマットを一部変更しました。詳細は以下のとおりです。
- "items"タグをオブジェクトから配列に変更しました。
- "rdf:Seq"と"rdf:li" タグを採用しない形式に変更しました。
- JSON-LDによるCiNii ウェブAPIをベータ版としていましたが、上記の変更をもって正式版としました。
2014年11月12日
- クエリ仕様のパラメータ「q」の検索対象に、著者ID (NRID) を追加しました。
2013年10月29日
- クエリ仕様の出力フォーマット（format）にJSON-LD形式（json）を追加しました。
- レスポンスフォーマット仕様にJSON-LD（ベータ版）を追加しました。
- クロスドメイン間の非同期通信に対応しました。