Project

General

Profile

« Previous | Next » 

Revision 60402

Authentication documentation added + broker card + broker dummy page

View differences:

modules/dnet-api-http-doc/branches/auth-broker/registeredService.html
1

  
2

  
3
<!DOCTYPE html>
4
<html lang="en-gb">
5
   <head>
6
      <!--link href="http://demo.openaire.eu" rel="canonical" /-->
7
      <meta charset="utf-8">
8
      <meta http-equiv="X-UA-Compatible" content="IE=edge">
9
      <meta name="viewport" content="width=device-width, initial-scale=1">
10
      <meta http-equiv="content-type" content="text/html; charset=utf-8" />
11
      <meta name="description" content="OpenAIRE API documentation, open access, research, scientific publication, European Commission, EC, FP7, ERC,
12
      Horizon 2020, H2020, search, projects, publications, research data, datasets, HTTP, funders "/>
13
      <link href="./assets/favicon.ico" rel="shortcut icon" />
14
      <title>OpenAIRE API documentation - Authentication Registered Services</title>
15
      <script  src="./assets/jquery.js"></script>
16
      <script  src="./assets/uikit.js"></script>
17
      <script src="./assets/uikit-icon-max.js"></script>
18
      <link rel="stylesheet" type="text/css" href="./assets/theme.css">
19
      <link rel="stylesheet" type="text/css" href="./assets/custom.css">
20
      <link rel="stylesheet" type="text/css" href="./assets/develop-custom.css">
21

  
22
   </head>
23
   <body>
24
      <div class="uk-offcanvas-content uk-height-viewport">
25
        <div class="tm-header-mobile uk-hidden@m">
26
          <div animation="uk-animation-slide-top" class="uk-navbar-container uk-sticky  uk-navbar-transparent" cls-active="uk-active uk-navbar-sticky" cls-inactive="uk-navbar-transparent" uk-sticky="">
27
           <nav class="uk-navbar-container uk-navbar" uk-navbar="">
28
              <div class="uk-navbar-left">
29
                 <a class="uk-navbar-toggle" href="#tm-mobile" uk-toggle="">
30
                    <div uk-navbar-toggle-icon="" class="uk-navbar-toggle-icon uk-icon">
31

  
32
                    </div>
33
                 </a>
34
              </div>
35
              <div class="uk-navbar-center">
36
                 <a class="uk-navbar-item uk-logo" href="overview.html">
37
                 <img src="assets/OA DEVELOP_A.png" class="uk-responsive-height" alt="OpenAIRE">        </a>
38
              </div>
39
           </nav>
40
           <div id="tm-mobile" uk-offcanvas="" mode="slide" overlay="" class="uk-offcanvas">
41
              <div class="uk-offcanvas-bar">
42
                 <button class="uk-offcanvas-close uk-close uk-icon" type="button" uk-close="">
43
                 </button>
44
                 <div class="uk-child-width-1-1 uk-grid" uk-grid="">
45
                    <div>
46
                       <div class="uk-panel" id="module-0">
47
                          <ul class="uk-nav uk-nav-default">
48
                            <li class="uk-nav-header uk-parent" >
49
                              Dashboards
50
                              <ul class="uk-nav-sub">
51
                            		<li><a href="https://explore.openaire.eu" target="_blank" class="uk-heading-bullet explore-heading-bullet">EXPLORE</a></li>
52
                            		<li><a href="https://provide.openaire.eu" target="_blank" class="uk-heading-bullet provide-heading-bullet">PROVIDE</a></li>
53
                            		<li><a href="https://connect.openaire.eu" target="_blank" class="uk-heading-bullet connect-heading-bullet">CONNECT</a></li>
54
                            		<li><a href="https://monitor.openaire.eu" target="_blank" class="uk-heading-bullet monitor-heading-bullet">MONITOR</a></li>
55
                               </ul>
56
                            </li>
57
                             <li class="uk-nav-header uk-parent">
58
                                <a href="./overview.html"> Overview </a>
59

  
60
                             </li>
61
                             <li class="uk-nav-header uk-parent uk-active">
62
                                 Authentication
63
                                 <ul class="uk-nav-sub">
64
                                    <li><a routerLinkActive="uk-link" href="./authentication.html" >General Information</a></li>
65
                                    <li><a routerLinkActive="uk-link" href="./personalToken.html" >Personal Token</a></li>
66
                                    <li><a routerLinkActive="uk-link" href="./registeredService.html">Registered Services</a>
67
                                       <ul class="uk-nav-sub">
68
                                          <li><a routerLinkActive="uk-link" href="./basic.html">Basic</a></li>
69
                                          <li><a routerLinkActive="uk-link" href="./advanced.html">Advanced</a></li>
70
                                       </ul>
71
                                    </li>
72
                                 </ul>                                 
73
                              </li>
74
                              <li class="uk-nav-header uk-parent">
75
                               Bulk access
76
                               <ul class="uk-nav-sub">
77
                                   <li><a routerLinkActive="uk-link" href="./graph-dumps.html" >OpenAIRE Research Graph Dumps</a></li>
78
                                  <li><a routerLinkActive="uk-link" href="./oai-pmh.html" >OAI-PMH (discontinued)</a></li>
79
                                  <li><a routerLinkActive="uk-link" href="./bulk-projects.html" >Bulk access to projects</a></li>
80
                               </ul>
81
                             </li>
82
                              <li class="uk-nav-header uk-parent">
83
                               <a href="./api.html">Selective access</a>
84
                                <ul class="uk-nav-sub">
85
                                 <li><a href="./api.html#pubs" >Publications</a></li>
86
                                 <li><a href="./api.html#datasets" >Research Data</a></li>
87
                                  <li><a href="./api.html#software" >Software</a></li>
88
                                  <li><a href="./api.html#other" >Other Research Products</a></li>
89
                                 <li><a href="./api.html#projects" >Projects</a></li>
90
                               </ul>
91
                             </li>
92
                          </ul>
93
                       </div>
94
                    </div>
95
                 </div>
96
              </div>
97
           </div>
98
        </div>
99
       </div>
100
        <!--Mobile ENDS here -->
101
        <div class="tm-toolbar custom-develop-toolbar uk-visible@m">
102
           <div class="uk-container uk-flex uk-flex-middle uk-container-expand ">
103
              <div class="uk-margin-auto-left">
104
                 <div class="uk-grid-medium uk-child-width-auto uk-flex-middle uk-grid uk-grid-stack" uk-grid="margin: uk-margin-small-top">
105
                    <div class="uk-first-column">
106
                       <div class="uk-panel inner" id="module-119">
107
                          <ul class="uk-subnav">
108
                            <li class="line"><a href="https://www.openaire.eu"><img class="uk-responsive-height" src="assets/Home_24white.svg" alt="home"/></a></li>
109
                            <li class="line"><a href="https://explore.openaire.eu" title="Search in OA. Link your research">Explore</a></li>
110
                            <li class="line"><a href="https://provide.openaire.eu" title="Content Provider Dashboard">Provide</a></li>
111
                            <li class="line"><a href="https://connect.openaire.eu" title="Research Community Dashboard">Connect</a></li>
112
                            <li class="line"><a href="https://monitor.openaire.eu" title="Monitoring Dashboard">Monitor</a></li>
113
                            <li class="line custom-develop-li "><a href="overview.html" title="APIs">Develop</a></li>
114
                          </ul>
115
                       </div>
116
                    </div>
117
                 </div>
118
              </div>
119
           </div>
120
        </div>
121
        <div class="tm-header uk-visible@m tm-header-transparent" uk-header="">
122
          <div animation="uk-animation-slide-top" class="uk-navbar-container uk-sticky uk-navbar-transparent" cls-active="uk-active uk-navbar-sticky" cls-inactive="uk-navbar-transparent"   top=".tm-header + [class*=&quot;uk-section&quot;]" uk-sticky="">
123
              <div class="uk-navbar-container uk-navbar-transparent">
124
                 <div class="uk-container uk-container-expand">
125
                    <nav class="uk-navbar" uk-navbar="{&quot;align&quot;:&quot;left&quot;}">
126
                       <div class="uk-navbar-left">
127
                          <a href="overview.html" class="uk-navbar-item uk-logo">
128
                          <img src="assets/OA DEVELOP_B.png" class="uk-responsive-height" alt="OpenAIRE"></a>
129
                       </div>
130
                       <div class="uk-navbar-right">
131
                          <ul class="uk-navbar-nav">
132
                             <li class="uk-parent">
133
                                <a href="overview.html" class="" aria-expanded="false">Overview</a>
134
                             </li>
135

  
136
                              <li class="uk-parent uk-active">
137
                                 <a href="#" class="" aria-expanded="false">Authentication</a>
138
                                 <div class="uk-navbar-dropdown uk-navbar-dropdown-bottom-left" style="left: 116px; top: 80px;">
139
                                    <div class="uk-navbar-dropdown-grid uk-child-width-1-1 uk-grid uk-grid-stack" uk-grid="">
140
                                       <div class="uk-first-column">
141
                                          <ul class="uk-nav uk-navbar-dropdown-nav">
142
                                             <li><a routerLinkActive="uk-link" href="./authentication.html" >General Information</a></li>
143
                                             <li><a routerLinkActive="uk-link" href="./personalToken.html" >Personal Token</a></li>
144
                                             <li><a routerLinkActive="uk-link" href="./registeredService.html">Registered Services</a></li>                                                                                      
145
                                          </ul>                                 
146
                                       </div>
147
                                    </div>
148
                                 </div>
149
                              </li>
150
                             <li class="uk-parent">
151
                                <a href="#" class="" aria-expanded="false">Bulk access</a>
152
                                <div class="uk-navbar-dropdown uk-navbar-dropdown-bottom-left" style="left: 116px; top: 80px;">
153
                                   <div class="uk-navbar-dropdown-grid uk-child-width-1-1 uk-grid uk-grid-stack" uk-grid="">
154
                                      <div class="uk-first-column">
155
                                         <ul class="uk-nav uk-navbar-dropdown-nav">
156
                                            <li><a routerLinkActive="uk-link" href="./graph-dumps.html" >OpenAIRE Research Graph Dumps</a></li>
157
                                           <li><a routerLinkActive="uk-link" href="./oai-pmh.html" >OAI-PMH (discontinued)</a></li>
158
                                           <li><a routerLinkActive="uk-link" href="./bulk-projects.html" >Bulk access to projects</a></li>
159
                                         </ul>
160
                                      </div>
161
                                   </div>
162
                                </div>
163
                             </li>
164
                              <li class="uk-parent">
165
                                <a href="#" class="" aria-expanded="false">Selective access</a>
166
                                <div class="uk-navbar-dropdown uk-navbar-dropdown-bottom-left" style="left: 228px; top: 80px;">
167
                                   <div class="uk-navbar-dropdown-grid uk-child-width-1-1 uk-grid uk-grid-stack" uk-grid="">
168
                                      <div class="uk-first-column">
169
                                         <ul class="uk-nav uk-navbar-dropdown-nav">
170
                                           <li><a href="./api.html#pubs" >Publications</a></li>
171
                                           <li><a href="./api.html#datasets" >Research Data</a></li>
172
                                            <li><a href="./api.html#software" >Software</a></li>
173
                                            <li><a href="./api.html#other" >Other Research Products</a></li>
174
                                           <li><a href="./api.html#projects" >Projects</a></li>
175
                                         </ul>
176
                                      </div>
177
                                   </div>
178
                                </div>
179
                             </li>
180

  
181
                          </ul>
182
                       </div>
183

  
184
                    </nav>
185
                 </div>
186
              </div>
187
           </div>
188
         </div>
189

  
190
         <div class=" first_page_section uk-section-default uk-section uk-padding-remove-vertical">
191
            <div class="first_page_banner_headline uk-grid-collapse uk-flex-middle uk-margin-remove-vertical uk-grid" uk-grid="">
192
            </div>
193
         </div>
194

  
195
         <div   class=" uk-section uk-margin-large-top tm-middle custom-main-content" id="tm-main">
196
            <div class="uk-container">
197
              <div class="uk-grid">
198
                <div class="uk-width-1-3@s uk-width-1-4@m uk-width-1-4@l uk-visible@m" >
199
                     <ul class="uk-nav-default uk-nav-parent-icon" uk-nav="multiple: false" uk-sticky="offset: 100; media:@s" >
200
                           <li class="uk-parent uk-open">
201
                               <a href="#">Authentication</a>
202
                               <ul class="uk-nav-sub">
203
                                   <li><a href="./authentication.html">General Information</a></li>
204
                                   <li><a href="./personalToken.html">Personal Token</a></li>
205
                                   <li class="uk-active"><b><a href="./registeredService.html">Registered Services</a></b></li>
206
                                   <ul class="uk-nav-sub">
207
                                       <li><a href="./basic.html">Basic</a></li>
208
                                       <li><a href="./advanced.html">Advanced</a></li>
209
                                   </ul>
210
                               </ul>
211
                           </li>
212
                       </ul>
213
                </div>
214

  
215

  
216
                <div   class="tm-main uk-width-expand uk-row-first uk-first-column">
217
                  <h2 id="service">Service registration</h2>               
218
                  <p>If you have a service (client) that you want to interact with the OpenAIRE APIs you need to register it. </p>
219
                  <div class="uk-alert-primary" uk-alert>
220
                        You can register up to 5 services.
221
                  </div>
222

  
223
                  We offer two ways of authenticting your service: the Basic Authentication and the Advanced Authentication. 
224
                  
225
                  <h4>Which one is for me?</h4>
226

  
227
                  <table class="uk-table uk-table-divider uk-table-striped">
228
                     <thead>
229
                           <tr>
230
                              <th></th>
231
                              <th>How</th>
232
                              <th>Client Credential Issuer</th>
233
                              <th>Authentication Method</th>
234
                           </tr>
235
                     </thead>
236
                     <tbody>
237
                           <tr>
238
                              <td><b>Basic</b></td>
239
                              <td>Client ID & Client Secret</td>
240
                              <td>OpenAIRE AAI server</td>
241
                              <td>Client Secret (Basic)</td>
242
                           </tr>
243
                           <tr>
244
                           <td><b>Advanced</b></td>
245
                           <td>Private Key signed JWT</td>
246
                           <td>Service owner</td>
247
                           <td>Private Key JWT Client Authentication</td>
248
                           </tr>
249
                     </tbody>
250
                  </table>
251

  
252
                  <p>For the <b>Basic Authentication</b> method the OpenAIRE AAI server generates a pair of <em>Client ID</em> and <em>Client Secret</em> 
253
                  credentials for your service upon its registration. The service sends the client id and client secret  when authenticating to the
254
                  OpenAIRE AAI Server to obtain the access token for the OpenAIRE APIs. The OpenAIRE AAI server checks whether the client id and client 
255
                  secret sent is valid.
256
                  <a class="uk-button uk-button-default uk-margin-medium-top" href="./basic.html">Continue reading for the Basic Authentication</a>
257
                  </p> 
258

  
259
                  <p>For the <b>Advanced Authentication</b> method your service does not send a client secret but it uses a <em>self signed 
260
                     client assertion</em> to authenticate to the OpenAIRE AAI server in order to obtain the access token for the OpenAIRE APIs. 
261
                     The client assertion is a JWT that must be signed with RSASSA using SHA-256 hash algorithm. The OpenAIRE AAI server validates 
262
                     the client assertion using the public key that you have provided upon the service registration.
263
                     <br>
264
                     <a class="uk-button uk-button-default uk-margin-medium-top" href="./advanced.html">Continue reading for the Advanced Authentication</a>
265
                  </p>
266

  
267
                  <div class="uk-alert-primary" uk-alert>
268
                     The Advanced Authentication method allows the OpenAIRE AAI server to verify that the client authentication request at the token endpoint 
269
                     was signed by your service and not altered in any way. This is more computation intensive compared to the Basic Authentication but it 
270
                     ensures non-repudiation. On the other hand, the Basic Authentication is more lightweight and easy to deploy but it does not provide 
271
                     signature verification, and there is always a possibility of the Client ID/secret credentials being stolen. Note that tThe Advanced 
272
                     authentication method gives a higher level of security to the process as long as it is used correctly, i.e. when the signed JWT has a 
273
                     short duration. When the duration of the JWT is long, the process is no different from the basic one.
274
                  </div>
275

  
276
            </div> <DO NOT REMOVE>
277
          </div>
278
        </div>
279
      </div>
280
         <!-- FOOTER STARTS HERE-->
281
         <!-- <div class="uk-section-primary uk-preserve-color uk-section uk-section-small uk-padding-remove-bottom">
282
           <div class="uk-container uk-container-expand">
283
              <div class="uk-grid-large uk-grid-margin-large uk-grid" uk-grid="">
284
                 <div class="uk-width-auto@m uk-light uk-first-column">
285
                    <div id="footer#4" class="newsletter uk-margin uk-margin-remove-bottom uk-text-left uk-panel">
286
                       <h6 class="el-title uk-margin uk-h2">
287
                          Newsletter
288
                       </h6>
289
                       <a target="_blank" href="https://www.openaire.eu/newsletter/view" class="el-link">
290
                          <span   class="el-image uk-icon">
291
                             <svg width="30" height="30" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
292
                                <circle cx="3.12" cy="16.8" r="1.85"></circle>
293
                                <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>
294
                                <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>
295
                             </svg>
296
                          </span>
297
                       </a>
298
                    </div>
299
                 </div>
300
                 <div class="uk-width-expand@m uk-light">
301
                    <div id="footer#7" class="uk-text-right@m uk-text-center">
302
                       <ul class="uk-subnav uk-margin-remove-bottom uk-subnav-divider uk-flex-right@m uk-flex-center" uk-margin="">
303
                          <li class="el-item uk-first-column">
304
                             <a class="el-link" target="_blank" href="https://www.openaire.eu/about">About</a>
305
                          </li>
306
                          <li class="el-item">
307
                             <a class="el-link" href="http://catalogue.openaire.eu" target="_blank">Services</a>
308
                          </li>
309
                          <li class="el-item">
310
                             <a class="el-link" target="_blank" href="https://www.openaire.eu/support">Support</a>
311
                          </li>
312
                          <li class="el-item">
313
                             <a class="el-link" target="_blank" href="https://www.openaire.eu/news">News</a>
314
                          </li>
315
                          <li class="el-item">
316
                             <a class="el-link" target="_blank" href="https://www.openaire.eu/events">Events</a>
317
                          </li>
318
                          <li class="el-item">
319
                             <a class="el-link" target="_blank" href="https://www.openaire.eu/documents">Documents</a>
320
                          </li>
321
                       </ul>
322
                    </div>
323
                 </div>
324
                 <div class="uk-width-auto@m uk-grid-item-match">
325
                    <div class="uk-tile-primary uk-preserve-color uk-tile uk-padding-remove">
326
                       <div id="footer#9" class="uk-margin uk-text-right@m uk-text-center">
327
                          <a class="el-content uk-button uk-button-default uk-button-small" target="_blank" href="https://www.openaire.eu/contact-us" target="_blank">
328
                          Contact us
329
                          </a>
330
                       </div>
331
                    </div>
332
                 </div>
333
              </div>
334
           </div>
335
        </div>
336
        <div class="uk-section-primary uk-section uk-section-xsmall uk-padding-remove-bottom">
337
           <div class="uk-container uk-container-expand">
338
              <div class="uk-margin-small uk-grid uk-grid-stack" uk-grid="">
339
                 <div class="uk-width-1-1@m uk-first-column">
340
                    <div class="uk-margin-large uk-margin-remove-top uk-text-center@m uk-text-center">
341
                       <img src="assets/Logo_Horizontal_white_small.png"   sizes="(min-width: 126px) 126px" data-width="126" data-height="30" class="el-image" alt="OpenAIRE">
342
                    </div>
343
                 </div>
344
              </div>
345
              <div class="uk-flex-middle uk-margin-remove-vertical uk-grid" uk-grid="">
346
                 <div class="uk-width-small@m uk-first-column">
347
                    <div id="footer#16" class="uk-margin-medium uk-text-left@m uk-text-center uk-margin-small-bottom">
348
                       <img src="assets/commission.jpg" sizes="(min-width: 50px) 50px" data-width="427" data-height="285" class="el-image" alt="European Commission">
349
                    </div>
350
                 </div>
351
                 <div class="uk-width-expand@m">
352
                    <div id="footer#18" class=" uk-text-small uk-margin uk-margin-remove-bottom uk-text-center uk-text-lead">
353
                       <a href="http://creativecommons.org/licenses/by/4.0/" rel="license">
354
                          <img src="/images/Icons/cc.svg" uk-svg="" hidden="true">
355
                          <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" width="24" height="24" class=" uk-svg">
356
                             <title></title>
357
                             <g data-name="Creative Commons" id="Creative_Commons">
358
                                <circle cx="12" cy="12" r="11.5" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></circle>
359
                                <path d="M10.87,10a3.5,3.5,0,1,0,0,4" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></path>
360
                                <path d="M18.87,10a3.5,3.5,0,1,0,0,4" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></path>
361
                             </g>
362
                          </svg>
363
                          &nbsp;<img src="/images/Icons/cc-by.svg" uk-svg="" hidden="true">
364
                          <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" width="24" height="24" class=" uk-svg">
365
                             <title></title>
366
                             <g id="Attribution">
367
                                <g data-name="<Group>" id="_Group_">
368
                                   <circle cx="12" cy="5" data-name="<Path>" id="_Path_" r="1.5" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></circle>
369
                                   <path d="M12,8a5,5,0,0,0-3.07.71,1,1,0,0,0-.43.83V15H10v5.5h4V15h1.5V9.54a1,1,0,0,0-.43-.83A5,5,0,0,0,12,8Z" data-name="<Path>" id="_Path_2" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></path>
370
                                </g>
371
                                <circle cx="12" cy="12" r="11.5" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></circle>
372
                             </g>
373
                          </svg>
374
                       </a>
375
                       &nbsp;Unless otherwise indicated, all materials created by OpenAIRE are licenced under&nbsp;<a href="http://creativecommons.org/licenses/by/4.0/" rel="license">CC ATTRIBUTION 4.0 INTERNATIONAL LICENSE</a>.
376
                    </div>
377
                 </div>
378
                 <div class="uk-width-small@m">
379
                    <div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-right@m uk-text-center">
380
                       <a href="#" uk-totop="" uk-scroll="" class="uk-totop uk-icon">
381
                       </a>
382
                    </div>
383
                 </div>
384
              </div>
385
           </div>
386
        </div> -->
387
        <div class="uk-section-primary uk-section uk-section-small uk-padding-remove-bottom">
388
     <div class="uk-container uk-container-expand">
389
        <div class="uk-container uk-container-expand uk-margin-small">
390
           <div class="uk-grid-collapse uk-grid" uk-grid="">
391
              <div id="footer#3" class="uk-width-expand@s uk-first-column">
392
                 <div class="uk-margin-small uk-margin-remove-top uk-text-left@s uk-text-center">
393
                    <img src="assets/Logo_Horizontal_white_small.png"   data-width="126" data-height="30" class="el-image" alt="OpenAIRE">
394
                 </div>
395
                 <div id="footer#5" class="uk-margin uk-text-left@s uk-text-center">
396
                    <img src="assets/commission.jpg"   sizes="(min-width: 50px) 50px" data-width="427" data-height="285" class="el-image" alt="European Commission">
397
                 </div>
398
                 <div id="footer#6" class="newsletter uk-margin uk-margin-remove-bottom uk-text-left@s uk-text-center uk-panel">
399
                    <h5 class="el-title uk-margin uk-h5">
400
                       Newsletter
401
                    </h5>
402
                    <a target="_blank" href="https://www.openaire.eu/newsletter/view" class="el-link">
403
                       <span   class="el-image uk-icon">
404
                          <svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
405
                             <circle cx="3.12" cy="16.8" r="1.85"></circle>
406
                             <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>
407
                             <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>
408
                          </svg>
409
                       </span>
410
                    </a>
411
                 </div>
412
                 <div id="footer#7" class="newsletter uk-margin-small uk-margin-remove-top uk-text-left@s uk-text-center uk-panel">
413

  
414
                    <div class="acymailing_module" id="acymailing_module_formAcymailing60611">
415
                       <div class="acymailing_mootoolsbutton" id="acymailing_toggle_formAcymailing60611">
416
                          <p><a class="acymailing_togglemodule" id="acymailing_togglemodule_formAcymailing60611" target="_blank" href="https://www.openaire.eu/newsletter/view">Subscribe</a></p>
417

  
418
                       </div>
419
                    </div>
420
                 </div>
421
                 <div class="uk-margin-small uk-margin-remove-top uk-text-left@s uk-text-center">
422
                    <div class="uk-child-width-auto uk-grid-small uk-flex-left@s uk-flex-center uk-grid" uk-grid="">
423
                       <div class="uk-first-column">
424
                          <a  href="http://www.facebook.com/groups/openaire/" target="_blank" class="el-link uk-icon-button uk-icon">
425
                             <svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
426
                                <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>
427
                             </svg>
428
                          </a>
429
                       </div>
430
                       <div>
431
                          <a  href="http://www.twitter.com/OpenAIRE_eu" target="_blank" class="el-link uk-icon-button uk-icon">
432
                             <svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
433
                                <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>
434
                             </svg>
435
                          </a>
436
                       </div>
437
                       <div>
438
                          <a  href="http://www.linkedin.com/groups/OpenAIRE-3893548" target="_blank" class="el-link uk-icon-button uk-icon">
439
                             <svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
440
                                <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>
441
                                <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>
442
                             </svg>
443
                          </a>
444
                       </div>
445
                       <div>
446
                          <a  href="http://www.slideshare.net/OpenAIRE_eu" target="_blank" class="el-link uk-icon-button uk-icon">
447
                             <svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
448
                                <line fill="none" stroke="#000" stroke-width="1.1" x1="13.4" y1="14" x2="6.3" y2="10.7"></line>
449
                                <line fill="none" stroke="#000" stroke-width="1.1" x1="13.5" y1="5.5" x2="6.5" y2="8.8"></line>
450
                                <circle fill="none" stroke="#000" stroke-width="1.1" cx="15.5" cy="4.6" r="2.3"></circle>
451
                                <circle fill="none" stroke="#000" stroke-width="1.1" cx="15.5" cy="14.8" r="2.3"></circle>
452
                                <circle fill="none" stroke="#000" stroke-width="1.1" cx="4.5" cy="9.8" r="2.3"></circle>
453
                             </svg>
454
                          </a>
455
                       </div>
456
                       <div>
457
                          <a href="https://www.youtube.com/channel/UChFYqizc-S6asNjQSoWuwjw" target="_blank" class="el-link uk-icon-button uk-icon">
458
                             <svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
459
                                <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>
460
                             </svg>
461
                          </a>
462
                       </div>
463
                    </div>
464
                 </div>
465
              </div>
466
              <div id="footer#9" class="uk-width-expand@s">
467
                 <div id="footer#10" class="uk-width-medium uk-text-left@s uk-text-center uk-panel">
468
                    <h3 class="el-title uk-h6">Dashboards</h3>
469
                    <ul class="uk-nav uk-nav-default uk-nav-parent-icon uk-nav-accordion" uk-nav="">
470
                       <li><a href="https://explore.openaire.eu" target="_blank">Explore</a></li>
471
                       <li><a href="https://provide.openaire.eu" target="_blank">Provide</a></li>
472
                       <li><a href="https://connect.openaire.eu/" target="_blank">Connect</a></li>
473
                       <li><a href="https://monitor.openaire.eu" target="_blank">Monitor</a></li>
474
                       <li><a href="https://develop.openaire.eu" target="_blank">Develop</a></li>
475
                    </ul>
476
                 </div>
477
              </div>
478
              <div id="footer#11" class="uk-width-expand@s">
479
                 <div id="footer#12" class="uk-width-medium uk-text-left@s uk-text-center uk-panel">
480
                    <h3 class="el-title uk-h6">Support</h3>
481
                    <ul class="uk-nav uk-nav-default uk-nav-parent-icon uk-nav-accordion" uk-nav="">
482
                       <li><a target="_blank" href="https://www.openaire.eu/guides">Guides</a></li>
483
                       <li><a target="_blank" href="https://www.openaire.eu/faqs">FAQs</a></li>
484
                       <li><a target="_blank" href="https://www.openaire.eu/frontpage/webinars">Webinars</a></li>
485
                       <li><a target="_blank" href="https://www.openaire.eu/support/helpdesk">Ask a question</a></li>
486
                    </ul>
487
                 </div>
488
              </div>
489
              <div id="footer#13" class="uk-width-expand@s">
490
                 <div id="footer#14" class="uk-width-medium uk-text-left@s uk-text-center uk-panel">
491
                    <h3 class="el-title uk-h6">Updates</h3>
492
                    <ul class="uk-nav uk-nav-default uk-nav-parent-icon uk-nav-accordion" uk-nav="">
493
                       <li><a target="_blank" href="https://www.openaire.eu/news/">News</a></li>
494
                       <li><a target="_blank" href="https://www.openaire.eu/events">Events</a></li>
495
                       <li><a target="_blank" href="https://www.openaire.eu/blogs/magazine">Blogs</a></li>
496
                       <li><a target="_blank" href="https://www.openaire.eu/documents">Documents</a></li>
497
                    </ul>
498
                 </div>
499
              </div>
500
           </div>
501
        </div>
502
     </div>
503
  </div>
504
  <div class="uk-section-primary uk-section uk-section-xsmall">
505
   <div class="uk-container">
506
      <div class="uk-grid-margin uk-grid uk-grid-stack" uk-grid="">
507
         <div class="uk-width-expand@m">
508
         </div>
509
      </div>
510
   </div>
511
</div>
512
<div class="uk-section-primary uk-section uk-section-xsmall">
513
   <div class="uk-container uk-container-expand">
514
      <div class="uk-grid-margin uk-grid" uk-grid="">
515
         <div class="uk-width-small@m uk-first-column">
516
         </div>
517
         <div class="uk-width-expand@m">
518
            <div id="footer#22" class=" uk-text-small uk-margin uk-margin-remove-bottom uk-text-center@m uk-text-center uk-text-lead">
519
               <a href="http://creativecommons.org/licenses/by/4.0/" rel="license">
520
                  <img src="/images/Icons/cc.svg" uk-svg="" hidden="true">
521
                  <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" width="24" height="24" class=" uk-svg">
522
                     <title></title>
523
                     <g data-name="Creative Commons" id="Creative_Commons">
524
                        <circle cx="12" cy="12" r="11.5" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></circle>
525
                        <path d="M10.87,10a3.5,3.5,0,1,0,0,4" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></path>
526
                        <path d="M18.87,10a3.5,3.5,0,1,0,0,4" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></path>
527
                     </g>
528
                  </svg>
529
                  &nbsp;<img src="/images/Icons/cc-by.svg" uk-svg="" hidden="true">
530
                  <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" width="24" height="24" class=" uk-svg">
531
                     <title></title>
532
                     <g id="Attribution">
533
                        <g data-name="<Group>" id="_Group_">
534
                           <circle cx="12" cy="5" data-name="<Path>" id="_Path_" r="1.5" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></circle>
535
                           <path d="M12,8a5,5,0,0,0-3.07.71,1,1,0,0,0-.43.83V15H10v5.5h4V15h1.5V9.54a1,1,0,0,0-.43-.83A5,5,0,0,0,12,8Z" data-name="<Path>" id="_Path_2" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></path>
536
                        </g>
537
                        <circle cx="12" cy="12" r="11.5" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></circle>
538
                     </g>
539
                  </svg>
540
               </a>
541
               &nbsp;Unless otherwise indicated, all materials created by OpenAIRE are licenced under&nbsp;<a href="http://creativecommons.org/licenses/by/4.0/" rel="license">CC ATTRIBUTION 4.0 INTERNATIONAL LICENSE</a>.
542
            </div>
543
         </div>
544
         <div class="uk-width-small@m">
545
            <div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-right@m uk-text-center">
546
               <a href="#" uk-totop="" uk-scroll="" class="uk-totop uk-icon">
547

  
548
               </a>
549
            </div>
550
         </div>
551
      </div>
552
   </div>
553
</div>
554
      <!--/div-->
555
      </div>
556
   </body>
557
</html>
modules/dnet-api-http-doc/branches/auth-broker/authentication.html
1

  
2

  
3
<!DOCTYPE html>
4
<html lang="en-gb">
5
   <head>
6
      <!--link href="http://demo.openaire.eu" rel="canonical" /-->
7
      <meta charset="utf-8">
8
      <meta http-equiv="X-UA-Compatible" content="IE=edge">
9
      <meta name="viewport" content="width=device-width, initial-scale=1">
10
      <meta http-equiv="content-type" content="text/html; charset=utf-8" />
11
      <meta name="description" content="OpenAIRE API documentation, open access, research, scientific publication, European Commission, EC, FP7, ERC,
12
      Horizon 2020, H2020, search, projects, publications, research data, datasets, HTTP, funders "/>
13
      <link href="./assets/favicon.ico" rel="shortcut icon" />
14
      <title>OpenAIRE API documentation - Authentication</title>
15
      <script  src="./assets/jquery.js"></script>
16
      <script  src="./assets/uikit.js"></script>
17
      <script src="./assets/uikit-icon-max.js"></script>
18
      <link rel="stylesheet" type="text/css" href="./assets/theme.css">
19
      <link rel="stylesheet" type="text/css" href="./assets/custom.css">
20
      <link rel="stylesheet" type="text/css" href="./assets/develop-custom.css">
21

  
22
   </head>
23
   <body>
24
      <div class="uk-offcanvas-content uk-height-viewport">
25
        <div class="tm-header-mobile uk-hidden@m">
26
          <div animation="uk-animation-slide-top" class="uk-navbar-container uk-sticky  uk-navbar-transparent" cls-active="uk-active uk-navbar-sticky" cls-inactive="uk-navbar-transparent" uk-sticky="">
27
           <nav class="uk-navbar-container uk-navbar" uk-navbar="">
28
              <div class="uk-navbar-left">
29
                 <a class="uk-navbar-toggle" href="#tm-mobile" uk-toggle="">
30
                    <div uk-navbar-toggle-icon="" class="uk-navbar-toggle-icon uk-icon">
31

  
32
                    </div>
33
                 </a>
34
              </div>
35
              <div class="uk-navbar-center">
36
                 <a class="uk-navbar-item uk-logo" href="overview.html">
37
                 <img src="assets/OA DEVELOP_A.png" class="uk-responsive-height" alt="OpenAIRE">        </a>
38
              </div>
39
           </nav>
40
           <div id="tm-mobile" uk-offcanvas="" mode="slide" overlay="" class="uk-offcanvas">
41
              <div class="uk-offcanvas-bar">
42
                 <button class="uk-offcanvas-close uk-close uk-icon" type="button" uk-close="">
43
                 </button>
44
                 <div class="uk-child-width-1-1 uk-grid" uk-grid="">
45
                    <div>
46
                       <div class="uk-panel" id="module-0">
47
                          <ul class="uk-nav uk-nav-default">
48
                            <li class="uk-nav-header uk-parent" >
49
                              Dashboards
50
                              <ul class="uk-nav-sub">
51
                            		<li><a href="https://explore.openaire.eu" target="_blank" class="uk-heading-bullet explore-heading-bullet">EXPLORE</a></li>
52
                            		<li><a href="https://provide.openaire.eu" target="_blank" class="uk-heading-bullet provide-heading-bullet">PROVIDE</a></li>
53
                            		<li><a href="https://connect.openaire.eu" target="_blank" class="uk-heading-bullet connect-heading-bullet">CONNECT</a></li>
54
                            		<li><a href="https://monitor.openaire.eu" target="_blank" class="uk-heading-bullet monitor-heading-bullet">MONITOR</a></li>
55
                               </ul>
56
                            </li>
57
                             <li class="uk-nav-header uk-parent">
58
                                <a href="./overview.html"> Overview </a>
59

  
60
                             </li>
61
                             <li class="uk-nav-header uk-parent uk-active">
62
                                 Authentication
63
                                 <ul class="uk-nav-sub">
64
                                    <li><a routerLinkActive="uk-link" href="./authentication.html" >General Information</a></li>
65
                                    <li><a routerLinkActive="uk-link" href="./personalToken.html" >Personal Token</a></li>
66
                                    <li><a routerLinkActive="uk-link" href="./registeredService.html">Registered Services</a>
67
                                       <ul class="uk-nav-sub">
68
                                          <li><a routerLinkActive="uk-link" href="./basic.html">Basic</a></li>
69
                                          <li><a routerLinkActive="uk-link" href="./advanced.html">Advanced</a></li>
70
                                       </ul>
71
                                    </li>
72
                                 </ul>                                 
73
                              </li>
74
                              <li class="uk-nav-header uk-parent">
75
                               Bulk access
76
                               <ul class="uk-nav-sub">
77
                                   <li><a routerLinkActive="uk-link" href="./graph-dumps.html" >OpenAIRE Research Graph Dumps</a></li>
78
                                  <li><a routerLinkActive="uk-link" href="./oai-pmh.html" >OAI-PMH (discontinued)</a></li>
79
                                  <li><a routerLinkActive="uk-link" href="./bulk-projects.html" >Bulk access to projects</a></li>
80
                               </ul>
81
                             </li>
82
                             <li class="uk-nav-header uk-parent">
83
                               <a href="./api.html">Selective access</a>
84
                               <!-- <ul class="uk-nav-sub">
85
                                 <li><a href="./api.html#pubs" >Publications</a></li>
86
                                 <li><a href="./api.html#datasets" >Research Data</a></li>
87
                                  <li><a href="./api.html#software" >Software</a></li>
88
                                  <li><a href="./api.html#other" >Other Research Products</a></li>
89
                                 <li><a href="./api.html#projects" >Projects</a></li>
90
                              </ul> -->
91
                             </li>
92
                          </ul>
93
                       </div>
94
                    </div>
95
                 </div>
96
              </div>
97
           </div>
98
        </div>
99
       </div>
100
        <!--Mobile ENDS here -->
101
        <div class="tm-toolbar custom-develop-toolbar uk-visible@m">
102
           <div class="uk-container uk-flex uk-flex-middle uk-container-expand ">
103
              <div class="uk-margin-auto-left">
104
                 <div class="uk-grid-medium uk-child-width-auto uk-flex-middle uk-grid uk-grid-stack" uk-grid="margin: uk-margin-small-top">
105
                    <div class="uk-first-column">
106
                       <div class="uk-panel inner" id="module-119">
107
                          <ul class="uk-subnav">
108
                            <li class="line"><a href="https://www.openaire.eu"><img class="uk-responsive-height" src="assets/Home_24white.svg" alt="home"/></a></li>
109
                            <li class="line"><a href="https://explore.openaire.eu" title="Search in OA. Link your research">Explore</a></li>
110
                            <li class="line"><a href="https://provide.openaire.eu" title="Content Provider Dashboard">Provide</a></li>
111
                            <li class="line"><a href="https://connect.openaire.eu" title="Research Community Dashboard">Connect</a></li>
112
                            <li class="line"><a href="https://monitor.openaire.eu" title="Monitoring Dashboard">Monitor</a></li>
113
                            <li class="line custom-develop-li "><a href="overview.html" title="APIs">Develop</a></li>
114
                          </ul>
115
                       </div>
116
                    </div>
117
                 </div>
118
              </div>
119
           </div>
120
        </div>
121
        <div class="tm-header uk-visible@m tm-header-transparent" uk-header="">
122
          <div animation="uk-animation-slide-top" class="uk-navbar-container uk-sticky uk-navbar-transparent" cls-active="uk-active uk-navbar-sticky" cls-inactive="uk-navbar-transparent"   top=".tm-header + [class*=&quot;uk-section&quot;]" uk-sticky="">
123
              <div class="uk-navbar-container uk-navbar-transparent">
124
                 <div class="uk-container uk-container-expand">
125
                    <nav class="uk-navbar" uk-navbar="{&quot;align&quot;:&quot;left&quot;}">
126
                       <div class="uk-navbar-left">
127
                          <a href="overview.html" class="uk-navbar-item uk-logo">
128
                          <img src="assets/OA DEVELOP_B.png" class="uk-responsive-height" alt="OpenAIRE"></a>
129
                       </div>
130
                       <div class="uk-navbar-right">
131
                          <ul class="uk-navbar-nav">
132
                             <li class="uk-parent">
133
                                <a href="overview.html" class="" aria-expanded="false">Overview</a>
134
                             </li>
135

  
136
                              <li class="uk-parent uk-active">
137
                                 <a href="#" class="" aria-expanded="false">Authentication</a>
138
                                 <div class="uk-navbar-dropdown uk-navbar-dropdown-bottom-left" style="left: 116px; top: 80px;">
139
                                    <div class="uk-navbar-dropdown-grid uk-child-width-1-1 uk-grid uk-grid-stack" uk-grid="">
140
                                       <div class="uk-first-column">
141
                                          <ul class="uk-nav uk-navbar-dropdown-nav">
142
                                             <li><a routerLinkActive="uk-link" href="./authentication.html" >General Information</a></li>
143
                                             <li><a routerLinkActive="uk-link" href="./personalToken.html" >Personal Token</a></li>
144
                                             <li><a routerLinkActive="uk-link" href="./registeredService.html">Registered Services</a></li>                                                                                      
145
                                          </ul>                                 
146
                                       </div>
147
                                    </div>
148
                                 </div>
149
                              </li>
150
                             <li class="uk-parent">
151
                                <a href="#" class="" aria-expanded="false">Bulk access</a>
152
                                <div class="uk-navbar-dropdown uk-navbar-dropdown-bottom-left" style="left: 116px; top: 80px;">
153
                                   <div class="uk-navbar-dropdown-grid uk-child-width-1-1 uk-grid uk-grid-stack" uk-grid="">
154
                                      <div class="uk-first-column">
155
                                         <ul class="uk-nav uk-navbar-dropdown-nav">
156
                                            <li><a routerLinkActive="uk-link" href="./graph-dumps.html" >OpenAIRE Research Graph Dumps</a></li>
157
                                           <li><a routerLinkActive="uk-link" href="./oai-pmh.html" >OAI-PMH (discontinued)</a></li>
158
                                           <li><a routerLinkActive="uk-link" href="./bulk-projects.html" >Bulk access to projects</a></li>
159
                                         </ul>
160
                                      </div>
161
                                   </div>
162
                                </div>
163
                             </li>
164
                             <li class="uk-parent">
165
                                <a href="#" class="" aria-expanded="false">Selective access</a>
166
                                <div class="uk-navbar-dropdown uk-navbar-dropdown-bottom-left" style="left: 228px; top: 80px;">
167
                                   <div class="uk-navbar-dropdown-grid uk-child-width-1-1 uk-grid uk-grid-stack" uk-grid="">
168
                                      <div class="uk-first-column">
169
                                         <ul class="uk-nav uk-navbar-dropdown-nav">
170
                                           <li><a href="./api.html#pubs" >Publications</a></li>
171
                                           <li><a href="./api.html#datasets" >Research Data</a></li>
172
                                            <li><a href="./api.html#software" >Software</a></li>
173
                                            <li><a href="./api.html#other" >Other Research Products</a></li>
174
                                           <li><a href="./api.html#projects" >Projects</a></li>
175
                                         </ul>
176
                                      </div>
177
                                   </div>
178
                                </div>
179
                             </li>
180

  
181
                          </ul>
182
                       </div>
183

  
184
                    </nav>
185
                 </div>
186
              </div>
187
           </div>
188
         </div>
189

  
190
         <div class=" first_page_section uk-section-default uk-section uk-padding-remove-vertical">
191
            <div class="first_page_banner_headline uk-grid-collapse uk-flex-middle uk-margin-remove-vertical uk-grid" uk-grid="">
192
            </div>
193
         </div>
194

  
195
         <div   class=" uk-section uk-margin-large-top tm-middle custom-main-content" id="tm-main">
196
            <div class="uk-container">
197
              <div class="uk-grid">
198
                <div class="uk-width-1-3@s uk-width-1-4@m uk-width-1-4@l uk-visible@m" >
199
                      <ul class="uk-nav-default uk-nav-parent-icon" uk-nav="multiple: false" uk-sticky="offset: 100; media:@s" >
200
                          <li class="uk-parent uk-open">
201
                              <a href="#">Authentication</a>
202
                              <ul class="uk-nav-sub">
203
                                  <li><b><a href="./authentication.html">General Information</a></b></li>
204
                                  <li><a href="./personalToken.html">Personal Token</a></li>
205
                                  <li><a href="./registeredService.html">Registered Services</a></li>
206
                              </ul>
207
                          </li>
208
                      </ul>
209
                </div>
210

  
211

  
212
                <div   class="tm-main uk-width-expand uk-row-first uk-first-column">
213
                  <p>
214
                    The OpenAIRE APIs can be accessed over HTTPS both by authenticated and unauthenticated requests. To achieve better rate 
215
                    limits you need to make authenticated requests. 
216
                    
217
                    <table class="uk-table uk-table-divider uk-table-striped">
218
                     <thead>
219
                         <tr>
220
                             <th colspan="2" class="uk-text-center">OpenAIRE APIs Rate limits</th>
221
                         </tr>
222
                     </thead>
223
                     <tbody>
224
                         <tr>
225
                             <td>Not authenticated requests</td>
226
                             <td>up to 60 requests per hour</td>
227
                         </tr>
228
                         <tr>
229
                           <td>Authenticated requests</td>
230
                           <td>up to 2500 request per hour</td>
231
                         </tr>
232
                     </tbody>
233
                 </table>
234
                    OpenAIRE APIs can be used for both authentication and authorization. Our OAuth 2.0 implementation, conforms to the 
235
                    OpenID Connect specification, and is <a href="https://openid.net/certification/" target="_blank">OpenID Certified</a>. 
236
                    OpenID Connect is a simple identity layer on top of the OAuth 2.0 protocol. For more information about OAuth2.0 please 
237
                    visit the <a href="https://oauth.net/2/" target="_blank">OAuth2.0 official site</a>. For more information about OpenID 
238
                    Connect please visit the <a href="https://openid.net/connect/" target="_blank">OpenID Connect official site</a>. 
239
                  </p>
240

  
241
                   <h4>Requests</h4>
242

  
243
                   <p>To access the OpenAIRE APIs with better rate limits, send your access token using the Authorization header.</p>
244

  
245
                   <pre><code>
246
                     GET https://api-test.openaire.eu/{resourceServicePath}
247
                     Authorization: Bearer {ACCESS_TOKEN}
248
                  </code></pre>
249
 
250
                   <p>To get an access token, we support <a href="./personalToken.html"><b>personal access token</b></a> creation and 
251
                     <a href="./registeredService.html"><b>service registration</b></a>.</p>
252

  
253

  
254
                  <h4>Response Headers</h4>
255
                  <table class="uk-table uk-table-divider uk-table-striped">
256
                     <tbody>
257
                         <tr>
258
                             <td>x-ratelimit-limit</td>
259
                             <td>The maximum number of requests available in the current time frame.</td>
260
                         </tr>
261
                         <tr>
262
                           <td>x-ratelimit-used</td>
263
                           <td>The number of requests already mabe by a client in the current time frame.</td>
264
                         </tr>
265
                     </tbody>
266
                 </table>
267

  
268
                 <p>The time frame is one hour.</p>
269

  
270

  
271
                  <h4>Error Messages</h4>
272
                  <p>404 - Not found</p> <!--404-->
273
                  <pre>
274
                     <code>
275
                        {
276
                           "error": "Not found",
277
                           "description": "Invald request path."
278
                       }
279
                     </code>
280
                  </pre>
281

  
282
                  <p>403 - Invalid Access Token</p> <!--403-->
283
                  <pre>
284
                     <code>
285
                           {
286
                              "error": "Token invalid",
287
                              "description": "Authorization header value invalid."
288
                          }
289
                     </code>
290
                  </pre>
291

  
292
                  <p>429 - Rate limit abuse for unauthenticated user</p> <!--429-->
293
                  <pre>
294
                     <code>
295
                           {
296
                              "error": "Too many requests",
297
                              "description": "Request rate exceeded. Slow down."
298
                          }
299
                     </code>
300
                  </pre>
301

  
302
                  <p>429 - Rate limit abuse</p> <!--429-->
303
                  <pre>
304
                     <code>
305
                           {
306
                              "error": "Too many requests",
307
                              "description": "Request rate exceeded. Slow down."
308
                          }
309
                     </code>
310
                  </pre>
311
            </div> <DO NOT REMOVE>
312
          </div>
313
        </div>
314
      </div>
315
         <!-- FOOTER STARTS HERE-->
316
         <!-- <div class="uk-section-primary uk-preserve-color uk-section uk-section-small uk-padding-remove-bottom">
317
           <div class="uk-container uk-container-expand">
318
              <div class="uk-grid-large uk-grid-margin-large uk-grid" uk-grid="">
319
                 <div class="uk-width-auto@m uk-light uk-first-column">
320
                    <div id="footer#4" class="newsletter uk-margin uk-margin-remove-bottom uk-text-left uk-panel">
321
                       <h6 class="el-title uk-margin uk-h2">
322
                          Newsletter
323
                       </h6>
324
                       <a target="_blank" href="https://www.openaire.eu/newsletter/view" class="el-link">
325
                          <span   class="el-image uk-icon">
326
                             <svg width="30" height="30" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
327
                                <circle cx="3.12" cy="16.8" r="1.85"></circle>
328
                                <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>
329
                                <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>
330
                             </svg>
331
                          </span>
332
                       </a>
333
                    </div>
334
                 </div>
335
                 <div class="uk-width-expand@m uk-light">
336
                    <div id="footer#7" class="uk-text-right@m uk-text-center">
337
                       <ul class="uk-subnav uk-margin-remove-bottom uk-subnav-divider uk-flex-right@m uk-flex-center" uk-margin="">
338
                          <li class="el-item uk-first-column">
339
                             <a class="el-link" target="_blank" href="https://www.openaire.eu/about">About</a>
340
                          </li>
341
                          <li class="el-item">
342
                             <a class="el-link" href="http://catalogue.openaire.eu" target="_blank">Services</a>
343
                          </li>
344
                          <li class="el-item">
345
                             <a class="el-link" target="_blank" href="https://www.openaire.eu/support">Support</a>
346
                          </li>
347
                          <li class="el-item">
348
                             <a class="el-link" target="_blank" href="https://www.openaire.eu/news">News</a>
349
                          </li>
350
                          <li class="el-item">
351
                             <a class="el-link" target="_blank" href="https://www.openaire.eu/events">Events</a>
352
                          </li>
353
                          <li class="el-item">
354
                             <a class="el-link" target="_blank" href="https://www.openaire.eu/documents">Documents</a>
355
                          </li>
356
                       </ul>
357
                    </div>
358
                 </div>
359
                 <div class="uk-width-auto@m uk-grid-item-match">
360
                    <div class="uk-tile-primary uk-preserve-color uk-tile uk-padding-remove">
361
                       <div id="footer#9" class="uk-margin uk-text-right@m uk-text-center">
362
                          <a class="el-content uk-button uk-button-default uk-button-small" target="_blank" href="https://www.openaire.eu/contact-us" target="_blank">
363
                          Contact us
364
                          </a>
365
                       </div>
366
                    </div>
367
                 </div>
368
              </div>
369
           </div>
370
        </div>
371
        <div class="uk-section-primary uk-section uk-section-xsmall uk-padding-remove-bottom">
372
           <div class="uk-container uk-container-expand">
373
              <div class="uk-margin-small uk-grid uk-grid-stack" uk-grid="">
374
                 <div class="uk-width-1-1@m uk-first-column">
375
                    <div class="uk-margin-large uk-margin-remove-top uk-text-center@m uk-text-center">
376
                       <img src="assets/Logo_Horizontal_white_small.png"   sizes="(min-width: 126px) 126px" data-width="126" data-height="30" class="el-image" alt="OpenAIRE">
377
                    </div>
378
                 </div>
379
              </div>
380
              <div class="uk-flex-middle uk-margin-remove-vertical uk-grid" uk-grid="">
381
                 <div class="uk-width-small@m uk-first-column">
382
                    <div id="footer#16" class="uk-margin-medium uk-text-left@m uk-text-center uk-margin-small-bottom">
383
                       <img src="assets/commission.jpg" sizes="(min-width: 50px) 50px" data-width="427" data-height="285" class="el-image" alt="European Commission">
384
                    </div>
385
                 </div>
386
                 <div class="uk-width-expand@m">
387
                    <div id="footer#18" class=" uk-text-small uk-margin uk-margin-remove-bottom uk-text-center uk-text-lead">
388
                       <a href="http://creativecommons.org/licenses/by/4.0/" rel="license">
389
                          <img src="/images/Icons/cc.svg" uk-svg="" hidden="true">
390
                          <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" width="24" height="24" class=" uk-svg">
391
                             <title></title>
392
                             <g data-name="Creative Commons" id="Creative_Commons">
393
                                <circle cx="12" cy="12" r="11.5" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></circle>
394
                                <path d="M10.87,10a3.5,3.5,0,1,0,0,4" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></path>
395
                                <path d="M18.87,10a3.5,3.5,0,1,0,0,4" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></path>
396
                             </g>
397
                          </svg>
398
                          &nbsp;<img src="/images/Icons/cc-by.svg" uk-svg="" hidden="true">
399
                          <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" width="24" height="24" class=" uk-svg">
400
                             <title></title>
401
                             <g id="Attribution">
402
                                <g data-name="<Group>" id="_Group_">
403
                                   <circle cx="12" cy="5" data-name="<Path>" id="_Path_" r="1.5" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></circle>
404
                                   <path d="M12,8a5,5,0,0,0-3.07.71,1,1,0,0,0-.43.83V15H10v5.5h4V15h1.5V9.54a1,1,0,0,0-.43-.83A5,5,0,0,0,12,8Z" data-name="<Path>" id="_Path_2" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></path>
405
                                </g>
406
                                <circle cx="12" cy="12" r="11.5" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></circle>
407
                             </g>
408
                          </svg>
409
                       </a>
410
                       &nbsp;Unless otherwise indicated, all materials created by OpenAIRE are licenced under&nbsp;<a href="http://creativecommons.org/licenses/by/4.0/" rel="license">CC ATTRIBUTION 4.0 INTERNATIONAL LICENSE</a>.
411
                    </div>
412
                 </div>
413
                 <div class="uk-width-small@m">
414
                    <div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-right@m uk-text-center">
415
                       <a href="#" uk-totop="" uk-scroll="" class="uk-totop uk-icon">
416
                       </a>
417
                    </div>
418
                 </div>
419
              </div>
420
           </div>
421
        </div> -->
422
        <div class="uk-section-primary uk-section uk-section-small uk-padding-remove-bottom">
423
     <div class="uk-container uk-container-expand">
424
        <div class="uk-container uk-container-expand uk-margin-small">
425
           <div class="uk-grid-collapse uk-grid" uk-grid="">
426
              <div id="footer#3" class="uk-width-expand@s uk-first-column">
427
                 <div class="uk-margin-small uk-margin-remove-top uk-text-left@s uk-text-center">
428
                    <img src="assets/Logo_Horizontal_white_small.png"   data-width="126" data-height="30" class="el-image" alt="OpenAIRE">
429
                 </div>
430
                 <div id="footer#5" class="uk-margin uk-text-left@s uk-text-center">
431
                    <img src="assets/commission.jpg"   sizes="(min-width: 50px) 50px" data-width="427" data-height="285" class="el-image" alt="European Commission">
432
                 </div>
433
                 <div id="footer#6" class="newsletter uk-margin uk-margin-remove-bottom uk-text-left@s uk-text-center uk-panel">
434
                    <h5 class="el-title uk-margin uk-h5">
435
                       Newsletter
436
                    </h5>
437
                    <a target="_blank" href="https://www.openaire.eu/newsletter/view" class="el-link">
438
                       <span   class="el-image uk-icon">
439
                          <svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
440
                             <circle cx="3.12" cy="16.8" r="1.85"></circle>
441
                             <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>
442
                             <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>
443
                          </svg>
444
                       </span>
445
                    </a>
446
                 </div>
447
                 <div id="footer#7" class="newsletter uk-margin-small uk-margin-remove-top uk-text-left@s uk-text-center uk-panel">
448

  
449
                    <div class="acymailing_module" id="acymailing_module_formAcymailing60611">
450
                       <div class="acymailing_mootoolsbutton" id="acymailing_toggle_formAcymailing60611">
451
                          <p><a class="acymailing_togglemodule" id="acymailing_togglemodule_formAcymailing60611" target="_blank" href="https://www.openaire.eu/newsletter/view">Subscribe</a></p>
452

  
453
                       </div>
454
                    </div>
455
                 </div>
456
                 <div class="uk-margin-small uk-margin-remove-top uk-text-left@s uk-text-center">
457
                    <div class="uk-child-width-auto uk-grid-small uk-flex-left@s uk-flex-center uk-grid" uk-grid="">
458
                       <div class="uk-first-column">
459
                          <a  href="http://www.facebook.com/groups/openaire/" target="_blank" class="el-link uk-icon-button uk-icon">
460
                             <svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
461
                                <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>
462
                             </svg>
463
                          </a>
464
                       </div>
465
                       <div>
466
                          <a  href="http://www.twitter.com/OpenAIRE_eu" target="_blank" class="el-link uk-icon-button uk-icon">
467
                             <svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
468
                                <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>
469
                             </svg>
470
                          </a>
471
                       </div>
472
                       <div>
473
                          <a  href="http://www.linkedin.com/groups/OpenAIRE-3893548" target="_blank" class="el-link uk-icon-button uk-icon">
474
                             <svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
475
                                <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>
476
                                <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>
477
                             </svg>
478
                          </a>
479
                       </div>
480
                       <div>
481
                          <a  href="http://www.slideshare.net/OpenAIRE_eu" target="_blank" class="el-link uk-icon-button uk-icon">
482
                             <svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
483
                                <line fill="none" stroke="#000" stroke-width="1.1" x1="13.4" y1="14" x2="6.3" y2="10.7"></line>
484
                                <line fill="none" stroke="#000" stroke-width="1.1" x1="13.5" y1="5.5" x2="6.5" y2="8.8"></line>
485
                                <circle fill="none" stroke="#000" stroke-width="1.1" cx="15.5" cy="4.6" r="2.3"></circle>
486
                                <circle fill="none" stroke="#000" stroke-width="1.1" cx="15.5" cy="14.8" r="2.3"></circle>
487
                                <circle fill="none" stroke="#000" stroke-width="1.1" cx="4.5" cy="9.8" r="2.3"></circle>
488
                             </svg>
489
                          </a>
490
                       </div>
491
                       <div>
492
                          <a href="https://www.youtube.com/channel/UChFYqizc-S6asNjQSoWuwjw" target="_blank" class="el-link uk-icon-button uk-icon">
493
                             <svg width="20" height="20" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
494
                                <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>
495
                             </svg>
496
                          </a>
497
                       </div>
498
                    </div>
499
                 </div>
500
              </div>
501
              <div id="footer#9" class="uk-width-expand@s">
502
                 <div id="footer#10" class="uk-width-medium uk-text-left@s uk-text-center uk-panel">
503
                    <h3 class="el-title uk-h6">Dashboards</h3>
504
                    <ul class="uk-nav uk-nav-default uk-nav-parent-icon uk-nav-accordion" uk-nav="">
505
                       <li><a href="https://explore.openaire.eu" target="_blank">Explore</a></li>
506
                       <li><a href="https://provide.openaire.eu" target="_blank">Provide</a></li>
507
                       <li><a href="https://connect.openaire.eu/" target="_blank">Connect</a></li>
508
                       <li><a href="https://monitor.openaire.eu" target="_blank">Monitor</a></li>
509
                       <li><a href="https://develop.openaire.eu" target="_blank">Develop</a></li>
510
                    </ul>
511
                 </div>
512
              </div>
513
              <div id="footer#11" class="uk-width-expand@s">
514
                 <div id="footer#12" class="uk-width-medium uk-text-left@s uk-text-center uk-panel">
515
                    <h3 class="el-title uk-h6">Support</h3>
516
                    <ul class="uk-nav uk-nav-default uk-nav-parent-icon uk-nav-accordion" uk-nav="">
517
                       <li><a target="_blank" href="https://www.openaire.eu/guides">Guides</a></li>
518
                       <li><a target="_blank" href="https://www.openaire.eu/faqs">FAQs</a></li>
519
                       <li><a target="_blank" href="https://www.openaire.eu/frontpage/webinars">Webinars</a></li>
520
                       <li><a target="_blank" href="https://www.openaire.eu/support/helpdesk">Ask a question</a></li>
521
                    </ul>
522
                 </div>
523
              </div>
524
              <div id="footer#13" class="uk-width-expand@s">
525
                 <div id="footer#14" class="uk-width-medium uk-text-left@s uk-text-center uk-panel">
526
                    <h3 class="el-title uk-h6">Updates</h3>
527
                    <ul class="uk-nav uk-nav-default uk-nav-parent-icon uk-nav-accordion" uk-nav="">
528
                       <li><a target="_blank" href="https://www.openaire.eu/news/">News</a></li>
529
                       <li><a target="_blank" href="https://www.openaire.eu/events">Events</a></li>
530
                       <li><a target="_blank" href="https://www.openaire.eu/blogs/magazine">Blogs</a></li>
531
                       <li><a target="_blank" href="https://www.openaire.eu/documents">Documents</a></li>
532
                    </ul>
533
                 </div>
534
              </div>
535
           </div>
536
        </div>
537
     </div>
538
  </div>
539
  <div class="uk-section-primary uk-section uk-section-xsmall">
540
   <div class="uk-container">
541
      <div class="uk-grid-margin uk-grid uk-grid-stack" uk-grid="">
542
         <div class="uk-width-expand@m">
543
         </div>
544
      </div>
545
   </div>
546
</div>
547
<div class="uk-section-primary uk-section uk-section-xsmall">
548
   <div class="uk-container uk-container-expand">
549
      <div class="uk-grid-margin uk-grid" uk-grid="">
550
         <div class="uk-width-small@m uk-first-column">
551
         </div>
552
         <div class="uk-width-expand@m">
553
            <div id="footer#22" class=" uk-text-small uk-margin uk-margin-remove-bottom uk-text-center@m uk-text-center uk-text-lead">
554
               <a href="http://creativecommons.org/licenses/by/4.0/" rel="license">
555
                  <img src="/images/Icons/cc.svg" uk-svg="" hidden="true">
556
                  <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" width="24" height="24" class=" uk-svg">
557
                     <title></title>
558
                     <g data-name="Creative Commons" id="Creative_Commons">
559
                        <circle cx="12" cy="12" r="11.5" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></circle>
560
                        <path d="M10.87,10a3.5,3.5,0,1,0,0,4" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></path>
561
                        <path d="M18.87,10a3.5,3.5,0,1,0,0,4" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></path>
562
                     </g>
563
                  </svg>
564
                  &nbsp;<img src="/images/Icons/cc-by.svg" uk-svg="" hidden="true">
565
                  <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" width="24" height="24" class=" uk-svg">
566
                     <title></title>
567
                     <g id="Attribution">
568
                        <g data-name="<Group>" id="_Group_">
569
                           <circle cx="12" cy="5" data-name="<Path>" id="_Path_" r="1.5" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></circle>
570
                           <path d="M12,8a5,5,0,0,0-3.07.71,1,1,0,0,0-.43.83V15H10v5.5h4V15h1.5V9.54a1,1,0,0,0-.43-.83A5,5,0,0,0,12,8Z" data-name="<Path>" id="_Path_2" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></path>
571
                        </g>
572
                        <circle cx="12" cy="12" r="11.5" style="fill:none;stroke:#ffffff;stroke-linecap:round;stroke-linejoin:round"></circle>
573
                     </g>
574
                  </svg>
575
               </a>
576
               &nbsp;Unless otherwise indicated, all materials created by OpenAIRE are licenced under&nbsp;<a href="http://creativecommons.org/licenses/by/4.0/" rel="license">CC ATTRIBUTION 4.0 INTERNATIONAL LICENSE</a>.
577
            </div>
578
         </div>
579
         <div class="uk-width-small@m">
580
            <div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-right@m uk-text-center">
581
               <a href="#" uk-totop="" uk-scroll="" class="uk-totop uk-icon">
582

  
583
               </a>
584
            </div>
585
         </div>
586
      </div>
587
   </div>
588
</div>
589
      <!--/div-->
590
      </div>
591
   </body>
592
</html>
modules/dnet-api-http-doc/branches/auth-broker/basic.html
1

  
2

  
3
<!DOCTYPE html>
4
<html lang="en-gb">
5
   <head>
6
      <!--link href="http://demo.openaire.eu" rel="canonical" /-->
7
      <meta charset="utf-8">
8
      <meta http-equiv="X-UA-Compatible" content="IE=edge">
9
      <meta name="viewport" content="width=device-width, initial-scale=1">
10
      <meta http-equiv="content-type" content="text/html; charset=utf-8" />
11
      <meta name="description" content="OpenAIRE API documentation, open access, research, scientific publication, European Commission, EC, FP7, ERC,
12
      Horizon 2020, H2020, search, projects, publications, research data, datasets, HTTP, funders "/>
13
      <link href="./assets/favicon.ico" rel="shortcut icon" />
14
      <title>OpenAIRE API documentation - Authentication Registered Services (Basic)</title>
15
      <script  src="./assets/jquery.js"></script>
16
      <script  src="./assets/uikit.js"></script>
17
      <script src="./assets/uikit-icon-max.js"></script>
18
      <link rel="stylesheet" type="text/css" href="./assets/theme.css">
19
      <link rel="stylesheet" type="text/css" href="./assets/custom.css">
20
      <link rel="stylesheet" type="text/css" href="./assets/develop-custom.css">
21

  
22
   </head>
23
   <body>
24
      <div class="uk-offcanvas-content uk-height-viewport">
25
        <div class="tm-header-mobile uk-hidden@m">
26
          <div animation="uk-animation-slide-top" class="uk-navbar-container uk-sticky  uk-navbar-transparent" cls-active="uk-active uk-navbar-sticky" cls-inactive="uk-navbar-transparent" uk-sticky="">
27
           <nav class="uk-navbar-container uk-navbar" uk-navbar="">
28
              <div class="uk-navbar-left">
29
                 <a class="uk-navbar-toggle" href="#tm-mobile" uk-toggle="">
30
                    <div uk-navbar-toggle-icon="" class="uk-navbar-toggle-icon uk-icon">
31

  
32
                    </div>
33
                 </a>
34
              </div>
35
              <div class="uk-navbar-center">
36
                 <a class="uk-navbar-item uk-logo" href="overview.html">
37
                 <img src="assets/OA DEVELOP_A.png" class="uk-responsive-height" alt="OpenAIRE">        </a>
38
              </div>
39
           </nav>
40
           <div id="tm-mobile" uk-offcanvas="" mode="slide" overlay="" class="uk-offcanvas">
41
              <div class="uk-offcanvas-bar">
42
                 <button class="uk-offcanvas-close uk-close uk-icon" type="button" uk-close="">
43
                 </button>
44
                 <div class="uk-child-width-1-1 uk-grid" uk-grid="">
45
                    <div>
46
                       <div class="uk-panel" id="module-0">
47
                          <ul class="uk-nav uk-nav-default">
48
                            <li class="uk-nav-header uk-parent" >
49
                              Dashboards
50
                              <ul class="uk-nav-sub">
51
                            		<li><a href="https://explore.openaire.eu" target="_blank" class="uk-heading-bullet explore-heading-bullet">EXPLORE</a></li>
52
                            		<li><a href="https://provide.openaire.eu" target="_blank" class="uk-heading-bullet provide-heading-bullet">PROVIDE</a></li>
53
                            		<li><a href="https://connect.openaire.eu" target="_blank" class="uk-heading-bullet connect-heading-bullet">CONNECT</a></li>
54
                            		<li><a href="https://monitor.openaire.eu" target="_blank" class="uk-heading-bullet monitor-heading-bullet">MONITOR</a></li>
55
                               </ul>
56
                            </li>
57
                             <li class="uk-nav-header uk-parent">
58
                                <a href="./overview.html"> Overview </a>
59

  
60
                             </li>
61
                             <li class="uk-nav-header uk-parent uk-active">
62
                                 Authentication
63
                                 <ul class="uk-nav-sub">
64
                                    <li><a routerLinkActive="uk-link" href="./authentication.html" >General Information</a></li>
65
                                    <li><a routerLinkActive="uk-link" href="./personalToken.html" >Personal Token</a></li>
66
                                    <li><a routerLinkActive="uk-link" href="./registeredService.html">Registered Services</a>
67
                                       <ul class="uk-nav-sub">
68
                                          <li><a routerLinkActive="uk-link" href="./basic.html">Basic</a></li>
69
                                          <li><a routerLinkActive="uk-link" href="./advanced.html">Advanced</a></li>
70
                                       </ul>
71
                                    </li>
72
                                 </ul>                                 
73
                              </li>
74
                              <li class="uk-nav-header uk-parent">
75
                               Bulk access
76
                               <ul class="uk-nav-sub">
77
                                   <li><a routerLinkActive="uk-link" href="./graph-dumps.html" >OpenAIRE Research Graph Dumps</a></li>
78
                                  <li><a routerLinkActive="uk-link" href="./oai-pmh.html" >OAI-PMH (discontinued)</a></li>
79
                                  <li><a routerLinkActive="uk-link" href="./bulk-projects.html" >Bulk access to projects</a></li>
80
                               </ul>
81
                             </li>
82
                              <li class="uk-nav-header uk-parent">
83
                               <a href="./api.html">Selective access</a>
84
                                <ul class="uk-nav-sub">
85
                                 <li><a href="./api.html#pubs" >Publications</a></li>
86
                                 <li><a href="./api.html#datasets" >Research Data</a></li>
87
                                  <li><a href="./api.html#software" >Software</a></li>
88
                                  <li><a href="./api.html#other" >Other Research Products</a></li>
89
                                 <li><a href="./api.html#projects" >Projects</a></li>
90
                               </ul>
91
                             </li>
92
                          </ul>
93
                       </div>
94
                    </div>
95
                 </div>
96
              </div>
97
           </div>
98
        </div>
99
       </div>
100
        <!--Mobile ENDS here -->
101
        <div class="tm-toolbar custom-develop-toolbar uk-visible@m">
102
           <div class="uk-container uk-flex uk-flex-middle uk-container-expand ">
103
              <div class="uk-margin-auto-left">
104
                 <div class="uk-grid-medium uk-child-width-auto uk-flex-middle uk-grid uk-grid-stack" uk-grid="margin: uk-margin-small-top">
105
                    <div class="uk-first-column">
106
                       <div class="uk-panel inner" id="module-119">
107
                          <ul class="uk-subnav">
108
                            <li class="line"><a href="https://www.openaire.eu"><img class="uk-responsive-height" src="assets/Home_24white.svg" alt="home"/></a></li>
109
                            <li class="line"><a href="https://explore.openaire.eu" title="Search in OA. Link your research">Explore</a></li>
110
                            <li class="line"><a href="https://provide.openaire.eu" title="Content Provider Dashboard">Provide</a></li>
111
                            <li class="line"><a href="https://connect.openaire.eu" title="Research Community Dashboard">Connect</a></li>
112
                            <li class="line"><a href="https://monitor.openaire.eu" title="Monitoring Dashboard">Monitor</a></li>
113
                            <li class="line custom-develop-li "><a href="overview.html" title="APIs">Develop</a></li>
114
                          </ul>
115
                       </div>
116
                    </div>
117
                 </div>
118
              </div>
119
           </div>
120
        </div>
121
        <div class="tm-header uk-visible@m tm-header-transparent" uk-header="">
122
          <div animation="uk-animation-slide-top" class="uk-navbar-container uk-sticky uk-navbar-transparent" cls-active="uk-active uk-navbar-sticky" cls-inactive="uk-navbar-transparent"   top=".tm-header + [class*=&quot;uk-section&quot;]" uk-sticky="">
123
              <div class="uk-navbar-container uk-navbar-transparent">
124
                 <div class="uk-container uk-container-expand">
125
                    <nav class="uk-navbar" uk-navbar="{&quot;align&quot;:&quot;left&quot;}">
126
                       <div class="uk-navbar-left">
127
                          <a href="overview.html" class="uk-navbar-item uk-logo">
128
                          <img src="assets/OA DEVELOP_B.png" class="uk-responsive-height" alt="OpenAIRE"></a>
129
                       </div>
130
                       <div class="uk-navbar-right">
131
                          <ul class="uk-navbar-nav">
132
                             <li class="uk-parent">
133
                                <a href="overview.html" class="" aria-expanded="false">Overview</a>
134
                             </li>
135

  
136
                              <li class="uk-parent uk-active">
137
                                 <a href="#" class="" aria-expanded="false">Authentication</a>
138
                                 <div class="uk-navbar-dropdown uk-navbar-dropdown-bottom-left" style="left: 116px; top: 80px;">
139
                                    <div class="uk-navbar-dropdown-grid uk-child-width-1-1 uk-grid uk-grid-stack" uk-grid="">
140
                                       <div class="uk-first-column">
141
                                          <ul class="uk-nav uk-navbar-dropdown-nav">
142
                                             <li><a routerLinkActive="uk-link" href="./authentication.html" >General Information</a></li>
143
                                             <li><a routerLinkActive="uk-link" href="./personalToken.html" >Personal Token</a></li>
144
                                             <li><a routerLinkActive="uk-link" href="./registeredService.html">Registered Services</a></li>                                                                                      
145
                                          </ul>                                 
146
                                       </div>
147
                                    </div>
148
                                 </div>
149
                              </li>
150
                             <li class="uk-parent">
151
                                <a href="#" class="" aria-expanded="false">Bulk access</a>
152
                                <div class="uk-navbar-dropdown uk-navbar-dropdown-bottom-left" style="left: 116px; top: 80px;">
153
                                   <div class="uk-navbar-dropdown-grid uk-child-width-1-1 uk-grid uk-grid-stack" uk-grid="">
154
                                      <div class="uk-first-column">
155
                                         <ul class="uk-nav uk-navbar-dropdown-nav">
156
                                            <li><a routerLinkActive="uk-link" href="./graph-dumps.html" >OpenAIRE Research Graph Dumps</a></li>
157
                                           <li><a routerLinkActive="uk-link" href="./oai-pmh.html" >OAI-PMH (discontinued)</a></li>
158
                                           <li><a routerLinkActive="uk-link" href="./bulk-projects.html" >Bulk access to projects</a></li>
159
                                         </ul>
160
                                      </div>
161
                                   </div>
162
                                </div>
163
                             </li>
164
                             <li class="uk-parent">
165
                                <a href="#" class="" aria-expanded="false">Selective access</a>
166
                                <div class="uk-navbar-dropdown uk-navbar-dropdown-bottom-left" style="left: 228px; top: 80px;">
167
                                   <div class="uk-navbar-dropdown-grid uk-child-width-1-1 uk-grid uk-grid-stack" uk-grid="">
168
                                      <div class="uk-first-column">
169
                                         <ul class="uk-nav uk-navbar-dropdown-nav">
170
                                           <li><a href="./api.html#pubs" >Publications</a></li>
171
                                           <li><a href="./api.html#datasets" >Research Data</a></li>
172
                                            <li><a href="./api.html#software" >Software</a></li>
173
                                            <li><a href="./api.html#other" >Other Research Products</a></li>
174
                                           <li><a href="./api.html#projects" >Projects</a></li>
175
                                         </ul>
176
                                      </div>
177
                                   </div>
178
                                </div>
179
                             </li>
180

  
181
                          </ul>
182
                       </div>
183

  
184
                    </nav>
185
                 </div>
186
              </div>
187
           </div>
188
         </div>
189

  
190
         <div class=" first_page_section uk-section-default uk-section uk-padding-remove-vertical">
191
            <div class="first_page_banner_headline uk-grid-collapse uk-flex-middle uk-margin-remove-vertical uk-grid" uk-grid="">
192
            </div>
193
         </div>
194

  
195
         <div   class=" uk-section uk-margin-large-top tm-middle custom-main-content" id="tm-main">
196
            <div class="uk-container">
197
              <div class="uk-grid">
198
                <div class="uk-width-1-3@s uk-width-1-4@m uk-width-1-4@l uk-visible@m" >
199
                     <ul class="uk-nav-default uk-nav-parent-icon" uk-nav="multiple: false" uk-sticky="offset: 100; media:@s" >
200
                           <li class="uk-parent uk-open">
201
                               <a href="#">Authentication</a>
202
                               <ul class="uk-nav-sub">
203
                                   <li><a href="./authentication.html">General Information</a></li>
204
                                   <li><a href="./personalToken.html">Personal Token</a></li>
205
                                   <li><a href="./registeredService.html">Registered Services</a>
206
                                    <ul class="uk-nav-sub">
207
                                       <li class="uk-active"><b><a href="./basic.html">Basic</a></b></li>
208
                                       <li><a href="./advanced.html">Advanced</a></li>
209
                                   </ul>
210
                                 </li>
211
                               </ul>
212
                           </li>
213
                       </ul>
214
                </div>
215

  
216

  
217
                <div   class="tm-main uk-width-expand uk-row-first uk-first-column">
218

  
219
                  <h2 id="service">Basic service authentication and registration</h2>               
220
                 
221
                  <p>For the <b>Basic Authentication</b> method the OpenAIRE AAI server generates a pair of <em>Client ID</em> and <em>Client Secret</em> 
222
                     for your service upon its registration. The service uses the client id and client secret to obtain the access 
223
                     token for the OpenAIRE APIs. The OpenAIRE AAI server checks whether the client id and client secret sent is valid.
224
                  </p> 
225
                  
226
                  <h4>How to register your service</h4>
227
                  <p>To register your service you need to:</p>
228
                  <ol>
229
                     <li>Login to OpenAIRE. In case you are not already a member you will need to register first.</li>
230
                     <li>Go to your <a href="https://beta.services.openaire.eu/uoa-user-management/registeredServices" target="_blank"> Registered Services</a> page and click the New Service button.</li>
231
                     <li>Provide the <span class="uk-text-primary"><b>"╬Łame"</b></span> (mandatory) of your service.</li>
232
                     <li>Select the Basic <span class="uk-text-primary"><b>"Security level"</b></span>.</li>
233
                     <li>Click the <span class="uk-text-primary"><b>Add New Service</b></span> button.</li>
234
                  </ol>
235
                  <p>Once your service is created, the <em>Client ID</em> and <em>Client Secret</em> will appear on your screen. Click 
236
                     <span class="uk-text-primary">"OK"</span> and your new service will be appear in the list of your <a href="https://beta.services.openaire.eu/uoa-user-management/registeredServices" target="_blank">Registered Services</a> page.</p>
237

  
238
                  <h4>How to make a request</h4>
239
                  <h5>Step 1. Request for an access token</h5>
240
                  <p>
241
                     To make an access token request use the <em>Client ID</em> and <em>Client Secret</em> of your service.
242

  
243
                     <pre>
244
                        <code>
245
                              curl -u {CLIENT_ID}:{CLIENT_SECRET} \
246
                              -X POST 'https://aai.openaire.eu/oidc/token' \
247
                              -d 'grant_type=client_credentials'                              
248
                        </code>
249
                     </pre>
250
                     <p>where <b>{CLIENT_ID}</b> and <b>{CLIENT_SECRET}</b> are the <em>Client ID</em> and <em>Client Secret</em> assigned to your service 
251
                        upon registration.
252
                     <p>
253
                        The response is:
254
                        <pre>
255
                              <code>
256
                                    {
257
                                       "access_token": ...,
258
                                       "token_type": "Bearer",
259
                                       "expires_in": ...
260
                                   }
261
                              </code>
262
                           </pre>
263
                     </p>
264
                  </p>
265
                  <div class="uk-alert-danger" uk-alert>
266
                        <p>Store the access token confidentially on the service side.</p>
267
                     </div>
268
                  
269
                  <h5>Step 2. Make a request</h5>
270
                  <p>To access the OpenAIRE APIs send the access token returned in <span class="uk-text-primary"><b>Step 1</b></span>.</p>
271

  
272
                  <pre>
273
                        <code>
274
                              GET https://api-test.openaire.eu/{resourceServicePath}
275
                              Authorization: Bearer {ACCESS_TOKEN}
276
                        </code>
277
                     </pre>
278
                  
279

  
280
                  <h4>Error messages</h4>
281
                  
282
                  <p>401 - Missing username or/and password</p>
283
                  <pre>
284
                     <code>
285
                           {
286
                              "error": "unauthorized",
287
                              "error_description": "Client id must not be empty!"
288
                          }
289
                     </code>
290
                  </pre>
291
                  
292
                  <p>401 - Wrong username or/and password</p>
293
                  <pre>
294
                     <code>
295
                           {
296
                              "error": "unauthorized",
297
                              "error_description": "Bad credentials"
298
                          }
299
                     </code>
300
                  </pre>
301
                  
302
                  <p>400 - Missing grant type</p>
303
                  <pre>
304
                     <code>
305
                           {
306
                              "error": "invalid_request",
307
                              "error_description": "Missing grant type"
308
                          }
309
                     </code>
310
                  </pre>
311

  
312
                  <p>400 - Wrong grant type</p>
313
                  <pre>
314
                     <code>
315
                           {
316
                              "error": "unsupported_grant_type",
317
                              "error_description": "Unsupported grant type: ..."
318
                          }
319
                     </code>
320
                  </pre>
321
            </div> <DO NOT REMOVE>
322
          </div>
323
        </div>
324
      </div>
325
         <!-- FOOTER STARTS HERE-->
326
         <!-- <div class="uk-section-primary uk-preserve-color uk-section uk-section-small uk-padding-remove-bottom">
327
           <div class="uk-container uk-container-expand">
328
              <div class="uk-grid-large uk-grid-margin-large uk-grid" uk-grid="">
329
                 <div class="uk-width-auto@m uk-light uk-first-column">
330
                    <div id="footer#4" class="newsletter uk-margin uk-margin-remove-bottom uk-text-left uk-panel">
331
                       <h6 class="el-title uk-margin uk-h2">
332
                          Newsletter
333
                       </h6>
334
                       <a target="_blank" href="https://www.openaire.eu/newsletter/view" class="el-link">
335
                          <span   class="el-image uk-icon">
336
                             <svg width="30" height="30" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
337
                                <circle cx="3.12" cy="16.8" r="1.85"></circle>
... This diff was truncated because it exceeds the maximum size that can be displayed.

Also available in: Unified diff