Presentation at the 2016 February ORCID Outreach Meeting in Canberra, Australia (15-16 February 2016)

1. 16 February 2016 orcid.org 1
OurVision
ORCID’s vision is a world where
all researchers are uniquely identified
and connected to their contributions
across time, disciplines, and borders.

2. ORCID at three
16 February 2016 orcid.org 2
Sustain: build toward financial sustainability
Lead: enable community conversations
Mature: ensure infrastructure supports scalability

3. 16 February 2016 orcid.org 3
2 million researchers have registered
for an ORCID identifier.

4. 4
Organizations are collecting ORCID
iDs and connecting them to identifiers
for people, places, and things
ORCID enables assertions

5. orcid.org
Collect & Connect
ORCID Outreach Meeting
Canberra, February 16 2016
Alice Meadows
Director of Community Engagement & Support
a.meadows@orcid.org
orcid.org/0000-0003-2161-3781
@alicejmeadows

6. 16 February 2016 orcid.org 6
Research infrastructure aka plumbing

7. 16 February 2016 orcid.org 7Both commons.wikimedia.org

8. 16 February 2016 orcid.org 8Chinese lion Royalty Free Stock Photos

9. 16 February 2016 orcid.org 9

10. orcid.org/about/team
Community Engagement & Support
Catalina Wilmers
San Francisco,
USA
Cheryl Sethate
Gaborone,
Botswana
Alice Meadows
Boston, USA
Ana Patricia
Cardoso
Mexico City,
Mexico
Alainna
Therese Wrigley
Hong Kong

11. 16 February 2016 orcid.org 11
“Good developers know how
things work. Great developers
know why things work.”
Steve Souders, Head Performance Engineer, Google

12. Collect & Connect goals
• Clarify goals and expectations across sectors
• Standardize and improve the user experience
• Improve trust in connections between ORCID and
other identifiers
• Increase efficiency and quality of integrations
• Help ensure ORCID sustainability through a community
approach
16 February 2016 orcid.org 12

13. Integrations by region
16 February 2016 orcid.org 13
APAC
13%
EUR
58%
LAM
0%
MEA
1%
NA
28%

14. Integrations by sector
16 February 2016 orcid.org 14
Association
8%
Funder
4%
Publisher
15%
Repository
12%
Research
Institution
61%

15. Collect & Connect
16 February 2016 orcid.org 15
Collect Display Connect Sync
Authenticate!

16. 16 February 2016 orcid.org 16

17. Collect
Research institutions: iDs for faculty and
students
Funders: iDs at grant submission and
review
Publishers/Repositories: iDs for
authors, reviewers, contributors
16 February 2016 orcid.org 17

18. Display
Research institutions: in faculty profiles,
with works
Funders: with awards
Publishers: with works
16 February 2016 orcid.org 18

19. Connect
Research institutions: with IDs for
affiliations
Funders: with IDs for grants
Publishers: with IDs for papers,
datasets, reviews
16 February 2016 orcid.org 19

20. Sync
All: sync updates
All: authenticate
16 February 2016 orcid.org 20

21. Next steps…
• Map existing integrations
• Document best practices and use cases
• Update members.orcid.org
• Create resources and collateral
• ORCID engagement campaign
16 February 2016 orcid.org 21

22. 16 February 2016 orcid.org 22www.mpasa.com.au

23. orcid.org
beyond what is ORCID...
...using the API
2016 february 15
laura paglione
technical director, ORCID
L.Paglione@ORCID.org
http://orcid.org/0000-0003-3188-6273
Contact Info: p. +1-301-500-2139 a. 10411 Motor City Drive, Suite 750, Bethesda, MD 20817 USA

24. orcid.org 24
the other stuff that has to happen
• communications
• rollout timing
• evangelism – encouraging use
...can be much harder & more time consuming than using the API
let’s not get ahead of ourselves...
PHOTO: 3/2 nuts © M.G. Kafkas
https://flic.kr/p/4XytpS

25. orcid.org
basic API flow
ORCID Record
Yes!
Do you have
permission to do what
you want to do?
Get the permission;
store iD and “token”
Read the record or
update the record
No
OAuth

26. orcid.org 26
API (Application Programming Interface) –
interface that lets one software program “talk”
with another, exchanging data behind the scenes.
An ad, but good basic info about what an API can do:
http://paidpost.nytimes.com/ca-technologies/apis-the-building-
blocks-of-the-app-economy.html
what is an API?
PHOTO: 3/2 nuts © M.G. Kafkas
https://flic.kr/p/4XytpS

27. orcid.org 27
• permissions / scopes – your contract with the user
• the ORCID messages – format of the data exchanged
• OAuth calls – the permission protocol – how you “execute
the contract”
• ORCID-specific calls – providing receiving information
with the registry
the ORCID API in a nutshell
PHOTO: 3/2 nuts © M.G. Kafkas
https://flic.kr/p/4XytpS

28. PHOTO: electronic circuit board
www.flickr.com/photos/creative_stock/5227842611
explaining scopes / permissions
orcid.org
ORCID registry depends on user-based permissions:
Can I...
• have your iD (/authenticate)
• interact with the activities on your record
• read (/activities/read)
• update (/activities/update)
• interact with your biographical information
• read (/person/read)
• update (/person/update)

29. what a message looks like
orcid.org

30. PHOTO: electronic circuit board
www.flickr.com/photos/creative_stock/5227842611
the OAuth calls – part 1
orcid.org
Initiate the process – Send the user to a “fancy” URL
https://orcid.org/oauth/authorize?
client_id=0000-0002-3003-7862
response_type=code
scope=/activities/read-limited%20/activities/update
redirect_uri=https://my.URL.org
family_names=Paglionegiven_names=Lauraemail=l.paglione
%2B2014@orcid.orgorcid=0000-0001-6356-0580
The base URL – displays the screen
who’s asking?
what permission?
where the user goes next
Personalize the
experience

31. PHOTO: electronic circuit board
www.flickr.com/photos/creative_stock/5227842611
what the user sees
orcid.org

32. PHOTO: electronic circuit board
www.flickr.com/photos/creative_stock/5227842611
the OAuth calls – part 2
orcid.org
ORCID sends the user to your redirect, with a code
https://my.URL.org?htA3yE
you...
• save the code – you need it for the next step
• display something useful to the user
• Authorize: thanks for your permission!
• Deny: are you sure you don’t want to give permission?
The magic code

33. PHOTO: electronic circuit board
www.flickr.com/photos/creative_stock/5227842611
the OAuth calls – part 3a: the call
orcid.org
use the code to gain access using the ORCID API
https://api.orcid.org/oauth/token
HEADER: accept:application/json
DATA:
client_id=0000-0002-3003-7862
client_secret=f6ffa224-dc28-4c51-8c9e-ae4b86f61bc3
grant_type=authorization_code
code=htA3yE
redirect_uri=https%3A%2F%2Fmy.URL.org
our API calls always looks
like URLs (RESTful)
what format?
The magic code
confirming that you are
the right one to get this
information

34. PHOTO: electronic circuit board
www.flickr.com/photos/creative_stock/5227842611
the OAuth calls – part 3b: the result
orcid.org
the result of the call
access_token” : 6710dfee-6aab-445b-a266-205dd9085273,
token_type” : bearer,
expires_in” : 631138518,
scope” : /activities/read-limited /activities/update,
orcid” : 0000-0001-6356-0580,
name” : Laura Paglione”
store the access token and iD
when permission expires (in seconds)
your permission – executed contract
iD name for the person
who gave permission
What you can do

35. PHOTO: electronic circuit board
www.flickr.com/photos/creative_stock/5227842611
ORCID-specific calls
orcid.org
• Read data: GET
• Add data: POST
• Update data: PUT
BASE URL: https://api.orcid.org/0000-0000-0000-0000
HEADERS:
accept:application/json (reading) content-type:application/json (adding /updating)
Authorization: Bearer 6710dfee-6aab-445b-a266-205dd9085273
DATA (if adding or updating):
the file location=@file_location_name
Modifiers:
/works
/update
data format
Access token from before

36. PHOTO: electronic circuit board
www.flickr.com/photos/creative_stock/5227842611
but wait... there’s more
orcid.org
• Error handling
• API updates
• about 1x/year
• supported versions
• release candidates
• deprecated versions

37. resources
PHOTO: Stairway to somewhere © Jonathan Fenton
https://flic.kr/p/7Guxgu
member resources (includes planning communication resources)
http://members.orcid.org
API documentation
http://members.orcid.org/api
getting authenticated ORCID iDs
http://members.orcid.org/api/tutorial-retrieve-orcid-id-curl-v12-and-earlier
vendors that support ORCID iDs
http://members.orcid.org/publisher-tools
getting help at ORCID
http://orcid.org/help/contact-us
•
•
•
•
•

38. thank you
● http://orcid.org
● BLOG: http://orcid.org/about/news
● TWITTER: @ORCID_Org
orcid.org