Revision 28027
Added by Alessia Bardi over 10 years ago
| api-doc.html | ||
|---|---|---|
| 1 | 1 |
<html><head> |
| 2 | 2 |
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| 3 |
<title>OpenAIRE API documentation</title><link rel="stylesheet" type="text/css" href="openaire-api.css"><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book"><div class="titlepage"><div><div><h1 class="title"><a name="d0e1"></a>OpenAIRE API documentation</h1></div><div><p class="pubdate">29 April 2014</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="chapter"><a href="#d0e9">1. Overview</a></span></dt><dt><span class="chapter"><a href="#cha_oai_pmh">2. Bulk access via OAI-PMH</a></span></dt><dt><span class="chapter"><a href="#cha_projects_http">3. Bulk access to FP7 projects</a></span></dt><dt><span class="chapter"><a href="#cha_http-api">4. Selective access with HTTP API</a></span></dt><dd><dl><dt><span class="section"><a href="#sec_http-common">Common API parameters</a></span></dt><dt><span class="section"><a href="#sec_http-pubs">Publications</a></span></dt><dt><span class="section"><a href="#sec_http-datasets">Datasets</a></span></dt></dl></dd></dl></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="d0e9"></a>Chapter 1. Overview</h1></div></div></div><p>The OpenAIRE API allows developers to access the information space of OpenAIRE programmatically.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Bulk access:</p><table border="0" summary="Simple list" class="simplelist"><tr><td><a class="xref" href="#cha_oai_pmh" title="Chapter 2. Bulk access via OAI-PMH">OAI-PMH</a></td></tr><tr><td><a class="xref" href="#cha_projects_http" title="Chapter 3. Bulk access to FP7 projects">FP7 projects export</a></td></tr></table></li><li class="listitem"><p>Selective access via <a class="xref" href="#cha_http-api" title="Chapter 4. Selective access with HTTP API">HTTP Search API</a></p><table border="0" summary="Simple list" class="simplelist"><tr><td><a class="xref" href="#sec_http-pubs" title="Publications">Search HTTP API for publications</a></td></tr><tr><td><a class="xref" href="#sec_http-datasets" title="Datasets">Search HTTP API for datasets</a></td></tr><tr><td>HTTP API for projects [available soon] </td></tr></table></li></ul></div><p>The default format of delivered records is <code class="code">oaf</code> (OpenAire Format - current version 0.1):
|
|
| 3 |
<title>OpenAIRE API documentation</title><link rel="stylesheet" type="text/css" href="openaire-api.css"><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book"><div class="titlepage"><div><div><h1 class="title"><a name="d0e1"></a>OpenAIRE API documentation</h1></div><div><p class="pubdate">6 June 2014</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="chapter"><a href="#d0e9">1. Overview</a></span></dt><dt><span class="chapter"><a href="#cha_oai_pmh">2. Bulk access via OAI-PMH</a></span></dt><dt><span class="chapter"><a href="#cha_projects_http">3. Bulk access to FP7 projects</a></span></dt><dt><span class="chapter"><a href="#cha_http-api">4. Selective access with HTTP API</a></span></dt><dd><dl><dt><span class="section"><a href="#sec_http-common">Common API parameters</a></span></dt><dt><span class="section"><a href="#sec_http-pubs">Publications</a></span></dt><dt><span class="section"><a href="#sec_http-datasets">Datasets</a></span></dt></dl></dd></dl></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="d0e9"></a>Chapter 1. Overview</h1></div></div></div><p>The OpenAIRE API allows developers to access the information space of OpenAIRE programmatically.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Bulk access:</p><table border="0" summary="Simple list" class="simplelist"><tr><td><a class="xref" href="#cha_oai_pmh" title="Chapter 2. Bulk access via OAI-PMH">OAI-PMH</a></td></tr><tr><td><a class="xref" href="#cha_projects_http" title="Chapter 3. Bulk access to FP7 projects">FP7 projects export for DSpace and EPrints</a></td></tr></table></li><li class="listitem"><p>Selective access via <a class="xref" href="#cha_http-api" title="Chapter 4. Selective access with HTTP API">HTTP Search API</a></p><table border="0" summary="Simple list" class="simplelist"><tr><td><a class="xref" href="#sec_http-pubs" title="Publications">Search HTTP API for metadata about publications</a></td></tr><tr><td><a class="xref" href="#sec_http-datasets" title="Datasets">Search HTTP API for metadata about datasets</a></td></tr><tr><td>HTTP API for projects [available soon] </td></tr></table></li></ul></div><p>The default format of delivered records is <code class="code">oaf</code> (OpenAire Format - current version 0.1):
|
|
| 4 | 4 |
</p><table border="0" summary="Simple list" class="simplelist"><tr><td><a class="link" href="https://www.openaire.eu/schema/0.1/oaf-0.1.xsd" target="_top"><code class="code">oaf</code> XML schema v0.1</a></td></tr><tr><td><a class="link" href="https://www.openaire.eu/schema/0.1/doc/oaf-0.1.html" target="_top"><code class="code">oaf</code> XML schema v0.1 documentation</a></td></tr></table><p> |
| 5 | 5 |
</p></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="cha_oai_pmh"></a>Chapter 2. Bulk access via OAI-PMH</h1></div></div></div><p>OAI-PMH is a standard protocol for metadata publishing and harvesting. For details on the |
| 6 |
OAI-PMH protocol please refer to the official documentation at <a class="link" href="http://www.openarchives.org/OAI/openarchivesprotocol.html" target="_top">http://www.openarchives.org/OAI/openarchivesprotocol.html</a></p><p>The OpenAIRE OAI-PMH endpoint is <a class="link" href="http://api.openaire.eu/oai_pmh" target="_top">http://api.openaire.eu/oai_pmh</a></p><p>For information about the endpoint check <a class="link" href="http://api.openaire.eu/oai_pmh?verb=Identify" target="_top">http://api.openaire.eu/oai_pmh?verb=Identify</a></p><p>The updated list of OAI sets is always available at: <a class="link" href="http://api.openaire.eu/oai_pmh?verb=ListSets" target="_top">http://api.openaire.eu/oai_pmh?verb=ListSets</a></p><p>For quick reference, we report here the likely more interesting sets:</p><table border="0" summary="Simple list" class="simplelist"><tr><td>publications: the set of all publications</td></tr><tr><td>datasets: the set of all datasets</td></tr><tr><td>OpenAccess: the set of all Open Access publications and datasets</td></tr></table><p>For the list of available metadata prefix, check: <a class="link" href="http://api.openaire.eu/oai_pmh?verb=ListMetadataFormats" target="_top">http://api.openaire.eu/oai_pmh?verb=ListMetadataFormats</a>.</p><p>Note that records will always be available in the OpenAIRE format (<a class="link" href="https://www.openaire.eu/schema/0.1/oaf-0.1.xsd" target="_top">schema</a>, <a class="link" href="https://www.openaire.eu/schema/0.1/doc/oaf-0.1.html" target="_top">documentation</a>). </p><p>The availability of records in oai_dc depends on the typology of records. Currently |
|
| 6 |
OAI-PMH protocol please refer to the official documentation at <a class="link" href="http://www.openarchives.org/OAI/openarchivesprotocol.html" target="_top">http://www.openarchives.org/OAI/openarchivesprotocol.html</a></p><p>The OpenAIRE OAI-PMH endpoint is <a class="link" href="http://api.openaire.eu/oai_pmh" target="_top">http://api.openaire.eu/oai_pmh</a></p><p>For information about the endpoint check <a class="link" href="http://api.openaire.eu/oai_pmh?verb=Identify" target="_top">http://api.openaire.eu/oai_pmh?verb=Identify</a></p><p>The updated list of OAI sets is always available at: <a class="link" href="http://api.openaire.eu/oai_pmh?verb=ListSets" target="_top">http://api.openaire.eu/oai_pmh?verb=ListSets</a></p><p>For quick reference, we report here the likely more interesting sets:</p><table border="0" summary="Simple list" class="simplelist"><tr><td>publications: the set of all publications</td></tr><tr><td>datasets: the set of all datasets</td></tr><tr><td>OpenAccess: the set of all Open Access publications and datasets</td></tr><tr><td>projects: the set of all projects</td></tr><tr><td>FP7Projects: the set of projects funded by the EC Seventh Framework Programme</td></tr><tr><td>WTProjects: the set of projects funded by Wellcome Trust</td></tr></table><p>For the list of available metadata prefix, check: <a class="link" href="http://api.openaire.eu/oai_pmh?verb=ListMetadataFormats" target="_top">http://api.openaire.eu/oai_pmh?verb=ListMetadataFormats</a>.</p><p>Note that records will always be available in the OpenAIRE format (<a class="link" href="https://www.openaire.eu/schema/0.1/oaf-0.1.xsd" target="_top">schema</a>, <a class="link" href="https://www.openaire.eu/schema/0.1/doc/oaf-0.1.html" target="_top">documentation</a>). </p><p>The availability of records in oai_dc depends on the typology of records. Currently
|
|
| 7 | 7 |
publications and datasets (records of type 'result') are available in oai_dc.</p></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="cha_projects_http"></a>Chapter 3. Bulk access to FP7 projects</h1></div></div></div><p>The APIs offer custom access to EC projects information for the DSpace and EPrints platforms:</p><table border="0" summary="Simple list" class="simplelist"><tr><td>DSpace endpoint: <a class="link" href="http://api.openaire.eu/projects/dspace/FP7/ALL/ALL" target="_top">http://api.openaire.eu/projects/dspace/FP7/ALL/ALL</a></td></tr><tr><td>ePrints endpoint: <a class="link" href="http://api.openaire.eu/projects/eprints/FP7/ALL/ALL" target="_top">http://api.openaire.eu/projects/eprints/FP7/ALL/ALL</a></td></tr></table><p> The URLs embed the parameters needed to collect sub-portions of the EC projects, where the |
| 8 | 8 |
pattern is <code class="code">FP7/SpecificProgramme/ScientificArea</code>.</p><p>Additional parameters can be concatenated to the URL to refine the results by date (date |
| 9 |
must be in the form <code class="code">YYYY-MM-DD</code>): </p><table border="0" summary="Simple list" class="simplelist"><tr><td>startFrom</td></tr><tr><td>startUntil</td></tr><tr><td>endFrom</td></tr><tr><td>endUntil</td></tr></table><p>Examples: </p><table border="0" summary="Simple list" class="simplelist"><tr><td>Get projects of the specific programme “SP2-IDEAS” for Eprints: <a class="link" href="http://api.openaire.eu/projects/eprints/FP7/SP2/ALL" target="_top">http://api.openaire.eu/projects/eprints/FP7/SP2/ALL</a></td></tr><tr><td>Get FP7 projects for Dspace that started after the given date: <a class="link" href="http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01" target="_top">http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01</a></td></tr></table><p>
|
|
| 9 |
must be in the form <code class="code">YYYY-MM-DD</code>): </p><table border="0" summary="Simple list" class="simplelist"><tr><td>startFrom</td></tr><tr><td>startUntil</td></tr><tr><td>endFrom</td></tr><tr><td>endUntil</td></tr></table><p>Examples: </p><table border="0" summary="Simple list" class="simplelist"><tr><td>Get projects of the specific programme “SP2-IDEAS” for EPrints: <a class="link" href="http://api.openaire.eu/projects/eprints/FP7/SP2/ALL" target="_top">http://api.openaire.eu/projects/eprints/FP7/SP2/ALL</a></td></tr><tr><td>Get FP7 projects for DSpace that started after the given date: <a class="link" href="http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01" target="_top">http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01</a></td></tr></table><p>
|
|
| 10 | 10 |
</p></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="cha_http-api"></a>Chapter 4. Selective access with HTTP API</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#sec_http-common">Common API parameters</a></span></dt><dt><span class="section"><a href="#sec_http-pubs">Publications</a></span></dt><dt><span class="section"><a href="#sec_http-datasets">Datasets</a></span></dt></dl></div><p>The OpenAIRE+ HTTP API allows developers to access the information space of OpenAIRE+ by |
| 11 |
performing queries over publications, datasets, and projects.</p><p>The API is intended for discovery and exploration only, that is it does not provide access
|
|
| 12 |
to the whole informaton space, but the number of total results returned by one query is limited
|
|
| 11 |
performing queries over publications, datasets, and projects.</p><p>The API is intended for metadata discovery and exploration only, that is it does not give direct access to publication files and it does not provide access
|
|
| 12 |
to the whole information space: the number of total results returned by one query is limited
|
|
| 13 | 13 |
to 1000.</p><p>For accessing the whole information space, developers are encouraged to use the <a class="xref" href="#cha_oai_pmh" title="Chapter 2. Bulk access via OAI-PMH">OAI-PMH</a></p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sec_http-common"></a>Common API parameters</h2></div></div></div><p> Parameters included in this section can always be specified, regardless the type of |
| 14 |
entities (publications, datasets, or projects) you want to retrieve. </p><p>To query for publications: <code class="code">http://api.openaire.eu/search/publications</code></p><p>To query for datasets: <code class="code">http://api.openaire.eu/search/datasets</code></p><p>To query for projects: <code class="code">http://api.openaire.eu/search/projects</code></p><p>Katerina: add in the list below parameters for paging and other common parameters exposed by |
|
| 15 |
the API.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">hasECFunding</span></dt><dd><p>Allowed values: <code class="code">true|false</code>. If hasECFunding is true gets the publications/datasets/projects |
|
| 14 |
entities (metadata about publications, datasets, or projects) you want to retrieve. </p><p>To query for publications metadata: <code class="code">http://api.openaire.eu/search/publications</code></p><p>To query for datasets metadata: <code class="code">http://api.openaire.eu/search/datasets</code></p><p>To query for projects metadata: <code class="code">http://api.openaire.eu/search/projects</code></p><div class="variablelist"><dl class="variablelist"><dt><span class="term">hasECFunding</span></dt><dd><p>Allowed values: <code class="code">true|false</code>. If hasECFunding is true gets the publications/datasets/projects |
|
| 16 | 15 |
funded by the EC. If hasECFunding is false gets the publications/datasets/projects |
| 17 | 16 |
related to projects not funded by the EC. </p></dd><dt><span class="term">hasUKFunding</span></dt><dd><p>Allowed values: <code class="code">true|false</code>.If hasUKFunding is true gets the publications/datasets/projects |
| 18 | 17 |
funded by the UK. If hasUKFunding is false gets the publications/datasets/projects |
Also available in: Unified diff
#550: making it clear we are delivering metadata only. Clenaup.