Project

General

Profile

1
<!DOCTYPE html>
2
<html lang="en-gb">
3
	<head>
4
		<meta charset="utf-8">
5
		<meta http-equiv="X-UA-Compatible" content="IE=edge">
6
		<meta name="viewport" content="width=device-width, initial-scale=1">
7
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
8
		<meta name="description" content="OpenAIRE API Documentation - Broker Service API, OpenAIRE Content Provider Dashboard"/>
9
		<link href="assets/common-assets/logo-small-graph.png">
10
		<link rel="apple-touch-icon" sizes="57x57" href="assets/common-assets/logo/apple-icon-57x57.png">
11
		<link rel="apple-touch-icon" sizes="60x60" href="assets/common-assets/logo/apple-icon-60x60.png">
12
		<link rel="apple-touch-icon" sizes="72x72" href="assets/common-assets/logo/apple-icon-72x72.png">
13
		<link rel="apple-touch-icon" sizes="76x76" href="assets/common-assets/logo/apple-icon-76x76.png">
14
		<link rel="apple-touch-icon" sizes="114x114" href="assets/common-assets/logo/apple-icon-114x114.png">
15
		<link rel="apple-touch-icon" sizes="120x120" href="assets/common-assets/logo/apple-icon-120x120.png">
16
		<link rel="apple-touch-icon" sizes="144x144" href="assets/common-assets/logo/apple-icon-144x144.png">
17
		<link rel="apple-touch-icon" sizes="152x152" href="assets/common-assets/logo/apple-icon-152x152.png">
18
		<link rel="apple-touch-icon" sizes="180x180" href="assets/common-assets/logo/apple-icon-180x180.png">
19
		<link rel="icon" type="image/png" sizes="192x192" href="assets/common-assets/logo/android-icon-192x192.png">
20
		<link rel="icon" type="image/png" sizes="32x32" href="assets/common-assets/logo/favicon-32x32.png">
21
		<link rel="icon" type="image/png" sizes="96x96" href="assets/common-assets/logo/favicon-96x96.png">
22
		<link rel="icon" type="image/png" sizes="16x16" href="assets/common-assets/logo/favicon-16x16.png">
23
		<link href="assets/common-assets/logo/favicon.ico" rel="shortcut icon" type="image/vnd.microsoft.icon"/>
24
		<title>OpenAIRE API Documentation - Broker</title>
25
		<script  src="./assets/common-assets/jquery/jquery.js"></script>
26
		<script  src="./assets/uikit.js"></script>
27
		<script src="./assets/uikit-icon-max.js"></script>
28
		<!-- Include header and footer files -->
29
		<script>
30
			$(function(){
31
				$("#headerMobile").load("headerMobile.html");
32
				$("#header").load("header.html");
33
			});
34
		</script>
35
		<!-- Matomo -->
36
		<script type="text/javascript">
37
			var _paq = window._paq || [];
38
			/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
39
			_paq.push(['trackPageView']);
40
			_paq.push(['enableLinkTracking']);
41
			(function() {
42
			var u="//analytics.openaire.eu/";
43
			_paq.push(['setTrackerUrl', u+'matomo.php']);
44
			_paq.push(['setSiteId', '470']);
45
			var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
46
			g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
47
			})();
48
		</script>
49
		<link rel="stylesheet" type="text/css" href="./assets/common-assets/common/theme.css">
50
		<link rel="stylesheet" type="text/css" href="./assets/common-assets/common/custom.css">
51
		<link rel="stylesheet" type="text/css" href="./assets/common-assets/library.css">
52
		<link rel="stylesheet" type="text/css" href="./assets/develop-custom.css">
53
	</head>
54
	<body class="graphApp">
55
		<div class="uk-offcanvas-content uk-height-viewport">
56

    
57
			<!-- Header menu STARTS here-->
58
			<div id="headerMobile" class="tm-header-mobile uk-hidden@m"></div>
59
			<div id="header" class="tm-header uk-visible@m tm-header-transparent" uk-header=""></div>
60
			<!-- Header menu ENDS here-->
61

    
62
			<div class="first_page_section uk-section-default uk-section uk-padding-remove-vertical">
63
					<div class="first_page_banner_headline uk-grid-collapse uk-flex-middle uk-margin-remove-vertical uk-grid" uk-grid="">
64
					</div>
65
			</div>
66

    
67
			<!-- Page content STARTS here -->
68
				<div class="uk-section tm-middle custom-main-content" id="tm-main">
69
					<div class="uk-margin-large-left uk-margin-medium-bottom">
70
						<ul class="uk-breadcrumb">
71
							<li>
72
								<a href="/">Home</a>
73
							</li>
74
							<li>
75
								<a href="overview.html">API & Resources</a>
76
							</li>
77
							<li>
78
								<span>Broker Service API</span>
79
							</li>
80
						</ul>
81
					</div>
82
						<div class="uk-container">
83
							<div uk-grid="" class="uk-grid uk-grid-stack">
84
									<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">
85
								<h2 class="uk-text-center">Broker Service API</h2>
86

    
87
											<h4 class="portal-color">Introduction</h4>
88
											<p>
89
												The Broker Service is available to use via the OpenAIRE Content Provider Dashboard. Thanks to the Broker, repositories,
90
												publishers or aggregators can exchange metadata and enrich their local metadata collection by subscribing to notifications of different types.
91
												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.
92
												In particular, the data source manager can subscribe via the <a href="https://provide.openaire.eu">Content Provider Dashboard</a> and be notified about:
93
												<ul class="portal-circle">
94
														<li>Additional PIDs of its publications (e.g. DOIs)</li>
95
														<li>Links to projects</li>
96
														<li>ORCID that can be associated to an author of datasource publications</li>
97
														<li>Links to Open Access versions</li>
98
														<li>Additional classification subjects (e.g. subjects from standard schemes like ACM, JEL and DDC)</li>
99
														<li>Abstracts identified in duplicate publications</li>
100
														<li>Missing publication dates</li>
101
												</ul>
102

    
103
												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.
104
												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”,
105
												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.
106
												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.
107
												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.
108
												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.
109
												Notifications will be sent to subscribers every time the OpenAIRE Graph will be updated and analyzed to derive the enrichments.
110

    
111
											<h4 class="portal-color">Usage Example</h4>
112

    
113
										<p>The following commands indicates how the broker API documented at <a href="https://api.openaire.eu/broker/swagger-ui/index.html">api.openaire.eu/broker</a> can be used to access the set of enrichments </p>
114

    
115
											<ol>
116
													<li>get the list of subscriptions for a given subscriber, e.g.
117
															<p><code>curl -X GET --header 'Accept: application/json' 'https://api.openaire.eu/broker/subscriptions?email=[subscriber_email]'</code></p>
118
													</li>
119
													<li>extract the subscription ID and use it to access the 1st page of enrichment notification records
120
														<p><code>curl -X GET --header 'Accept: application/json' 'https://api.openaire.eu/broker/scroll/notifications/bySubscriptionId/[sub-1234]'</code></p>
121
													</li>
122
													<li>extract the scroll ID from the response to request subsequent pages
123
													<p><code>curl -X GET --header 'Accept: application/json' 'https://api.openaire.eu/broker/scroll/notifications/[scroll_id]'</code></p>
124
													</li>
125
											</ol>
126

    
127
											<p>To simplify accessing the enrichment notification records, please check the OpenAIRE broker cmdline client available on <a href="https://github.com/openaire/broker-cmdline-client">GitHub</a>.</p>
128

    
129
											<div>
130
													<h4 class="portal-color">TERMS OF USE AND SLA</h4>
131
													<p>APIs are free-to-use (no sign-up needed) by any third-party service</p>
132
													<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.
133
													</p>
134
													<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).
135
													</p>
136
													<p>
137
													<strong>APIs rate limits</strong>
138
													<p>Please check <a href="./authentication.html">here</a></p>
139
											</p>
140
													<!--p><strong>APIs rate limits</strong>
141
													<ul>
142
															<li>no more than 30 concurrent connections from single IP to any APIs</li>
143
															<li>no more than 67 concurrent requests in total</li>
144
													</ul>
145
													</p-->
146
											</div>
147
										<!-- Content GOES HERE-->
148
									</div>
149
							</div>
150
						</div>
151
				</div>
152
			<!-- Page content ENDS here -->
153

    
154
			<!-- Footer STARTS here -->
155
			<bottom class="footer">
156
				<div class="footer-light-background uk-padding-remove-bottom uk-section uk-section-small">
157
					<div class="uk-container uk-container-small">
158
						<div>
159
							<div id="footer#3" class="uk-first-column uk-flex uk-flex-middle uk-grid uk-margin-remove-right">
160
								<div class="uk-text-center uk-width-1-1 uk-width-1-4@m">
161
									<img width="126px" height="30px" alt="OpenAIRE" loading="lazy" class="el-image" src="assets/common-assets/common/Logo_Horizontal_dark_small.png">
162
								</div>
163
								<div id="footer#5" class="uk-margin uk-text-left uk-width-expand">
164
									<div class="uk-flex uk-flex-middle">
165
										<div>
166
											<img alt="flag black white low" width="50px" height="33px" loading="lazy" style="margin-right: 8px; float: left;" src="assets/common-assets/common/commission.jpg">
167
										</div>
168
										<div class="uk-margin-left">
169
											<div>
170
													<span style="font-size: 8pt; line-height: 0.7!important;">OpenAIRE has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreements No. 777541 and 101017452</span>
171
											</div>
172
										</div>
173
									</div>
174
								</div>
175
							</div>
176
							<div>
177
								<div class="uk-width-expand@m">
178
									<div id="footer#7" class="uk-text-right@m uk-text-center">
179
										<ul uk-margin="" class="uk-flex-center uk-margin-remove-bottom uk-subnav uk-subnav-divider"></ul>
180
									</div>
181
								</div>
182
							</div>
183
							<div class="uk-margin uk-text-center uk-width-1-1">
184
								<div uk-grid="" class="uk-child-width-auto uk-flex-center uk-grid uk-grid-small">
185
									<div class="uk-first-column">
186
										<a href="https://www.facebook.com/groups/openaire/" target="_blank" class="el-link uk-icon-button uk-icon">
187
											<svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
188
												<path d="M11,10h2.6l0.4-3H11V5.3c0-0.9,0.2-1.5,1.5-1.5H14V1.1c-0.3,0-1-0.1-2.1-0.1C9.6,1,8,2.4,8,5v2H5.5v3H8v8h3V10z"></path>
189
											</svg>
190
										</a>
191
									</div>
192
									<div>
193
										<a href="https://www.twitter.com/OpenAIRE_eu" target="_blank" class="el-link uk-icon-button uk-icon">
194
											<svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
195
												<path d="M19,4.74 C18.339,5.029 17.626,5.229 16.881,5.32 C17.644,4.86 18.227,4.139 18.503,3.28 C17.79,3.7 17.001,4.009 16.159,4.17 C15.485,3.45 14.526,3 13.464,3 C11.423,3 9.771,4.66 9.771,6.7 C9.771,6.99 9.804,7.269 9.868,7.539 C6.795,7.38 4.076,5.919 2.254,3.679 C1.936,4.219 1.754,4.86 1.754,5.539 C1.754,6.82 2.405,7.95 3.397,8.61 C2.79,8.589 2.22,8.429 1.723,8.149 L1.723,8.189 C1.723,9.978 2.997,11.478 4.686,11.82 C4.376,11.899 4.049,11.939 3.713,11.939 C3.475,11.939 3.245,11.919 3.018,11.88 C3.49,13.349 4.852,14.419 6.469,14.449 C5.205,15.429 3.612,16.019 1.882,16.019 C1.583,16.019 1.29,16.009 1,15.969 C2.635,17.019 4.576,17.629 6.662,17.629 C13.454,17.629 17.17,12 17.17,7.129 C17.17,6.969 17.166,6.809 17.157,6.649 C17.879,6.129 18.504,5.478 19,4.74"></path>
196
											</svg>
197
										</a>
198
									</div>
199
									<div>
200
										<a href="https://www.linkedin.com/groups/3893548/" target="_blank" class="el-link uk-icon-button uk-icon">
201
											<svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
202
												<path d="M5.77,17.89 L5.77,7.17 L2.21,7.17 L2.21,17.89 L5.77,17.89 L5.77,17.89 Z M3.99,5.71 C5.23,5.71 6.01,4.89 6.01,3.86 C5.99,2.8 5.24,2 4.02,2 C2.8,2 2,2.8 2,3.85 C2,4.88 2.77,5.7 3.97,5.7 L3.99,5.7 L3.99,5.71 L3.99,5.71 Z"></path>
203
												<path d="M7.75,17.89 L11.31,17.89 L11.31,11.9 C11.31,11.58 11.33,11.26 11.43,11.03 C11.69,10.39 12.27,9.73 13.26,9.73 C14.55,9.73 15.06,10.71 15.06,12.15 L15.06,17.89 L18.62,17.89 L18.62,11.74 C18.62,8.45 16.86,6.92 14.52,6.92 C12.6,6.92 11.75,7.99 11.28,8.73 L11.3,8.73 L11.3,7.17 L7.75,7.17 C7.79,8.17 7.75,17.89 7.75,17.89 L7.75,17.89 L7.75,17.89 Z"></path>
204
											</svg>
205
										</a>
206
									</div>
207
									<div>
208
										<a href="https://www.slideshare.net/OpenAIRE_eu" target="_blank" class="el-link uk-icon-button uk-icon">
209
											<svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
210
												<line fill="none" stroke="#000" stroke-width="1.1" x1="13.4" y1="14" x2="6.3" y2="10.7"></line>
211
												<line fill="none" stroke="#000" stroke-width="1.1" x1="13.5" y1="5.5" x2="6.5" y2="8.8"></line>
212
												<circle fill="none" stroke="#000" stroke-width="1.1" cx="15.5" cy="4.6" r="2.3"></circle>
213
												<circle fill="none" stroke="#000" stroke-width="1.1" cx="15.5" cy="14.8" r="2.3"></circle>
214
												<circle fill="none" stroke="#000" stroke-width="1.1" cx="4.5" cy="9.8" r="2.3"></circle>
215
											</svg>
216
										</a>
217
									</div>
218
									<div>
219
										<a href="https://www.youtube.com/channel/UChFYqizc-S6asNjQSoWuwjw" target="_blank" class="el-link uk-icon-button uk-icon">
220
											<svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
221
												<path d="M15,4.1c1,0.1,2.3,0,3,0.8c0.8,0.8,0.9,2.1,0.9,3.1C19,9.2,19,10.9,19,12c-0.1,1.1,0,2.4-0.5,3.4c-0.5,1.1-1.4,1.5-2.5,1.6 c-1.2,0.1-8.6,0.1-11,0c-1.1-0.1-2.4-0.1-3.2-1c-0.7-0.8-0.7-2-0.8-3C1,11.8,1,10.1,1,8.9c0-1.1,0-2.4,0.5-3.4C2,4.5,3,4.3,4.1,4.2 C5.3,4.1,12.6,4,15,4.1z M8,7.5v6l5.5-3L8,7.5z"></path>
222
											</svg>
223
										</a>
224
									</div>
225
									<div>
226
										<a target="_blank" href="https://www.openaire.eu/newsletter" class="el-link newsletter">
227
											<span class="el-title uk-margin uk-text-large"> Newsletter 
228
												<span class="el-image uk-icon">
229
													<svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
230
														<circle cx="3.12" cy="16.8" r="1.85"></circle>
231
														<path fill="none" stroke="#000" stroke-width="1.1" d="M1.5,8.2 C1.78,8.18 2.06,8.16 2.35,8.16 C7.57,8.16 11.81,12.37 11.81,17.57 C11.81,17.89 11.79,18.19 11.76,18.5"></path><path fill="none" stroke="#000" stroke-width="1.1" d="M1.5,2.52 C1.78,2.51 2.06,2.5 2.35,2.5 C10.72,2.5 17.5,9.24 17.5,17.57 C17.5,17.89 17.49,18.19 17.47,18.5"></path>
232
													</svg>
233
												</span>
234
											</span>
235
										</a>
236
									</div>
237
								</div>
238
							</div>
239
						</div>
240
					</div>
241
				</div>
242
				<div class="footer-light-background uk-section uk-section-xsmall">
243
					<div class="uk-container uk-container-expand">
244
						<div uk-grid="" class="uk-grid-margin uk-grid">
245
							<div class="uk-width-small@m uk-first-column"></div>
246
							<div class="uk-width-expand@m">
247
								<div id="footer#22" class="uk-text-small uk-margin uk-margin-remove-bottom uk-text-center@m uk-text-center">
248
									<a href="http://creativecommons.org/licenses/by/4.0/" rel="license" class="license"> &nbsp;
249
										<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24">
250
											<path id="creative-commons" d="M9.7,14.675a1.311,1.311,0,0,1-1.15-.557,2.511,2.511,0,0,1-.391-1.477q0-2.032,1.541-2.034a1.36,1.36,0,0,1,.666.205,1.569,1.569,0,0,1,.605.718l1.541-.8A3.222,3.222,0,0,0,9.457,9.067a3.249,3.249,0,0,0-2.412.964,3.548,3.548,0,0,0-.957,2.61,3.562,3.562,0,0,0,.945,2.63,3.362,3.362,0,0,0,2.485.942,3.367,3.367,0,0,0,1.766-.481,3.408,3.408,0,0,0,1.254-1.326l-1.419-.718a1.44,1.44,0,0,1-1.416.987Zm6.634,0a1.312,1.312,0,0,1-1.15-.557,2.511,2.511,0,0,1-.391-1.477q0-2.032,1.541-2.034a1.389,1.389,0,0,1,.686.205,1.577,1.577,0,0,1,.608.718l1.519-.8a3.181,3.181,0,0,0-3.04-1.663,3.253,3.253,0,0,0-2.412.964,3.546,3.546,0,0,0-.955,2.61,3.576,3.576,0,0,0,.934,2.63,3.349,3.349,0,0,0,2.5.942,3.328,3.328,0,0,0,1.745-.481,3.54,3.54,0,0,0,1.274-1.326l-1.438-.718a1.441,1.441,0,0,1-1.416.987ZM21.156,4.12A11.61,11.61,0,0,0,12.624.64a11.436,11.436,0,0,0-8.44,3.48A11.738,11.738,0,0,0,.641,12.64,11.537,11.537,0,0,0,4.185,21.1a11.532,11.532,0,0,0,8.44,3.541,11.856,11.856,0,0,0,8.592-3.57,11.389,11.389,0,0,0,3.424-8.431,11.583,11.583,0,0,0-3.484-8.52Zm-1.5,15.391a9.631,9.631,0,0,1-7,2.94,9.479,9.479,0,0,1-6.938-2.911A9.422,9.422,0,0,1,2.8,12.64,9.57,9.57,0,0,1,5.747,5.68,9.3,9.3,0,0,1,12.655,2.8a9.4,9.4,0,0,1,6.94,2.88,9.411,9.411,0,0,1,2.884,6.96,9.157,9.157,0,0,1-2.823,6.87Z" transform="translate(-0.641 -0.64)"></path>
251
										</svg>
252
										<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24">
253
											<g id="Group_756" data-name="Group 756" transform="translate(0)">
254
													<path id="Path_2324" data-name="Path 2324" d="M18.325,11.98a.775.775,0,0,0-.775-.775H12.641a.775.775,0,0,0-.775.775v4.909h1.369V22.7h3.719V16.889h1.37V11.98Z" transform="translate(-3.095 -2.951)"></path>
255
													<path id="Path_2325" data-name="Path 2325" d="M17.209,7.759A1.679,1.679,0,1,1,15.53,6.08,1.679,1.679,0,0,1,17.209,7.759Z" transform="translate(-3.529 -1.83)"></path>
256
													<path id="Path_2326" data-name="Path 2326" d="M12.624.64A11.439,11.439,0,0,0,4.183,4.12,11.736,11.736,0,0,0,.639,12.64,11.537,11.537,0,0,0,4.183,21.1a11.531,11.531,0,0,0,8.441,3.54,11.851,11.851,0,0,0,8.591-3.57,11.383,11.383,0,0,0,3.424-8.43,11.582,11.582,0,0,0-3.484-8.52,11.612,11.612,0,0,0-8.53-3.48Zm.03,2.159a9.4,9.4,0,0,1,6.939,2.88,9.414,9.414,0,0,1,2.883,6.96,9.156,9.156,0,0,1-2.823,6.87,9.63,9.63,0,0,1-7,2.94,9.48,9.48,0,0,1-6.939-2.91A9.425,9.425,0,0,1,2.8,12.64,9.573,9.573,0,0,1,5.746,5.68,9.3,9.3,0,0,1,12.654,2.8Z" transform="translate(-0.639 -0.64)"></path>
257
											</g>
258
										</svg>
259
									</a> &nbsp;Unless otherwise indicated, all materials created by OpenAIRE are licenced under
260
									<a href="http://creativecommons.org/licenses/by/4.0/" rel="license">
261
											CC ATTRIBUTION 4.0 INTERNATIONAL LICENSE
262
									</a>. 
263
								</div>
264
							</div>
265
							<div class="uk-width-small@m">
266
								<div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-right@m uk-text-center">
267
									<a href="#" uk-scroll="" class="uk-totop uk-icon">
268
										<svg width="18" height="10" viewBox="0 0 18 10" xmlns="http://www.w3.org/2000/svg" data-svg="totop">
269
											<polyline fill="none" stroke="#000" stroke-width="1.2" points="1 9 9 1 17 9 "></polyline>
270
										</svg>
271
									</a>
272
								</div>
273
							</div>
274
						</div>
275
					</div>
276
				</div>
277
			</bottom>
278
			<!-- Footer ENDS here -->
279

    
280
		</div>
281
	</body>
282
</html>
(9-9/23)