AgriKnowledge ウェブサービス(WebAPI)

APIの利用方法

AgriKnowledgeのWebAPIをご利用いただくにあたり、事前に以下の点をお読みいただいたうえで、利用条件を遵守していただきます。

AgriKnowledgeで提供するAPI

OpenSearch
AgriKnowledgeで公開しているデータを検索するサービスです。APIによる検索対象範囲は、プロトコルによって異なります。
機能の詳細につきましては、こちらをご覧ください。
OAI-PMH
AgriKnowledgeで公開しているデータを、一括または1つを指定してXMLで取得できるウェブサービスです。
機能の詳細につきましては、こちらをご覧ください。

利用条件

  • 非営利目的での利用のみ可能(営利目的の利用は不可)
  • 公的・私的サービスでの利用、個人・団体の別は問いません。

利用のための手続き

OAI-PMHの利用に際しては、お問い合わせフォームより連絡先、ご利用内容等を入力のうえ、お申し込みください。
お申し込み後、担当者よりご連絡し、設定など詳細について調整させていただきます。

なお、いただきました情報は、API仕様変更時の連絡やAPI利用実態把握等に活用させていただきます。

提供するデータについて

本サイトから提供するデータの範囲は、AgriKnowledge上のデータのうち以下を満たすものです。

  • 公開の許諾が得られているもの
  • 全文データがPDFファイルとして公開されているもの

注意事項

大量アクセスに関するご注意
サーバへの過負荷を避けるため、同時リクエスト数には制限を設けています。
また、特定のサーバから継続して大量のアクセスがある場合は、アクセスを遮断する等の措置を行う場合があります。
クレジットの表示
本APIを利用するサイトやアプリケーションには、AgriKnowledgeのAPIを用いていることを明記してください。
また、個々のデータを表示する際は、データ提供元機関等の名称を明記してください。
免責事項
著作権・免責事項等」をご覧ください。

OpenSearch

概要

AgriKnowledgeで公開しているデータを、他のサイトから自由に利用できるウェブサービスです。
OpenSearchのクエリを作成し、AgriKnowledgeにリクエストすることで、AgriKnowledgeの画面での検索と同等の検索を行うことができます。
基本的な仕様は以下のページを参照ください。

Open Search 仕様書 1.1 ドラフト4版
http://sites.google.com/site/tsukamoto/doc/opensearch/spec-1-1-draft4

リクエスト形式

http://agriknowledge.affrc.go.jp/api/opensearch?[パラメータ=値]&[パラメータ=値]…&[パラメータ=値]

引数の形式

参照名 内容 一致条件 複数指定 備考
q 全ての項目 部分一致 -
title タイトル 部分一致 -
author 作成者(著者) 部分一致 -
publisher 発行元 完全一致 -
agrovoc 分類[AGROVOC] - × 「agrovoc」に含まれているキーワード以外は検索不可
jat 分類[JAT] - × 「JAT」に含まれているキーワード以外は検索不可
niitype 分類[NIItype] - × -
issn ISSN 前方一致 × -
isbn ISBN 前方一致 × -
gpid データプロバイダグループID 完全一致 × 指定可能な値は次表のとおり
pid データプロバイダ 完全一致 指定可能な値は次表のとおり
from 日付での絞り込み(下限) - × YYYY-MM-DD
until 日付での絞り込み(上限) - × YYYY-MM-DD
cnt 出力数の上限 - × デフォルト:100
index 出力の開始位置 - × デフォルト:1
format 出力フォーマット - × atom/rss/html
デフォルト:atom
データプロバイダグループID(gpid)、データプロバイダ(pid)の指定可能な値
データ種別 データプロバイダグループID(gpid) データプロバイダ(pid) 内容
書誌データ biblio 101 図書
102 雑誌
論文データ article 201 本文が日本語で記述された農学学術論文
203 一般雑誌記事を含む論文データ
204 研究者個人向け論文データ
研究情報 product 301 研究成果情報
302 研究業績
303 研究課題
画像情報 image 401 品種
402 農業機械、器具
403 研究に関する画像
動画情報 movie 501 研究所の紹介動画
502 研究に関する動画

要求例

著者に「農林」を含むもの
http://agriknowledge.affrc.go.jp/api/opensearch?author=%E8%BE%B2%E6%9E%97
研究成果情報の中で、タイトルに「バイオマス」を含むもの
http://agriknowledge.affrc.go.jp/api/opensearch?pid=301&title=%E3%83%90%E3%82%A4%E3%82%AA%E3%83%9E%E3%82%B9

OAI-PMH

概要

AgriKnowledgeで公開しているデータを、一括または1つを指定してXMLで取得できるウェブサービスです。
OAI-PMHは、OAI(Open Archives Initiative)によって開発が進められているメタデータ交換のためのプロトコルです。基本的な仕様は以下のページを参照ください。

国立情報学研究所によるOAI-PMH2.0日本語訳
http://www.nii.ac.jp/irp/archive/translation/oai-pmh2.0/

リポジトリの基本情報

項目名 内容 返戻値
repositoryName リポジトリの名称 Agricultural Forestry and Fisheries Research Repository
baseURL リポジトリのベースURL http://agriknowledge.affrc.go.jp/oai-pmh/request
protocolVersion サポートしているOAI-PMH バージョン 2.0
adminEmail agriknowledge@affrc.go.jp ric-db@ml.affrc.go.jp
earliestDatestamp 日付スタンプの保証下限 1970-01-01T00:00:00Z
deletedRecord 削除ポリシー transient
granularity 最も細かいデータ収集単位 YYYY-MM-DDThh:mm:ssZ
compression 圧縮コード化のサポート gzip, deflate

メタデータ形式

metadataPrefix schema metadataNamespace
junii2 http://irdb.nii.ac.jp/oai/junii2.xsd http://irdb.nii.ac.jp/oai
oai_dc http://www.openarchives.org/OAI/2.0/oai_dc.xsd http://www.openarchives.org/OAI/2.0/oai_dc/
dc_ndl http://www.ndl.go.jp/jp/library/data/meta/2010/06/ndl-terms.rdf http://ndl.go.jp/dcndl/terms/
AgMES http://purl.org/agmes/agrisap/dtd/ http://purl.org/agmes/1.1/
marc http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd http://www.loc.gov/MARC21/slim
mods http://www.loc.gov/standards/mods/v3/mods-3-3.xsd http://www.loc.gov/mods/v3

セットの種類

分類 setSpec 内容
データ種別毎のセット
alis_serial 書誌データ(雑誌)
alis_book 書誌データ(図書)
jasi JASI論文データ
本文が日本語で記述された農学学術論文
agris AGRIS論文データ
本文が英語で記述された農学学術論文
agrolib AGROLib論文データ
一般雑誌記事を含む論文データ
repository 研究者個人向け論文データ
seika 研究成果情報
hinshu 画像情報(品種)
afftool 画像情報(農機具)
全文情報を持つ論文データのセット fulltext 全文情報を持つ論文データ
国立情報学研究所の定める資源タイプ(NIItype)毎のセット
nii_1 学術雑誌論文(Journal Article)
nii_2 学位論文(Thesis or Dissertation)
nii_3 紀要論文(Departmental Bulletin Paper)
nii_4 会議発表論文(Conference Paper)
nii_5 会議発表用資料(Presentation)
nii_6 図書(Book)
nii_7 テクニカルレポート(Technical Report)
nii_8 研究報告書(Research Paper)
nii_9 一般雑誌記事(Article)
nii_10 プレプリント(Preprint)
nii_11 教材(Learning Material)
nii_12 データ・データベース(Data or Dataset)
nii_13 ソフトウェア(Software)
nii_14 その他(Others)

データ種別毎の出力可能なフォーマット

データ種別 出力フォーマット
oai_dc junii2 AgMES MARC21 MODS dc_ndl
書誌データ × × ×
JASI論文データ × × ×
AGRIS論文データ × × ×
AGROLib論文データ × × × ×
研究者個人向け論文データ × × ×
研究成果情報 × × × ×
画像情報 × × × × ×

リクエスト形式

http://agriknowledge.affrc.go.jp/oai-pmh/request?verb=[リクエストの種類]&[パラメータを指定]

リクエストの種類
リクエスト リクエスト内容
GetRecord 個別データを検索して取得する
Identify リポジトリに関する情報を取得する
ListIdentifiers メタデータのヘッダ部のみを取得する
ListMetadataFormats リポジトリがサポートするメタデータのフォーマット一覧を取得する
ListRecords メタデータのリストを取得する
ListSets リポジトリがサポートするセットの一覧を取得する
パラメータの種類
パラメータ 意味
identifier アイテムの固有識別子
metadataPrefix メタデータのフォーマット
from 日付スタンプによる選択的ハーベスティングの下限
until 日付スタンプによる選択的ハーベスティングの上限
set 選択的ハーベスティングの対象とするセット
resumptionToken フロー制御(連続したメタデータ取得)時に使用するトークン
リクエストとパラメータの関係
リクエスト パラメータ
identifier metadataPrefix from until set resumption
Token(※)
GetRecord - - - -
Identify - - - - - -
ListIdentifiers -
ListMetadataFormats - - - - -
ListRecords -
ListSets - - - - -

凡例:◎=必須、○=任意
resumptionTokenパラメータは他パラメータ(identifier、metadataPrefix、from、until、set)と排他指定。
本リポジトリでは、ListIdentifiers及びListRecords要求の際に、set及びfromパラメータを必須としています。

返戻件数

ListIdentifiers、ListRecords、ListSets要求において一度に返戻されるデータの件数は1000件です。 1001件目以降のデータを取得したい場合には、1000件を取得した際に通知されるresumptionTokenを指定してリクエストします。

固有識別子

固有識別子(identifier)はリポジトリ内のアイテムを一意に決定する識別子です。GetRecordおよび ListMetadataFormats要求で対象を指定するための引数として使用するほか、GetRecord、ListIdentifiers、 ListRecords要求では返戻データ中のheader要素に含まれます。本リポジトリの固有識別子の形式は以下のとおりです。

oai:affrc.go.jp
:[資源タイプ種別]_[データID]
資源タイプ種別
国立情報学研究所の定める資源タイプを示す2桁の整数
データID
:本リポジトリ固有の内部IDで、8桁の整数

例)oai:affrc.go.jp:01_00292668

要求例

GetRecord
http://agriknowledge.affrc.go.jp/oai-pmh/request?verb=GetRecord&identifier=oai:affrc.go.jp:01_00292668&metadataPrefix=oai_dc
Identify
http://agriknowledge.affrc.go.jp/oai-pmh/request?verb=Identify
ListIdentifiers
http://agriknowledge.affrc.go.jp/oai-pmh/request?verb=ListIdentifiers&metadataPrefix=oai_dc&set=jasi&from=2001-01-01
ListMetadataFormats
http://agriknowledge.affrc.go.jp/oai-pmh/request?verb=ListMetadataFormats
ListRecords
http://agriknowledge.affrc.go.jp/oai-pmh/request?verb=ListRecords&metadataPrefix=oai_dc&set=agrolib&from=2001-01-01T09:00:00Z
ListSets
http://agriknowledge.affrc.go.jp/oai-pmh/request?verb=ListSets