OpenAIRE
/
openaire-api-http-doc
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
openaire-api-http-doc/bulk-projects.html

223 lines
14 KiB
HTML
Raw Normal View History

Added HTML files for api documentation based on uikit git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet45/modules/dnet-api-http-doc/src@49344 d315682c-612b-4755-9ff5-7f18f6832af3
2017-10-09 12:43:56 +02:00
<!DOCTYPE html>
<html lang="en-gb">
<head>
<!--link href="http://demo.openaire.eu" rel="canonical" /-->
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="description" content="open access, research, scientific publication, European Commission, EC, FP7, ERC, Horizon 2020, H2020, search, projects "/>
<link href="./assets/favicon.ico" rel="shortcut icon" />
<title>OpenAIRE API Documentation - Bulk access to projects</title>
<script src="./assets/jquery.js"></script>
<script src="./assets/uikit.js"></script>
<script src="./assets/uikit-icon-max.js"></script>
<link rel="stylesheet" type="text/css" href="./assets/theme.css">
<link rel="stylesheet" type="text/css" href="./assets/custom.css">
<link rel="stylesheet" type="text/css" href="./assets/custom.css.1">
</head>
<body class="" style="">
<div class="uk-offcanvas-content uk-height-viewport">
<!-- MENU STARTS HERE-->
<!-- MAIN MENU STARTS HERE-->
<div class="tm-header-mobile uk-hidden@m">
<div animation="uk-animation-slide-top" class="uk-navbar-container uk-sticky uk-navbar-transparent uk-light" cls-active="uk-active uk-navbar-sticky" cls-inactive="uk-navbar-transparent uk-light" uk-sticky="">
<nav class="uk-navbar-container uk-navbar" uk-navbar="">
<div class="uk-navbar-left">
<a class="uk-navbar-toggle" href="#tm-mobile" uk-toggle="" style="z-index:1000;">
<div uk-navbar-toggle-icon="" class="uk-navbar-toggle-icon uk-icon custom-navbar-toggle-icon"> </div>
</a>
</div>
<div class="uk-navbar-center uk-margin-left">
<img src="./assets/apple-icon-72x72.png" alt="OpenAIRE" class="uk-responsive-height">
<a class="uk-navbar-item uk-logo uk-padding-remove-left uk-visible@m" routerLinkActive="uk-link" routerLink="/" >
OpenAIRE API Documentation</a>
<a class="uk-navbar-item uk-logo uk-padding-remove-left uk-hidden@m" routerLinkActive="uk-link" routerLink="/" >
API Documentation</a>
</div>
</nav>
<div id="tm-mobile" uk-offcanvas="" mode="slide" overlay="" class="uk-offcanvas">
<div class="uk-offcanvas-bar">
<button class="uk-offcanvas-close uk-close uk-icon" type="button" uk-close=""></button>
<div class="uk-child-width-1-1 uk-grid" uk-grid="">
<div>
<div class="uk-panel" id="module-0">
<ul class="uk-nav uk-nav-default">
<li class="uk-nav-header uk-parent">
<a href="./overview.html"> Overview </a>
</li>
<li class="uk-nav-header uk-parent">
Bulk access
<ul class="uk-nav-sub">
<li><a routerLinkActive="uk-link" href="./oai-pmh.html" >OAI-PMH</a></li>
<li class="uk-active"><a routerLinkActive="uk-link" href="#" >Bulk access to projects</a></li>
</ul>
</li>
<li class="uk-nav-header uk-parent">
<a href="./api.html">Selective access</a>
<ul class="uk-nav-sub">
<li><a href="./api.html#pubs" >Publications</a></li>
<li><a href="./api.html#datasets" >Research Data</a></li>
<li><a href="./api.html#projects" >Projects</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="tm-header uk-visible@m tm-header-transparent" uk-header=""><!-- top=".tm-header" + [class*=&quot;uk-section&quot;] -->
<div animation="uk-animation-slide-top" class="uk-navbar-container uk-sticky uk-navbar-transparent uk-light" cls-active="uk-active uk-navbar-sticky" cls-inactive="uk-navbar-transparent uk-light" media="768" uk-sticky="">
<div class="uk-container uk-container-expand">
<nav class="uk-navbar" uk-navbar="{&quot;align&quot;:&quot;left&quot;}" style="background-color:white !important;">
<div class="uk-navbar-center">
<div class="uk-logo uk-navbar-item uk-margin-small-top">
<img alt="OpenAIRE" class="uk-responsive-height" src="./assets/Logo_Horizontal.png">
</div>
<div class="uk-logo uk-navbar-item uk-margin-medium-top">
<h3 style="color: #767779 !important;"> API Documentation </h3>
</div>
</div>
<div class="uk-navbar-right">
<ul class="uk-navbar-nav uk-margin-small-top">
<li>
<a href="./overview.html"><span class="uk-icon" uk-icon="icon: home"><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 20 20" ratio="1"> <polygon points="18.65 11.35 10 2.71 1.35 11.35 0.65 10.65 10 1.29 19.35 10.65"></polygon> <polygon points="15 4 18 4 18 7 17 7 17 5 15 5"></polygon> <polygon points="3 11 4 11 4 18 7 18 7 12 12 12 12 18 16 18 16 11 17 11 17 19 11 19 11 13 8 13 8 19 3 19"></polygon></svg></span></a>
</li>
<li>
<a href="#">Bulk access</a>
<div class="uk-navbar-dropdown">
<ul class="uk-nav uk-navbar-dropdown-nav">
<li><a href="./oai-pmh.html">OAI-PMH</a></li>
<li class="uk-active"><a href="#">Bulk access to projects</a></li>
</ul>
</div>
</li>
<li>
<a href="./api.html">Selective access</a>
<div class="uk-navbar-dropdown">
<ul class="uk-nav uk-navbar-dropdown-nav">
<li><a href="./api.html#pubs">Publications</a></li>
<li><a href="./api.html#datasets">Datasets</a></li>
<li><a href="./api.html#projects">Projects</a></li>
</ul>
</div>
</li>
</ul>
</div>
</nav>
</div>
</div>
</div>
<!-- MENU ENDS HERE-->
<div class="first_page_section uk-section-default uk-section uk-padding-remove-vertical">
<div class="first_page_banner_headline uk-grid-collapse uk-flex-middle uk-margin-remove-vertical uk-grid" uk-grid="">
</div>
</div>
<div class=" uk-section uk-margin-large-top tm-middle custom-main-content" id="tm-main">
<div class="uk-container">
<div uk-grid="" class="uk-grid uk-grid-stack">
<div class="tm-main uk-width-1-1@s uk-width-1-1@m uk-width-1-1@l uk-row-first uk-first-column">
PRIVATE: updating the upgrade message with e-mail to heldesk git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet45/modules/dnet-api-http-doc/src@53037 d315682c-612b-4755-9ff5-7f18f6832af3
2018-09-10 11:30:58 +02:00
<div class="uk-alert-danger uk-text-center" uk-alert>
PRIVATE: add the message for the upgrade git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet45/modules/dnet-api-http-doc/src@53024 d315682c-612b-4755-9ff5-7f18f6832af3
2018-09-05 14:22:23 +02:00
<p>
PRIVATE: updating the upgrade message with e-mail to heldesk git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet45/modules/dnet-api-http-doc/src@53037 d315682c-612b-4755-9ff5-7f18f6832af3
2018-09-10 11:30:58 +02:00
OpenAIRE is about to release its new face with lots of news and services. <br>
During September, you may notice downtime in services, while some functionalities (e.g. user registration, validation, claiming) will be temporarily disabled.
We apologize for the inconvenience, please stay tuned! <br>
For further information please contact <a href="mailto:helpdesk@openaire.eu">helpdesk@openaire.eu</a>.
PRIVATE: add the message for the upgrade git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet45/modules/dnet-api-http-doc/src@53024 d315682c-612b-4755-9ff5-7f18f6832af3
2018-09-05 14:22:23 +02:00
</p>
</div>
Adding warning for schema change git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet45/modules/dnet-api-http-doc/src@50282 d315682c-612b-4755-9ff5-7f18f6832af3
2018-01-11 14:48:19 +01:00
<div class="uk-alert-danger" uk-alert>
removed authorOpenaireId parameter + change the message to say the schema is already changed git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet45/modules/dnet-api-http-doc/src@50490 d315682c-612b-4755-9ff5-7f18f6832af3
2018-01-30 11:29:03 +01:00
<p>Openaire XML Schema has been changed! Please <a href="https://www.openaire.eu/openaire-xml-schema-change-announcement" target="_blank">click here</a> to learn more!</p>
Adding warning for schema change git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet45/modules/dnet-api-http-doc/src@50282 d315682c-612b-4755-9ff5-7f18f6832af3
2018-01-11 14:48:19 +01:00
</div>
<h2>Bulk access to projects</h2>
Added HTML files for api documentation based on uikit git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet45/modules/dnet-api-http-doc/src@49344 d315682c-612b-4755-9ff5-7f18f6832af3
2017-10-09 12:43:56 +02:00
<p>
The APIs offer custom access to metadata about projects funded by a selection of international funders for the <strong>DSpace</strong> and <strong>EPrints</strong> platforms.
The currently supported funding streams and relative codes are: <br>
<ul>
<li><strong>FP7:</strong> The 7th Framework Programme funded by the European Commission</li>
<li><strong>WT:</strong> Wellcome Trust funding programme</li>
<li><strong>H2020:</strong> Horizon2020 Programme funded by the European Commission</li>
<li><strong>FCT:</strong> The funding programme of Fundação para a Ciência e a Tecnologia, the national funding agency of Portugal</li>
<li><strong>ARC:</strong> the funding programme of the Australian Research Council</li>
<li><strong>NHMRC:</strong> the funding programme of the Australian National Health and Medical Research Council</li>
<li><strong>SFI:</strong> Science Foundation Ireland</li>
<li><strong>HRZZ:</strong> Croatian Science Foundation</li>
<li><strong>MZOS:</strong> Ministry of Science, Education and Sports of the Republic of Croatia</li>
<li><strong>MESTD:</strong> The Ministry of Education, Science and Technological Development of Serbia </li>
<li><strong>NWO:</strong> The Netherlands Organisation for Scientific Research</li>
</ul>
</p>
<h4>DSpace/ePrints</h4>
<p> DSpace endpoint: <a href="http://api.openaire.eu/projects/dspace/$fundingStream/ALL/ALL" target="_blank">http://api.openaire.eu/projects/dspace/$fundingStream/ALL/ALL</a> <br>
ePrints endpoint: <a href="http://api.openaire.eu/projects/eprints/$fundingStream/ALL/ALL" target="_blank">http://api.openaire.eu/projects/eprints/$fundingStream/ALL/ALL</a>
</p>
<p>
The URLs embed the parameters needed to collect projects funded by specific funding stream, where the pattern is FundingStream/FundingSubStream/FundingSubSubStream.<br>
Additional parameters can be concatenated to the URL to refine the results by date (date must be in the form <code>YYYY-MM-DD</code>):
<ul>
<li>startFrom</li>
<li>startUntil</li>
<li>endFrom</li>
<li>endUntil</li>
</ul>
</p>
<h5>Examples</h5>
<p>
Get Wellcome Trust projects for EPrints: <a href="http://api.openaire.eu/projects/eprints/WT/ALL/ALL" target="_blank">http://api.openaire.eu/projects/eprints/WT/ALL/ALL</a> <br>
Get EC-FP7 projects of the specific programme “SP2-IDEAS” for EPrints: <a href="http://api.openaire.eu/projects/eprints/FP7/SP2/ALL" target="_blank">http://api.openaire.eu/projects/eprints/FP7/SP2/ALL</a> <br>
Get EC-FP7 projects for DSpace that started after the given date: <a href="http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01" target="_blank">http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01</a>. <br>
</p>
Added section on terms of services and SLA in the specific API pages git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet45/modules/dnet-api-http-doc/src@51726 d315682c-612b-4755-9ff5-7f18f6832af3
2018-04-09 11:20:24 +02:00
<div>
<h4>TERMS OF USE AND SLA</h4>
<p>APIs are free-to-use (no sign-up needed) by any third-party service</p>
<p><strong> Metadata license is CC-BY</strong>: the metadata records retuned by the service can be freely re-used by commercial and non-commercial partners under CC-BY license, hence as long as OpenAIRE is acknowledged as content provider.
</p>
<p><strong>Quality of Service</strong>: all API services are running in production 24/7 within the OpenAIRE infrastructure premises deployed at the <a href="http://icm.edu.pl/en/centre-of-technology/">data center</a> facilities of the <a href=http://icm.edu.pl/en/">Interdisciplinary Centre for Mathematical and Computational Modelling</a> (ICM).
</p>
<p><strong>APIs rate limits</strong>
<ul>
<li>no more than 30 concurrent connections from single IP to any APIs</li>
<li>no more than 67 concurrent requests in total</li>
</ul>
</p>
</div>
Added HTML files for api documentation based on uikit git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet45/modules/dnet-api-http-doc/src@49344 d315682c-612b-4755-9ff5-7f18f6832af3
2017-10-09 12:43:56 +02:00
<!-- Content GOES HERE-->
</div>
</div>
</div>
</div>
<!-- FOOTER STARTS HERE-->
<div class="custom-footer">
<div class="uk-section-primary uk-section uk-section-small">
<div class="uk-container">
<div class="uk-grid-margin uk-grid uk-grid-stack" uk-grid="">
<div class="uk-width-1-1@m uk-first-column">
<div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-center">
<img alt="OpenAIRE" class="el-image" src="./assets/Logo_Horizontal_white_small.png">
</div>
<div class="footer-license uk-margin uk-margin-remove-bottom uk-text-center uk-text-lead">
<div><a href="http://creativecommons.org/licenses/by/4.0/" rel="license"><img alt="Creative" src="./assets/80x15.png" style="height: auto; max-width: 100%; vertical-align: middle;"></a>&nbsp;UNLESS OTHERWISE INDICATED, ALL MATERIALS CREATED BY THE OPENAIRE CONSORTIUM ARE LICENSED UNDER A&nbsp;<a href="http://creativecommons.org/licenses/by/4.0/" rel="license">CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE</a>.</div>
<div>OPENAIRE IS POWERED BY&nbsp;<a href="http://www.d-net.research-infrastructures.eu/">D-NET</a>.</div>
</div>
<div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-right">
<a class="uk-totop uk-icon" href="#" uk-scroll="" uk-totop=""></a>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</body>
</html>