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
This commit is contained in:
parent
56a1e0eadf
commit
9fec7a125e
35
api.html
35
api.html
|
|
@ -155,27 +155,44 @@
|
|||
</div>
|
||||
|
||||
<p>
|
||||
The OpenAIRE HTTP API allows developers to access the metadata information space of OpenAIRE+ by performing queries over publications, datasets, and projects.
|
||||
The OpenAIRE HTTP API allows developers to access the metadata information space of OpenAIRE by performing queries over publications, datasets, and projects.
|
||||
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 to
|
||||
the whole information space: the number of total results returned by one query is limited to 10,000. For accessing the whole information space, developers are
|
||||
encouraged to use the <a href="http://api.openaire.eu/#cha_oai_pmh" target="_blank">OAI-PMH</a>.<br>
|
||||
</p>
|
||||
<p>
|
||||
API rate limits:
|
||||
|
||||
<div>
|
||||
<h4>TERMS OF USE AND SLA</h4>
|
||||
<p><strong>OpenAIRE HTTP API</strong>: the APIs are free-to-use (no sign-up needed) by any third-party service. Note that:</p>
|
||||
<ul>
|
||||
<li>no more then 37 concurrent request in total (max 30 per single IP)</li>
|
||||
<li>no more than 15 requests/second (in total, not per IP. If this limit is reached, requests will be delayed).</li>
|
||||
<li>The HTTP API limits each query to 10,000 paged results; for unlimited access to the APIs please contact <a href="mailto:paolo.manghi@isti.cnr.it">the service administrators</a>.
|
||||
</li>
|
||||
<li>Since 2015 an <a href="https://zenodo.org/record/51077#.WsdCFdNubOR">RDF dump of the LOD is made available in Zenodo.org</a></li>
|
||||
</ul>
|
||||
</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>
|
||||
<li>no more then 37 concurrent request in total (max 30 per single IP) to the HTTP API for selective access</li>
|
||||
<li>no more than 15 requests/second to the HTTP API for selective access (in total, not per IP. If this limit is reached, requests will be delayed).</li>
|
||||
</ul>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
<h2 id="common">Common Parameters</h2>
|
||||
|
||||
<p> Parameters included in this section can always be specified, regardless the type of <strong>entities</strong> (metadata about <strong>publications</strong>,
|
||||
<strong>datasets</strong>, or <strong>projects</strong>) you want to retrieve. <br>
|
||||
<strong>datasets</strong>, or <strong>projects</strong>) you want to retrieve. <br>
|
||||
To query for publications metadata: <strong>http://api.openaire.eu/search/publications</strong> <br>
|
||||
To query for datasets metadata: <strong>http://api.openaire.eu/search/datasets</strong> <br>
|
||||
To query for projects metadata: <strong>http://api.openaire.eu/search/projects</strong> <br>
|
||||
</p>
|
||||
|
||||
<h2 id="common">Common Parameters</h2>
|
||||
|
||||
<table class="uk-table uk-table-striped uk-table-hover uk-table-small">
|
||||
<thead>
|
||||
<tr>
|
||||
|
|
|
|||
|
|
@ -169,6 +169,20 @@
|
|||
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>
|
||||
<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>
|
||||
<!-- Content GOES HERE-->
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
14
oai-pmh.html
14
oai-pmh.html
|
|
@ -162,6 +162,20 @@
|
|||
Publications are avaialble in <code>oai_dc</code> according to the <strong>OpenAIRE3.0 guidelines</strong> for literature repositories. <br>
|
||||
Datasets are available in <code>oai_datacite</code> according to the <strong>OpenAIRE2.0 guidelines</strong> for data archives. <br>
|
||||
</p>
|
||||
<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>
|
||||
<!-- Content GOES HERE-->
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Reference in New Issue