This document provides an introduction and overview of the ORCID API. It discusses the ORCID data model, security model, XML structure, and how to access and use the API. The ORCID API uses OAuth2 for authorization and allows developers to retrieve, update, and add researcher profiles and activities like publications, affiliations, and funding through API calls. Documentation and support resources are also referenced.

1. ORCID API
An introduc+on with samples
Andrea Bollini (CTIO)
<andrea.bollini@4science.it>
November 2016

2. • ORCID data model
• Security model
• ORCID-XML structure
• Example of use of APIs from DSpace-CRIS
Agenda

3. Research centric data model
Affilia+ons
- Educa+on
- Employment
Fundings
Start / End dates; Role +tle;
Department name; Organiza+on
(with ID as much as possible)
Works
Title, Journal, Abstract, Cita+on,
Type, publica+on date, iden+fiers,
url, contributors, language,
country
Start / End dates; Title,
Descrip+on, inves+gators,
Types, iden+fiers, Funder
(with ID as much as possible)

4. Common proper9es
Put-code: an internal ID for such data
in the ORCID database to use for
update (in v2)
Visibility: public / private / protected
Last-Modified / Created Date
Source: who has added such
informa+on (the researcher itself or
a trusted applica+on)

5. Visibility
Public: the informa+on is shown in the
public ORCID profile everyone can access it
also via API
Protected: the informa+on is available only
to applica+ons trusted by the researcher via
API (and the researcher itself)
Private: the informa+on is available only to
the researcher, the trusted individual
(delegate) and eventually to the applica+on
that have added the informa+on via API

6. Slide courtesy of ORCID

7. hp://orcid.org/organiza+ons/integrators/API

8. How to get the API
• Public API can be requested for free by any person
who holds an ORCID ID
• Demonstra+on:
tutorial-eurocrisdays@mailinator.com / t3s3st
hps://sandbox.orcid.org/developer-tools
• Member API are reserved to ORCID members, can
be requested using a web form
hps://orcid.org/content/register-client-applica+on-produc+on-
trusted-party
• A sandbox environment is available for anyone also
to test member & premium API
hps://orcid.org/content/register-client-applica+on-sandbox

9. Authoriza9on and security
• The ORCID API uses OAUTH2 as authoriza+on
model
• Client is authen+cated using client_id & client_secret
• Ask authoriza+on to the researcher to perform some
ac+ons (scopes /read-limited, /orcid-bio/update, etc.)
• Receive an authen+ca+on token to use in the
subsequent API calls
• How it looks like to the user:
hp://dspacecris.eurocris.org/
hps://dspace-cris.4science.it

10. Slide courtesy of ORCID

11. Slide courtesy of ORCID

12. The request URI structure
hps://members.orcid.org/api/explore-orcid-api-google-oauth-playground

13. How to READ informa9on
hps://members.orcid.org/api/tutorial-retrieve-data-orcid-record

14. ORCID Message Schema
Current version 1.2
Release candidate 2.0
ORCID – XML have 4 sec+ons
• <orcid-iden+fier> & <orcid-history> reserved to
informa+on managed by the registry
• <orcid-bio> contains the personal informa+on of
the researcher
• <orcid-ac+vi+es> contains the informa+on related
to all the ac+vi+es of the researcher: works,
affilia+on, funding

15. hps://members.orcid.org/api/record-xml-structure

16. hps://members.orcid.org/api/record-xml-structure

17. hps://members.orcid.org/api/record-xml-structure

18. hps://members.orcid.org/api/record-xml-structure

19. hps://members.orcid.org/api/record-xml-structure

20. How to use it
• Demo: hps://dspace-cris.4science.it

21. • You need member API for that!
• You can POST or PUT
• POST: create addi+onal informa+on à append
• PUT: replace all the informa+on owned by your
applica+on
• You can update/create specific sec+on or subparts
• <ORCID-ID>/orcid-bio
• <ORCID-ID>/affilia+ons
• <ORCID-ID>/orcid-works
• <ORCID-ID>/finding
• More details hps://members.orcid.org/api/api-calls
How to update informa9on

22. How to use it
• Demo: hps://dspace-cris.4science.it

23. How to get support & more informa9on
• Extended online documenta+on:
hp://members.orcid.org/api
• GitHub ORCID repository
hps://github.com/ORCID/ORCID-Source
• Google group:
hps://groups.google.com/forum/#!forum/orcid-api-users
• ORCID Support:
support@orcid.org

24. Andrea Bollini (CTIO)
<andrea.bollini@4science.it>
mobile: +39 333 934 1808
skype: a.bollini
linkedin: andreabollini
orcid: 0000-0002-9029-1854
Thanks for your aJen9on