ORCID Collect and Connect Program (A. Meadows)

16 February 2016 orcid.org 1

Our Vision

ORCID’s vision is a world where all researchers are uniquely identified and connected to their contributions across time, disciplines, and borders.

ORCID at three


Sustain: build toward financial sustainability

Lead: enable community conversations

Mature: ensure infrastructure supports scalability


2 million researchers have registered for an ORCID identifier.

4

Organizations are collecting ORCID iDs and connecting them to identifiers for people, places, and things

ORCID enables assertions

orcid.org

Collect & Connect ORCID Outreach Meeting Canberra, February 16 2016

Alice MeadowsDirector of Community Engagement & Support

[email protected]/0000-0003-2161-3781

@alicejmeadows


Research infrastructure aka plumbing

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

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


orcid.org/about/team

Community Engagement & Support

No

Catalina Wilmers San Francisco,

USA

Cheryl Sethate Gaborone, Botswana

Alice Meadows Boston, USA

Ana Patricia Cardoso

Mexico City, Mexico

Alainna Therese Wrigley

Hong Kong


“Good developers know how things work. Great developers know why things work.” Steve Souders, Head Performance Engineer, Google

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


Integrations by region


APAC 13%

EUR 58%

LAM 0%

MEA 1%

NA 28%

Integrations by sector


Association 8%

Funder 4%

Publisher 15%

Repository 12%

Research Institution

61%

Collect & Connect


Collect Display Connect Sync

Authenticate!


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

Display

Research institutions: in faculty profiles, with works Funders: with awards Publishers: with works


Connect

Research institutions: with IDs for affiliations Funders: with IDs for grants Publishers: with IDs for papers, datasets, reviews


Sync

All: sync updates All: authenticate


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 22 www.mpasa.com.au

orcid.org

beyond what is ORCID... ...using the API

2016 february 15

laura paglionetechnical director, ORCID

[email protected]://orcid.org/0000-0003-3188-6273

Contact Info: p. +1-301-500-2139 a. 10411 Motor City Drive, Suite 750, Bethesda, MD 20817 USA

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

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

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?


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: 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)

what a message looks like

orcid.org


the OAuth calls – part 1

orcid.org

Initiate the process – Send the user to a “fancy” URLhttps://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=Paglione&given_names=Laura&email=l.paglione%[email protected]&orcid=0000-0001-6356-0580

The base URL – displays the screen

who’s asking?

what permission?

where the user goes next

Personalize the experience


what the user sees

orcid.org


the OAuth calls – part 2

orcid.org

ORCID sends the user to your redirect, with a codehttps://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


the OAuth calls – part 3a: the call

orcid.org

use the code to gain access using the ORCID APIhttps://api.orcid.org/oauth/token

HEADER: accept:application/jsonDATA: client_id=0000-0002-3003-7862 client_secret=f6ffa224-dc28-4c51-8c9e-ae4b86f61bc3grant_type=authorization_codecode=htA3yEredirect_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


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


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-205dd9085273DATA (if adding or updating): the file location=@file_location_name

Modifiers: /works /update

data format

Access token from before


but wait... there’s more

orcid.org

•  Error handling•  API updates

•  about 1x/year•  supported versions•  release candidates•  deprecated versions

resources

PHOTO: Stairway to somewhere © Jonathan Fenton https://flic.kr/p/7Guxgu

member resources (includes planning & communication resources)http://members.orcid.org

API documentationhttp://members.orcid.org/api

getting authenticated ORCID iDshttp://members.orcid.org/api/tutorial-retrieve-orcid-id-curl-v12-and-earlier

vendors that support ORCID iDshttp://members.orcid.org/publisher-tools

getting help at ORCIDhttp://orcid.org/help/contact-us

•  •  •  •  • 

thank you

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

orcid.org

Technology

ORCID Collect and Connect Program (A. Meadows)