Revision 60409
Added by Claudio Atzori about 3 years ago
modules/dnet-api-http-doc/branches/auth-broker/broker.html | ||
---|---|---|
194 | 194 |
<div class="uk-container"> |
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 |
<h2>Broker</h2> |
|
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. |
|
200 |
Enrichments are organised in topic types, for which the broker service enables repository managers to subscribe. The topic types are described in the tables below. |
|
197 |
<h2>Broker Service API</h2> |
|
201 | 198 |
|
202 |
A preview of the possible enrichments relative to <i>all</i> the repositories aggregated in OpenAIRE can be explored by repository managers on |
|
203 |
the <a href="https://provide.openaire.eu">content provider dashboard</a>, however, in order to get the full set of enrichments (beyond a preview), repository managers must |
|
204 |
subscribe to any of the available <i>topic types</i>. |
|
205 |
</p> |
|
199 |
<p><b>Introduction</b></p> |
|
200 |
<p> |
|
201 |
The Broker Service is available to use via the OpenAIRE Content Provider Dashboard. Thanks to the Broker, repositories, |
|
202 |
publishers or aggregators can exchange metadata and enrich their local metadata collection by subscribing to notifications of different types. |
|
203 |
The Broker is able to notify providers when the OpenAIRE Graph contains information that is not available in the original collection of the data source. |
|
204 |
In particular, the data source manager can subscribe via the <a href="https://provide.openaire.eu">Content Provider Dashboard</a> and be notified about: |
|
205 |
<ul> |
|
206 |
<li>Additional PIDs of its publications (e.g. DOIs)</li> |
|
207 |
<li>Links to projects</li> |
|
208 |
<li>ORCID that can be associated to an author of datasource publications</li> |
|
209 |
<li>Links to Open Access versions</li> |
|
210 |
<li>Additional classification subjects (e.g. subjects from standard schemes like ACM, JEL and DDC)</li> |
|
211 |
<li>Links to datasets</li> |
|
212 |
<li>Missing publication dates</li> |
|
213 |
</ul> |
|
206 | 214 |
|
207 |
<table class="uk-table uk-table-striped uk-table-middle"> |
|
208 |
<thead><tr><th>Additional metadata information that may enrich or supplement a repository content</th></tr></thead> |
|
209 |
<tbody><!----> |
|
210 |
<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> |
|
211 |
<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> |
|
212 |
<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 |
|
213 |
<p>- Dewey Decimal (DDC)</p> |
|
214 |
<p>- Journal of Economic Literature (JEL)</p> |
|
215 |
<p>- Medical Subject Headings (MeSH)</p> |
|
216 |
<p>- Association for Computing Machinery (ACM)</p> |
|
217 |
<p>- ARXIV classification terms</p> |
|
218 |
</div></td></tr> |
|
219 |
</tbody> |
|
220 |
</table> |
|
215 |
All Repository managers approaching the Content Provider Dashboard will be offered the possibility to preview a set of enrichments relative to their repository that OpenAIRE can derive from the Graph. |
|
216 |
More specifically, enrichments will be organized into categories named topics and representing the different types of enrichments OpenAIRE can build. For each topic the preview consists of 100 “enrichment events”, |
|
217 |
a subset of all the possible enrichments pertinent to a given repository in the OpenAIRE Graph, that the user can explore by applying filters on different criteria and the total number of events that can be potentially built is highlighted in the UI. |
|
218 |
Repository managers can create subscriptions for specific topics and that include the filtering criteria they used to analyze the enrichments preview, or can subscribe to all the available topics with no restrictions at once. |
|
219 |
Once the repository manager creates a subscription, the algorithm analyzing the OpenAIRE Graph will produce the full set of enrichments for the manager's repository, possibly far beyond the 100 enrichments available in the preview. |
|
220 |
The enrichments will be made available as notifications in a dedicated section in the Content Provider Dashboard UI to be further checked as well as through the broker service API for programmatic access. |
|
221 |
Notifications will be sent to subscribers every time the OpenAIRE Graph will be updated and analyzed to derive the enrichments. |
|
222 |
|
|
223 |
<p><b>Usage example</b></p> |
|
221 | 224 |
|
222 |
|
|
223 |
<table class="uk-table uk-table-striped uk-table-middle"> |
|
224 |
<thead><tr><th>Missing metadata information that may enrich or complete a repository content</th></tr></thead> |
|
225 |
<tbody><!----> |
|
226 |
<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> |
|
227 |
<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> |
|
228 |
<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> |
|
229 |
<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> |
|
230 |
|
|
231 |
<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> |
|
232 |
<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> |
|
233 |
<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 |
|
234 |
<p>- Dewey Decimal (DDC)</p> |
|
235 |
<p>- Journal of Economic Literature (JEL)</p> |
|
236 |
<p>- Medical Subject Headings (MeSH)</p> |
|
237 |
<p>- Association for Computing Machinery (ACM)</p> |
|
238 |
<p>- ARXIV classification terms</p> |
|
239 |
</div></td></tr> |
|
240 |
</tbody> |
|
241 |
</table> |
|
242 |
|
|
243 | 225 |
<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> |
244 | 226 |
|
245 | 227 |
<ol> |
Also available in: Unified diff
WIP: broker API documentation