Project

General

Profile

1 49344 katerina.i
2
3
<!DOCTYPE html>
4
<html lang="en-gb" dir="ltr" vocab="http://schema.org/">
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, OAI-PMH, open access, research, scientific publication, European Commission, EC, FP7, ERC, Horizon 2020, H2020, search, projects "/>
12
      <link href="./assets/favicon.ico" rel="shortcut icon" />
13
      <title>OpenAIRE API documentation - OAI-PMH</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" href="./assets/theme.css">
18
      <link rel="stylesheet" href="./assets/custom.css">
19
      <link rel="stylesheet" href="./assets/custom.css">
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">
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 class="uk-active"><a routerLinkActive="uk-link" href="#" >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>
90
                  <a href="./overview.html"><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 class="uk-active"><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 50282 katerina.i
127
		     <div class="uk-alert-danger" uk-alert>
128 50490 katerina.i
                        <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 50282 katerina.i
                    </div>
130
131 49344 katerina.i
                    <h2>Bulk access via OAI-PMH</h2>
132
                    <div class="uk-alert-warning" uk-alert>
133
                        <p>Currently the OAI-PMH publisher is <strong>not</strong> supporting incremental harvesting. <br>
134
                          Although the usage of the OAI parameters 'from' and 'until' is handled by the OAI publisher, the datestamps of metadata records are updated about every week.<br>
135
                          We apologise for any inconvenience this may cause to harvesters,<br>
136
                          The OpenAIRE technical team</p>
137
                    </div>
138
139
                    <p> OAI-PMH is a standard protocol for metadata publishing and harvesting. For details on the OAI-PMH protocol please refer to the official documentation at <a href="http://www.openarchives.org/OAI/openarchivesprotocol.html" target="_blank">http://www.openarchives.org/OAI/openarchivesprotocol.html</a></p>
140
                    <p> The OpenAIRE OAI-PMH endpoint is <a href="http://api.openaire.eu/oai_pmh" target="_blank">http://api.openaire.eu/oai_pmh</a> <br>
141
                        For information about the endpoint check <a href="http://api.openaire.eu/oai_pmh?verb=Identify" target="_blank">http://api.openaire.eu/oai_pmh?verb=Identify</a> <br>
142
                        The updated list of OAI sets is always available at <a href="http://api.openaire.eu/oai_pmh?verb=ListSets" target="_blank">http://api.openaire.eu/oai_pmh?verb=ListSets</a>
143
                    </p>
144
                    <p>
145
                      For quick reference, we report some of the likely more interesting sets:
146
                      <ul>
147
                        <li> <strong>openaire:</strong> the set of publications. Metadata prefixes available: oaf, oai_dc</li>
148
                        <li> <strong>FP7Publications:</strong> the set of publications funded by EC FP7. Metadata prefixes available: oaf, oai_dc
149
                        <li> <strong>H2020Publications:</strong> the set of publications funded by EC H2020. Metadata prefixes available: oaf, oai_dc
150
                        <li> <strong>openaire_data:</strong> the set of datasets. Metadata prefixes available: oaf, oai_datacite
151
                        <li> <strong>OpenAccess:</strong> the set of all Open Access publications and datasets. Metadata prefixes available: oaf (return datasets and publications), oai_dc (return datasets and publications), oai_datacite (return datasets only)
152
                        <li> <strong>projects:</strong> the set of all projects. Metadata prefix available: oaf
153
                        <li> <strong>ECProjects:</strong> the set of projects funded by the European Commission (EC) under the programmes FP7 and H2020. Metadata prefix available: oaf
154
                        <li> <strong>FP7Projects:</strong> the set of projects funded by the EC Seventh Framework Programme. Metadata prefix available: oaf
155
                        <li> <strong>H2020Projects:</strong> the set of projects funded by the EC Horizn 2020 Programme. Metadata prefix available: oaf
156
                        <li> <strong>WTProjects:</strong> the set of projects funded by Wellcome Trust. Metadata prefix available: oaf
157
                      </ul>
158
159
                      <p>
160
                        For the list of available metadata prefixes, check: <a href="http://api.openaire.eu/oai_pmh?verb=ListMetadataFormats" target="_blank">http://api.openaire.eu/oai_pmh?verb=ListMetadataFormats</a>. <br>
161
                        Note that records will always be available in the OpenAIRE format (schema, documentation). The availability of records in oai_dc and oai_datacite depends on the typology of records.<br>
162
                        Publications are avaialble in <code>oai_dc</code> according to the <strong>OpenAIRE3.0 guidelines</strong> for literature repositories. <br>
163
                        Datasets are available in <code>oai_datacite</code> according to the <strong>OpenAIRE2.0 guidelines</strong> for data archives. <br>
164
                  </p>
165 51726 alessia.ba
                      <div>
166
                          <h4>TERMS OF USE AND SLA</h4>
167
                          <p>APIs are free-to-use (no sign-up needed) by any third-party service</p>
168
                          <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.
169
                          </p>
170
                          <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).
171
                          </p>
172
                          <p><strong>APIs rate limits</strong>
173
                          <ul>
174
                              <li>no more than 30 concurrent connections from single IP to any APIs</li>
175
                              <li>no more than 67 concurrent requests in total</li>
176
                          </ul>
177
                          </p>
178
                      </div>
179 49344 katerina.i
                    <!-- Content GOES HERE-->
180
                  </div>
181
               </div>
182
            </div>
183
         </div>
184
         <!-- FOOTER STARTS HERE-->
185
         <div class="custom-footer">
186
            <div class="uk-section-primary uk-section uk-section-small">
187
               <div class="uk-container">
188
                  <div class="uk-grid-margin uk-grid uk-grid-stack" uk-grid="">
189
                     <div class="uk-width-1-1@m uk-first-column">
190
                        <div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-center">
191
                           <img alt="OpenAIRE" class="el-image" src="./assets/Logo_Horizontal_white_small.png">
192
                        </div>
193
                        <div class="footer-license uk-margin uk-margin-remove-bottom uk-text-center uk-text-lead">
194
                           <div><a href="http://creativecommons.org/licenses/by/4.0/" rel="license"><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>
195
                           <div>OPENAIRE IS POWERED BY&nbsp;<a href="http://www.d-net.research-infrastructures.eu/">D-NET</a>.</div>
196
                        </div>
197
                        <div class="uk-margin uk-margin-remove-top uk-margin-remove-bottom uk-text-right">
198
                           <a class="uk-totop uk-icon" href="#" uk-scroll="" uk-totop=""></a>
199
                        </div>
200
                     </div>
201
                  </div>
202
               </div>
203
            </div>
204
         </div>
205
      </div>
206
   </body>
207
</html>