Revision 60407
Added by Claudio Atzori about 3 years ago
| modules/dnet-api-http-doc/branches/auth-broker/broker.html | ||
|---|---|---|
| 195 | 195 |
<div uk-grid="" class="uk-grid uk-grid-stack"> |
| 196 | 196 |
<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"> |
| 197 | 197 |
<h2>Broker</h2> |
| 198 |
<p> |
|
| 199 |
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.
|
|
| 200 |
The currently supported funding streams and relative codes are: <br>
|
|
| 198 |
<p>The Broker API is the main point of access for clients willing to programmatically integrate different type of enrichment that OpenAIRE,
|
|
| 199 |
thanks to its harmonization, deduplication, and TDM services can build for the bibliographic records it aggregates.</p>
|
|
| 200 |
<p>The types of enrichment are described in the following tables:</p>
|
|
| 201 | 201 |
|
| 202 |
<ul>
|
|
| 203 |
<li><strong>FP7:</strong> The 7th Framework Programme funded by the European Commission</li>
|
|
| 204 |
<li><strong>WT:</strong> Wellcome Trust funding programme</li>
|
|
| 205 |
<li><strong>H2020:</strong> Horizon2020 Programme funded by the European Commission</li>
|
|
| 206 |
<li><strong>FCT:</strong> The funding programme of Fundação para a Ciência e a Tecnologia, the national funding agency of Portugal</li>
|
|
| 207 |
<li><strong>ARC:</strong> the funding programme of the Australian Research Council</li>
|
|
| 208 |
<li><strong>NHMRC:</strong> the funding programme of the Australian National Health and Medical Research Council</li>
|
|
| 209 |
<li><strong>SFI:</strong> Science Foundation Ireland</li>
|
|
| 210 |
<li><strong>HRZZ:</strong> Croatian Science Foundation</li>
|
|
| 211 |
<li><strong>MZOS:</strong> Ministry of Science, Education and Sports of the Republic of Croatia</li>
|
|
| 212 |
<li><strong>MESTD:</strong> The Ministry of Education, Science and Technological Development of Serbia </li>
|
|
| 213 |
<li><strong>NWO:</strong> The Netherlands Organisation for Scientific Research</li>
|
|
| 214 |
</ul>
|
|
| 215 |
</p>
|
|
| 202 |
<table class="uk-table uk-table-striped uk-table-middle">
|
|
| 203 |
<thead><tr><th>Additional metadata information that may enrich or supplement a repository content</th></tr></thead>
|
|
| 204 |
<tbody><!---->
|
|
| 205 |
<tr class="el-item"><td class="uk-table-shrink uk-width-4-5">ENRICH/MORE/OPENACCESS_VERSION<!----><div class="uk-text uk-text-small">Another Open Access version of a publication</div></td></tr>
|
|
| 206 |
<tr class="el-item"><td class="uk-table-shrink uk-width-4-5">ENRICH/MORE/PID<!----><div class="uk-text uk-text-small">Another persistent identifier associated to your publications</div></td></tr>
|
|
| 207 |
<tr class="el-item"><td class="uk-table-shrink uk-width-4-5">ENRICH/MORE/SUBJECT/[DDC|JEL|MESHEUROPMC|ACM|ARXIV]<!----><div class="uk-text uk-text-small">Another classification term from the following taxonomies can be associated to your publications
|
|
| 208 |
<p>- Dewey Decimal (DDC)</p>
|
|
| 209 |
<p>- Journal of Economic Literature (JEL)</p>
|
|
| 210 |
<p>- Medical Subject Headings (MeSH)</p>
|
|
| 211 |
<p>- Association for Computing Machinery (ACM)</p>
|
|
| 212 |
<p>- ARXIV classification terms</p>
|
|
| 213 |
</div></td></tr>
|
|
| 214 |
</tbody>
|
|
| 215 |
</table>
|
|
| 216 | 216 |
|
| 217 |
<h4>DSpace/ePrints</h4> |
|
| 218 |
<!-- ATTENTION change back |
|
| 219 |
<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> |
|
| 220 |
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> |
|
| 221 |
</p> |
|
| 222 |
--> |
|
| 223 |
<p> DSpace endpoint: <a href="http://api-test.openaire.eu/projects/dspace/$fundingStream/ALL/ALL" target="_blank">http://api-test.openaire.eu/projects/dspace/$fundingStream/ALL/ALL</a> <br> |
|
| 224 |
ePrints endpoint: <a href="http://api-test.openaire.eu/projects/eprints/$fundingStream/ALL/ALL" target="_blank">http://api-test.openaire.eu/projects/eprints/$fundingStream/ALL/ALL</a> |
|
| 225 |
</p> |
|
| 226 | 217 |
|
| 227 |
<p> |
|
| 228 |
The URLs embed the parameters needed to collect projects funded by specific funding stream, where the pattern is FundingStream/FundingSubStream/FundingSubSubStream.<br> |
|
| 229 |
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>): |
|
| 230 |
<ul> |
|
| 231 |
<li>startFrom</li> |
|
| 232 |
<li>startUntil</li> |
|
| 233 |
<li>endFrom</li> |
|
| 234 |
<li>endUntil</li> |
|
| 235 |
</ul> |
|
| 236 |
</p> |
|
| 218 |
<table class="uk-table uk-table-striped uk-table-middle"> |
|
| 219 |
<thead><tr><th>Missing metadata information that may enrich or complete a repository content</th></tr></thead> |
|
| 220 |
<tbody><!----> |
|
| 221 |
<tr class="el-item"><td class="uk-table-shrink uk-width-4-5">ENRICH/MISSING/AUTHOR/ORCID<!----><div class="uk-text uk-text-small">An Open Researcher and Contributor ID (ORCID) that can be associated to an author of your publications</div></td></tr> |
|
| 222 |
<tr class="el-item"><td class="uk-table-shrink uk-width-4-5">ENRICH/MISSING/PID<!----><div class="uk-text uk-text-small">A persistent identifier associated to your publications</div></td>/tr> |
|
| 223 |
<tr class="el-item"><td class="uk-table-shrink uk-width-4-5">ENRICH/MISSING/PROJECT<!----><div class="uk-text uk-text-small">A project reference that can be associated to your publications</div></td></tr> |
|
| 224 |
<tr class="el-item"><td class="uk-table-shrink uk-width-4-5">ENRICH/MISSING/ABSTRACT<!----><div class="uk-text uk-text-small">An abstract describing among your publications</div></td></tr> |
|
| 237 | 225 |
|
| 238 |
<h5>Examples</h5> |
|
| 239 |
<!-- ATTENTION change back |
|
| 240 |
<p> |
|
| 241 |
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> |
|
| 242 |
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> |
|
| 243 |
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> |
|
| 244 |
</p> |
|
| 245 |
--> |
|
| 226 |
<tr class="el-item"><td class="uk-table-shrink uk-width-4-5">ENRICH/MISSING/PUBLICATION_DATE<!----><div class="uk-text uk-text-small">An abstract describing among your publications</div></td></tr> |
|
| 227 |
<tr class="el-item"><td class="uk-table-shrink uk-width-4-5">ENRICH/MISSING/OPENACCESS_VERSION<!----><div class="uk-text uk-text-small">An abstract describing among your publications</div></td></tr> |
|
| 228 |
<tr class="el-item"><td class="uk-table-shrink uk-width-4-5">ENRICH/MISSING/SUBJECT/[DDC|JEL|MESHEUROPMC|ACM|ARXIV]<!----><div class="uk-text uk-text-small">A classification term from the following taxonomies that can be associated to your publications |
|
| 229 |
<p>- Dewey Decimal (DDC)</p> |
|
| 230 |
<p>- Journal of Economic Literature (JEL)</p> |
|
| 231 |
<p>- Medical Subject Headings (MeSH)</p> |
|
| 232 |
<p>- Association for Computing Machinery (ACM)</p> |
|
| 233 |
<p>- ARXIV classification terms</p> |
|
| 234 |
</div></td></tr> |
|
| 235 |
</tbody> |
|
| 236 |
</table> |
|
| 246 | 237 |
|
| 247 |
<p> |
|
| 248 |
Get Wellcome Trust projects for EPrints: <a href="http://api-test.openaire.eu/projects/eprints/WT/ALL/ALL" target="_blank">http://api-test.openaire.eu/projects/eprints/WT/ALL/ALL</a> <br> |
|
| 249 |
Get EC-FP7 projects of the specific programme “SP2-IDEAS” for EPrints: <a href="http://api-test.openaire.eu/projects/eprints/FP7/SP2/ALL" target="_blank">http://api-test.openaire.eu/projects/eprints/FP7/SP2/ALL</a> <br> |
|
| 250 |
Get EC-FP7 projects for DSpace that started after the given date: <a href="http://api-test.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01" target="_blank">http://api-test.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01</a>. <br> |
|
| 251 |
</p> |
|
| 238 |
<p>The following commands indicates how the broker API documented at <a href="https://api.openaire.eu/broker/swagger-ui.html#/Openaire_Broker_Public_API">api.openaire.eu/broker</a> can be used to access the set of enrichments </p> |
|
| 239 |
|
|
| 240 |
<ol> |
|
| 241 |
<li>get the list of subscriptions for a given subscriber, e.g. |
|
| 242 |
<p><code>curl -X GET --header 'Accept: application/json' 'https://api.openaire.eu/broker/subscriptions?email=[subscriber_email]'</code></p> |
|
| 243 |
</li> |
|
| 244 |
<li>extract the subscription ID and use it to access the 1st page of enrichment notification records |
|
| 245 |
<p><code>curl -X GET --header 'Accept: application/json' 'https://api.openaire.eu/broker/scroll/notifications/bySubscriptionId/[sub-1234]'</code></p> |
|
| 246 |
</li> |
|
| 247 |
<li>extract the scroll ID from the response to request subsequent pages |
|
| 248 |
<p><code>curl -X GET --header 'Accept: application/json' 'https://api.openaire.eu/broker/scroll/notifications/[scroll_id]'</code></p> |
|
| 249 |
</li> |
|
| 250 |
</ol> |
|
| 251 |
|
|
| 252 |
|
|
| 252 | 253 |
<div> |
| 253 | 254 |
<h4>TERMS OF USE AND SLA</h4> |
| 254 | 255 |
<p>APIs are free-to-use (no sign-up needed) by any third-party service</p> |
Also available in: Unified diff
WIP: broker API documentation