Project

General

Profile

1

    
2

    
3
<!DOCTYPE html>
4
<html lang="en-gb" dir="ltr" vocab="http://schema.org/">
5
   <head>
6
      <meta charset="utf-8">
7
      <meta http-equiv="X-UA-Compatible" content="IE=edge">
8
      <meta name="viewport" content="width=device-width, initial-scale=1">
9
      <meta http-equiv="content-type" content="text/html; charset=utf-8" />
10
      <meta name="description" content="OpenAIRE API documentation, open access, research, scientific publication, European Commission,
11
      EC, FP7, ERC, Horizon 2020, H2020, search, projects "/>
12
      <link href="./assets/favicon.ico" />
13
      <title>OpenAIRE API Documentation</title>
14
      <script  src="./assets/jquery.js"></script>
15
      <script  src="./assets/uikit.js"></script>
16
      <script src="./assets/uikit-icon-max.js"></script>
17
      <link rel="stylesheet" type="text/css" href="./assets/theme.css">
18
      <link rel="stylesheet" type="text/css" href="./assets/custom.css">
19
      <link rel="stylesheet" type="text/css" href="./assets/custom.css.1">
20
   </head>
21
   <body class="" style="">
22
      <div class="uk-offcanvas-content uk-height-viewport">
23
        <!-- MENU STARTS HERE-->
24
         <!-- MAIN MENU  STARTS HERE-->
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 uk-light" cls-active="uk-active uk-navbar-sticky" cls-inactive="uk-navbar-transparent uk-light" 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="" style="z-index:1000;">
30
                   <div uk-navbar-toggle-icon="" class="uk-navbar-toggle-icon uk-icon custom-navbar-toggle-icon"> </div>
31
                </a>
32
             </div>
33
             <div class="uk-navbar-center uk-margin-left">
34
               <img src="./assets/apple-icon-72x72.png" alt="OpenAIRE" class="uk-responsive-height">
35
                <a class="uk-navbar-item uk-logo uk-padding-remove-left uk-visible@m" routerLinkActive="uk-link" routerLink="/" >
36
                OpenAIRE API Documentation</a>
37
                <a class="uk-navbar-item uk-logo uk-padding-remove-left uk-hidden@m" routerLinkActive="uk-link" routerLink="/" >
38
                API Documentation</a>
39
             </div>
40
          </nav>
41
          <div id="tm-mobile" uk-offcanvas="" mode="slide" overlay="" class="uk-offcanvas">
42
          <div class="uk-offcanvas-bar">
43
            <button class="uk-offcanvas-close uk-close uk-icon" type="button" uk-close=""></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 uk-active">
49
                          <a href="./overview.html"> Overview </a>
50
                       </li>
51
                        <li class="uk-nav-header uk-parent">
52
                           Bulk access
53
                           <ul class="uk-nav-sub">
54
                              <li><a routerLinkActive="uk-link" href="./oai-pmh.html" >OAI-PMH</a></li>
55
                              <li><a routerLinkActive="uk-link" href="./bulk-projects.html" >Bulk access to projects</a></li>
56
                           </ul>
57
                        </li>
58

    
59
                        <li class="uk-nav-header uk-parent">
60
                            <a href="./api.html">Selective access</a>
61
                            <ul class="uk-nav-sub">
62
                              <li><a href="./api.html#pubs" >Publications</a></li>
63
                              <li><a href="./api.html#datasets" >Research Data</a></li>
64
                              <li><a href="./api.html#projects" >Projects</a></li>
65
                           </ul>
66
                        </li>
67
                     </ul>
68
                  </div>
69
                </div>
70
              </div>
71
            </div>
72
          </div>
73
        </div>
74
      </div>
75
      <div class="tm-header uk-visible@m tm-header-transparent" uk-header=""><!-- top=".tm-header" + [class*=&quot;uk-section&quot;] -->
76
      <div animation="uk-animation-slide-top" class="uk-navbar-container uk-sticky  uk-navbar-transparent uk-light" cls-active="uk-active uk-navbar-sticky" cls-inactive="uk-navbar-transparent uk-light" media="768" uk-sticky="">
77
        <div class="uk-container uk-container-expand">
78
          <nav class="uk-navbar" uk-navbar="{&quot;align&quot;:&quot;left&quot;}" style="background-color:white !important;">
79
            <div class="uk-navbar-center">
80
              <div class="uk-logo uk-navbar-item uk-margin-small-top">
81
                <img alt="OpenAIRE" class="uk-responsive-height" src="./assets/Logo_Horizontal.png">
82
              </div>
83
              <div class="uk-logo uk-navbar-item uk-margin-medium-top">
84
                <h3 style="color: #767779 !important;"> API Documentation </h3>
85
              </div>
86
            </div>
87
            <div class="uk-navbar-right">
88
              <ul class="uk-navbar-nav uk-margin-small-top">
89
                <li class="uk-active">
90
                  <a href="#"><span class="uk-icon" uk-icon="icon: home"><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 20 20" ratio="1"> <polygon points="18.65 11.35 10 2.71 1.35 11.35 0.65 10.65 10 1.29 19.35 10.65"></polygon> <polygon points="15 4 18 4 18 7 17 7 17 5 15 5"></polygon> <polygon points="3 11 4 11 4 18 7 18 7 12 12 12 12 18 16 18 16 11 17 11 17 19 11 19 11 13 8 13 8 19 3 19"></polygon></svg></span></a>
91
                </li>
92
                <li>
93
                  <a href="#">Bulk access</a>
94
                  <div class="uk-navbar-dropdown">
95
                    <ul class="uk-nav uk-navbar-dropdown-nav">
96
                      <li><a href="./oai-pmh.html">OAI-PMH</a></li>
97
                      <li><a href="./bulk-projects.html">Bulk access to projects</a></li>
98
                    </ul>
99
                  </div>
100
                </li>
101
                <li >
102
                  <a href="./api.html">Selective access</a>
103
                  <div class="uk-navbar-dropdown">
104
                    <ul class="uk-nav uk-navbar-dropdown-nav">
105
                      <li><a href="./api.html#pubs">Publications</a></li>
106
                      <li><a href="./api.html#datasets">Datasets</a></li>
107
                      <li><a href="./api.html#projects">Projects</a></li>
108
                    </ul>
109
                  </div>
110
                </li>
111
              </ul>
112
          </div>
113
        </nav>
114
     </div>
115
    </div>
116
  </div>
117
         <!-- MENU ENDS HERE-->
118
         <div class="first_page_section uk-section-default uk-section uk-padding-remove-vertical">
119
            <div class="first_page_banner_headline uk-grid-collapse uk-flex-middle uk-margin-remove-vertical uk-grid" uk-grid="">
120
            </div>
121
         </div>
122
         <div   class=" uk-section  uk-margin-large-top tm-middle custom-main-content" id="tm-main">
123
            <div   class="uk-container">
124
               <div   uk-grid="" class="uk-grid uk-grid-stack">
125
                  <div   class="tm-main uk-width-1-1@s uk-width-1-1@m  uk-width-1-1@l uk-row-first uk-first-column">
126
		    
127
		    <div class="uk-alert-danger" uk-alert>
128
    			<p>Openaire XML Schema has been changed! Please <a href="https://www.openaire.eu/openaire-xml-schema-change-announcement" target="_blank">click here</a> to learn more!</p>
129
		    </div>
130
                      <p>The OpenAIRE API allows developers to access the metadata information space of OpenAIRE programmatically.</p>
131
                    <p>If you have any question, please open a ticket to the <a href="https://www.openaire.eu/support/helpdesk" target="_blank">OpenAIRE Helpdesk</a>.</p>
132

    
133
                    <div class="uk-child-width-1-3@m uk-grid-small uk-grid-match" uk-grid>
134
                      <div>
135
                        <div class="uk-tile uk-tile-muted">
136
                            <h3 class="uk-card-title uk-text-center">Bulk access</h3>
137
                            <a href="oai-pmh.html">OAI-PMH</a> <br>
138
                            <a href="bulk-projects.html">Bulk access to projects</a> <br>
139
                        </div>
140
                      </div>
141

    
142
                      <div>
143
                        <div class="uk-tile uk-tile-primary">
144
                            <h3 class="uk-card-title  uk-text-center">Selective access via HTTP API</h3>
145
                            <a href="api.html#pubs">Publications</a> <br>
146
                            <a href="api.html#datasets">Datasets</a> <br>
147
                            <a href="api.html#projects">Projects</a> <br>
148
                        </div>
149
                    </div>
150
                    <div>
151
                      <div class="uk-tile uk-tile-secondary">
152
                          <h3 class="uk-card-title  uk-text-center">Linked Open Data</h3>
153
                          <!-- class="custom-external custom-icon"-->
154
                          <a  href="http://lod.openaire.eu/documentation" target="_blank">Documentation</a> <br>
155
                          <a  href="http://lod.openaire.eu/vocab" target="_blank">OpenAIRE LOD Ontology</a> <br>
156
                          <a  href="https://zenodo.org/record/53077#.V6M34Pn5jRa" target="_blank">OpenAIRE RDF dump</a> <br>
157
                          <a  href="http://lod.openaire.eu/sparql" target="_blank">SPARQL endpoint</a> <br>
158
                      </div>
159
                  </div>
160
                  </div>
161
                      <br/>
162
                      <div>
163
                          <h4>TERMS OF USE AND SLA</h4>
164
                          <p><strong>OpenAIRE HTTP API</strong>: the APIs are free-to-use (no sign-up needed) by any third-party service. Note that:</p>
165
                          <ul>
166
                              <li>The HTTP API limits each query to 10,000 paged results; for unlimited access to the APIs please contact <a href="mailto:paolo.manghi@isti.cnr.it">the service administrators</a>.
167
                              </li>
168
                              <li>Since 2015 an <a href="https://zenodo.org/record/51077#.WsdCFdNubOR">RDF dump of the LOD is made available in Zenodo.org</a></li>
169
                          </ul>
170
                          <p><strong> Metadata license is CC-BY</strong>: the metadata records retuned by the service can be freely re-used by commercial and non-commercial partners under CC-BY license, hence as long as OpenAIRE is acknowledged as content provider.
171
                          </p>
172
                          <p><strong>Quality of Service</strong>: all API services are running in production 24/7 within the OpenAIRE infrastructure premises deployed at the <a href="http://icm.edu.pl/en/centre-of-technology/">data center</a> facilities of the <a href=http://icm.edu.pl/en/">Interdisciplinary Centre for Mathematical and Computational Modelling</a> (ICM).
173
                          </p>
174
                          <p><strong>APIs rate limits</strong>
175
                          <ul>
176
                              <li>no more than 30 concurrent connections from single IP to any APIs</li>
177
                              <li>no more than 67 concurrent requests in total</li>
178
                              <li>no more then 37 concurrent request in total (max 30 per single IP) to the HTTP API for selective access</li>
179
                              <li>no more than 15 requests/second to the HTTP API for selective access (in total, not per IP. If this limit is reached, requests will be delayed).</li>
180
                          </ul>
181
                          </p>
182
                      </div>
183
                      <h4>RESPONSE METADATA FORMAT</h4>
184
                  <p>
185
                    <span class="uk-text-lead">The default format of delivered records is oaf (OpenAire Format - current version 1.0):</span>
186
                    <ul>
187
                      <li><a href="https://www.openaire.eu/schema/0.3/oaf-0.3.xsd" target="_blank">https://www.openaire.eu/schema/1.0/oaf-1.0.xsd</a></li>
188
                      <li><a href="https://www.openaire.eu/schema/0.3/doc/oaf-0.3.html" target="_blank">https://www.openaire.eu/schema/1.0/doc/oaf-1.0.html</a></li>
189
                    </ul>
190
                      <p>For the list of changes <a href="https://www.openaire.eu/openaire-xml-schema-change-announcement" target="_blank">click here</a></p>
191
                  </p>
192

    
193
                  <p>
194
                    <span class="uk-text-lead">The latest versions of the XML schema and documentation are also available at the following links:</span>
195
                    <ul>
196
                      <li><a href="https://www.openaire.eu/schema/latest/oaf.xsd" target="_blank">https://www.openaire.eu/schema/latest/oaf.xsd</a></li>
197
                      <li><a href="https://www.openaire.eu/schema/latest/doc/oaf.html" target="_blank">https://www.openaire.eu/schema/latest/doc/oaf.html</a></li>
198
                    </ul>
199
                  </p>
200

    
201
                  <p>
202
                    <span class="uk-text-lead">Older versions:</span>
203
                    <ul>
204
                      <li>oaf v0.3 <a href="https://www.openaire.eu/schema/0.3/oaf-0.3.xsd" target="_blank">XML schema</a> and <a href="https://www.openaire.eu/schema/0.3/doc/oaf-0.3.html" target="_blank">documentation</a></li>
205
                      <li>oaf v0.2 <a href="https://www.openaire.eu/schema/0.2/oaf-0.2.xsd" target="_blank">XML schema</a> and <a href="https://www.openaire.eu/schema/0.2/doc/oaf-0.2.html" target="_blank">documentation</a></li>
206
                      <li>oaf v0.1 <a href="https://www.openaire.eu/schema/0.1/oaf-0.1.xsd" target="_blank">XML schema</a> and <a href="https://www.openaire.eu/schema/0.1/doc/oaf-0.1.html" target="_blank">documentation</a></li>
207
                    </ul>
208
                  </p>
209
                      <h4>API documentation changes</h4>
210
                      <p>For the list of changes to this documentation <a href="changelog.html">click here</a></p>
211

    
212
                    <!-- Content GOES HERE-->
213
                  </div>
214
               </div>
215
            </div>
216
         </div>
217
         <!-- FOOTER STARTS HERE-->
218
         <div class="custom-footer">
219
            <div class="uk-section-primary uk-section uk-section-small">
220
               <div class="uk-container">
221
                  <div class="uk-grid-margin uk-grid uk-grid-stack" uk-grid="">
222
                     <div class="uk-width-1-1@m uk-first-column">
223
                        <div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-center">
224
                           <img alt="OpenAIRE" class="el-image" src="./assets/Logo_Horizontal_white_small.png">
225
                        </div>
226
                        <div class="footer-license uk-margin uk-margin-remove-bottom uk-text-center uk-text-lead">
227
                           <div><a href="http://creativecommons.org/licenses/by/4.0/" rel="license" target="_blank"><img alt="Creative" src="./assets/80x15.png" style="height: auto; max-width: 100%; vertical-align: middle;"></a>&nbsp;UNLESS OTHERWISE INDICATED, ALL MATERIALS CREATED BY THE OPENAIRE CONSORTIUM ARE LICENSED UNDER A&nbsp;<a href="http://creativecommons.org/licenses/by/4.0/" rel="license">CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE</a>.</div>
228
                           <div>OPENAIRE IS POWERED BY&nbsp;<a href="http://www.d-net.research-infrastructures.eu/" target="_blank">D-NET</a>.</div>
229
                        </div>
230
                        <div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-right">
231
                           <a class="uk-totop uk-icon" href="#" uk-scroll="" uk-totop=""></a>
232
                        </div>
233
                     </div>
234
                  </div>
235
               </div>
236
            </div>
237
         </div>
238
      </div>
239
   </body>
240
</html>
(5-5/7)