APIの利用方法
AgriKnowledgeのWebAPIをご利用いただくにあたり、事前に以下の点をお読みいただいたうえで、利用条件を遵守していただきます。
AgriKnowledgeで提供するAPI
OpenSearch
AgriKnowledgeで公開しているデータを検索するサービスです。APIによる検索対象範囲は、プロトコルによって異なります。 機能の詳細につきましては、こちらをご覧ください。
OAI-PMH
AgriKnowledgeで公開しているデータを、一括または１つを指定してXMLで取得できるウェブサービスです。 機能の詳細につきましては、こちらをご覧ください。
利用条件
- 非営利目的での利用のみ可能（営利目的の利用は不可）
- 公的・私的サービスでの利用、個人・団体の別は問いません。
利用のための手続き
OAI-PMHの利用に際しては、お問い合わせより連絡先を確認後、ご利用内容等を入力のうえ、お申し込みください。 お申し込み後、担当者よりご連絡し、設定など詳細について調整させていただきます。
なお、いただきました情報は、API仕様変更時の連絡やAPI利用実態把握等に活用させていただきます。
提供するデータについて
- 本サイトから提供するデータの範囲は、AgriKnowledge上のデータのうち以下を満たすものです。
- 公開の許諾が得られているもの
- 全文データがPDFファイルとして公開されているもの
注意事項
大量アクセスに関するご注意
サーバへの過負荷を避けるため、同時リクエスト数には制限を設けています。 また、特定のサーバから継続して大量のアクセスがある場合は、アクセスを遮断する等の措置を行う場合があります。
クレジットの表示
本APIを利用するサイトやアプリケーションには、AgriKnowledgeのAPIを用いていることを明記してください。 また、個々のデータを表示する際は、データ提供元機関等の名称を明記してください。
免責事項
「著作権・免責事項等」をご覧ください。
OpenSearch
概要
AgriKnowledgeで公開しているデータを、他のサイトから自由に利用できるウェブサービスです。 OpenSearchのクエリを作成し、AgriKnowledgeにリクエストすることで、AgriKnowledgeの画面での検索と同等の検索を行うことができます。 基本的な仕様は以下のページを参照ください。
Open Search 仕様書 1.1 ドラフト4版 https://sites.google.com/site/tsukamoto/doc/opensearch/spec-1-1-draft4
リクエスト形式
https://agriknowledge.affrc.go.jp/api/opensearch?[パラメータ=値]&[パラメータ=値]…&[パラメータ=値]
引数の形式
参照名 | 内容 | 一致条件 | 複数指定 | 備考 |
|---|---|---|---|---|
q | 全ての項目 | 部分一致 | ○ | - |
title | タイトル | 部分一致 | ○ | - |
author | 作成者（著者） | 部分一致 | ○ | - |
publisher | 発行元 | 完全一致 | ○ | - |
niitype | 分類［NIItype］ | - | × | - |
issn | ISSN | 前方一致 | × | - |
gpid | データプロバイダグループID | 完全一致 | × | 指定可能な値は次表のとおり |
pid | データプロバイダ | 完全一致 | ○ | 指定可能な値は次表のとおり |
from | 日付での絞り込み（下限） | - | × | YYYY-MM-DD |
until | 日付での絞り込み（上限） | - | × | YYYY-MM-DD |
cnt | 出力数の上限 | - | × | デフォルト:100 |
index | 出力の開始位置 | - | × | デフォルト:1 |
format | 出力フォーマット | - | × | atom/rss/html |
データプロバイダグループID（gpid）、データプロバイダ（pid）の指定可能な値
データ種別 | データプロバイダグループID（gpid） | データプロバイダ（pid） | 内容 |
|---|---|---|---|
論文データ | article | 201 | 本文が日本語で記述された農学学術論文 |
203 | 一般雑誌記事を含む論文データ | ||
画像情報 | image | ||
402 | 農業機械、器具 |
要求例
OAI-PMH
概要
AgriKnowledgeで公開しているデータを、一括または１つを指定してXMLで取得できるウェブサービスです。 OAI-PMHは、OAI（Open Archives Initiative）によって開発が進められているメタデータ交換のためのプロトコルです。 基本的な仕様は以下のページを参照ください。
国立情報学研究所によるOAI-PMH2.0日本語訳 https://www.nii.ac.jp/irp/archive/translation/oai-pmh2.0/
リポジトリの基本情報
項目名 | 内容 | 返戻値 |
|---|---|---|
repositoryName | リポジトリの名称 | AgriKnowledge |
baseURL | リポジトリのベースURL | |
protocolVersion | サポートしているOAI-PMH バージョン | 2.0 |
adminEmail | リポジトリ管理者の電子メールアドレス | |
earliestDatestamp | 日付スタンプの保証下限 | 1970-01-01T00:00:00Z |
deletedRecord | 削除ポリシー | transient |
granularity | 最も細かいデータ収集単位 | YYYY-MM-DDThh:mm:ssZ |
compression | 圧縮コード化のサポート | gzip, deflate |
メタデータ形式
metadataPrefix | スキーマ名及び参照先 |
|---|---|
junii2 | |
oai_dc | |
jpcoar_2.0 |
セットの種類
分類 | setSpec | 内容 |
|---|---|---|
データ種別毎のセット | ||
jasi | JASI論文データ | |
agrolib | AGROLib論文データ | |
afftool | 画像情報（農機具） | |
全文情報を持つ論文データのセット | ||
fulltext | 全文情報を持つ論文（JASI、AGROLib）データ | |
jasi_fulltext | 全文情報を持つ論文（JASI）データ | |
国立情報学研究所の定める資源タイプ（NIItype）毎のセット | ||
nii_1 | 学術雑誌論文（Journal Article） | |
nii_7 | テクニカルレポート（Technical Report） | |
nii_8 | 研究報告書（Research Paper） |
データ種別毎の出力可能なフォーマット
データ種別 | 出力フォーマット | ||||||
|---|---|---|---|---|---|---|---|
oai_dc | junii2 | jpcoar_2.0 | |||||
JASI論文データ | ○ | ○ | ○ | ||||
AGROLib論文データ | ○ | ○ | ○ | ||||
農機具 | ○ | × | × | ||||
リクエスト形式
https://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 | |
GetRecord | ◎ | ◎ | - | - | - | - |
Identify | - | - | - | - | - | - |
ListIdentifiers | - | ◎ | ◎ | ○ | ◎ | ○ |
ListMetadataFormats | ○ | - | - | - | - | - |
ListRecords | - | ◎ | ◎ | ○ | ◎ | ○ |
ListSets | - | - | - | - | - | ○ |
凡例：◎＝必須、○＝任意
resumptionTokenパラメータは他パラメータ(identifier、metadataPrefix、from、until、set)と排他指定。
本リポジトリでは、ListIdentifiers及びListRecords要求の際に、set及びfromパラメータを必須としています。
返戻件数
ListIdentifiers、ListRecords、ListSets要求において一度に返戻されるデータの件数は500件です。 501件目以降のデータを取得したい場合には、500件を取得した際に通知されるresumptionTokenを指定してリクエストします。
固有識別子
固有識別子(identifier)はリポジトリ内のアイテムを一意に決定する識別子です。GetRecordおよび ListMetadataFormats要求で対象を指定するための引数として使用するほか、GetRecord、ListIdentifiers、 ListRecords要求では返戻データ中のheader要素に含まれます。本リポジトリの固有識別子の形式は以下のとおりです。
oai:affrc.go.jp
：[資源タイプ種別]_[データID]
資源タイプ種別
：国立情報学研究所の定める資源タイプを示す2桁の整数
データID
：本リポジトリ固有の内部IDで、8桁の整数
例）oai:affrc.go.jp:01_00292668
要求例
GetRecord
https://agriknowledge.affrc.go.jp/oai-pmh/request?verb=GetRecord&identi…
Identify
https://agriknowledge.affrc.go.jp/oai-pmh/request?verb=Identify
ListIdentifiers
https://agriknowledge.affrc.go.jp/oai-pmh/request?verb=ListIdentifiers&…
ListMetadataFormats
https://agriknowledge.affrc.go.jp/oai-pmh/request?verb=ListMetadataForm…
ListRecords
https://agriknowledge.affrc.go.jp/oai-pmh/request?verb=ListRecords&meta…
ListSets
https://agriknowledge.affrc.go.jp/oai-pmh/request?verb=ListSets
