openaire-api-http-doc/docbkx/overview.xml

50 lines
2.0 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8"?>
<chapter version="5.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Overview</title>
<para>The OpenAIRE API allows developers to access the metadata information space of OpenAIRE programmatically.</para>
<itemizedlist>
<listitem>
<para>Bulk access:</para>
<simplelist>
<member><xref linkend="cha_oai_pmh"/></member>
<member><xref linkend="cha_projects_http"/></member>
</simplelist>
</listitem>
<listitem>
<para>Selective access via <xref linkend="cha_http-api"/></para>
<simplelist>
<member><xref linkend="sec_http-pubs"/></member>
<member><xref linkend="sec_http-datasets"/></member>
<member><xref linkend="sec_http-projects"/></member>
<!-- <member>HTTP API for projects [available soon] </member> -->
</simplelist>
</listitem>
</itemizedlist>
<para>The default format of delivered records is <code>oaf</code> (OpenAire Format - current version 0.2):
<simplelist>
<member><link
xlink:href="https://www.openaire.eu/schema/0.2/oaf-0.2.xsd"/></member>
<member><link
xlink:href="https://www.openaire.eu/schema/0.2/doc/oaf-0.2.html"/></member>
</simplelist>
</para>
<para>The latest versions of the XML schema and documentation are also available at the following links:
<simplelist>
<member><link
xlink:href="https://www.openaire.eu/schema/latest/oaf.xsd"/></member>
<member><link
xlink:href="https://www.openaire.eu/schema/latest/doc/oaf.html"/></member>
</simplelist>
</para>
<para>Older versions:
<simplelist>
<member><link
xlink:href="https://www.openaire.eu/schema/0.1/oaf-0.1.xsd"><code>oaf</code> XML schema v0.1</link></member>
<member><link
xlink:href="https://www.openaire.eu/schema/0.1/doc/oaf-0.1.html"><code>oaf</code> XML schema v0.1 documentation</link></member>
</simplelist>
</para>
</chapter>