orcid integration: contributing data

iD

ORCID.org

ORCID Integration: Contributing Data ORCID Launch Partner Webinar September 13, 2012

iD

ORCID.org

Today’s Agenda •  About the ORCID Webinar Series

•  Background •  Contributing Data •  Scholar creates ID from your site •  Create IDs for employees •  Add works to a scholar’s Record •  Add your system ID to a scholar’s Record

•  Additional Resources

•  Next steps

iD

ORCID.org

The ORCID Webinar Series •  ORCID Resources (Aug 16, 2012)

Learn about the four components of the ORCID Registry: the Players, Account & Record, Privacy and Accessing Records. Discover what will be included in the October launch and helpful resources. •  View the recording: http://goo.gl/nLpVE •  See the slides: http://goo.gl/nuc1W

•  Member Site Integration (Aug 30, 2012) Discover some common uses of the API, and learn how to incorporate them into your own sites and services. •  View the recording: http://goo.gl/wyaYT •  See the slides: http://goo.gl/9skao

•  Contributing Data (Sep 13, 2012) The production database will soon be live and you will be able to load live data. Learn about common challenges and how to overcome them.

iD

ORCID.org

BACKGROUND ORCID Integration: Contributing Data

iD

ORCID.org

Understanding the ORCID Registry

The ORCID “Cast”

The ORCID Account & Record

ORCID Privacy

Accessing ORCID Records

The ORCID ID •  16-digit number •  Compatible with ISO 277729 standard •  Last character is a checksum (ISO/IEC 7064:2006, MOD 11,2) •  Expressed as an HTTP URI

http://orcid.org/0000-0002-3843-3472

iD

ORCID.org

Accessing ORCID Records

ORCID Record

Scholar/Researcher From the Website

CREATE EDIT READ ADD TO

Proxy(ies) From the Website

Trusted Organizations From the API

EDIT READ ADD TO

CREATE

EDIT

READ

ADD TO

ORCID Record

ORCID Record

CREATE permission: granted by ORCID only if employer

EDIT permission: one time ONLY for short term; granted at time of edit

APPEND permission: one time ONLY for short term; granted at time of addition

READ permission: granted until revoked by user

Permissions at launch– to be extended over time

iD

ORCID.org

CONTRIBUTING DATA ORCID Integration: Contributing Data

iD

ORCID.org

The Near-term Goal •  Establish the use of ORCID IDs among scholars •  Integrate ORCID IDs in workflows throughout the research

community •  Incorporate research activity data into Records to aid in

future disambiguation efforts

To do this we need: 1.  Scholars seeing the benefit of creating ORCID IDs 2.  Scholars creating or claiming ORCID IDs 3.  Linkage with other systems to synch and update research

activity data

iD

ORCID.org

Scholar Creates an ID from Your Site An Example

From Nature.com – need a credit

Special thank you to nature.com for permission to use screen shots from their system

iD

ORCID.org




3

iD

ORCID.org



iD

ORCID.org




ORCID ID and Name

obtained from the ORCID

Site

iD

ORCID.org

Scholar Creates an ID from Your Site

Member site encourages the scholar to attach / create an ORCID ID

Member site sends the user to ORCID site to authenticate to the system or create an account (read permission is usually also granted)

ORCID site returns user to the member site; Member site may use data to fill forms

1 2 3

You can encourage users to get ORCID IDs through your own site

iD

ORCID.org

Scholar Creates an ID from Your Site How to do it 1.  Encourage User

Ø Given your audience, what is the most compelling reason for a scholar to have an ORCID ID on your system?

2.  Launch the process – send the user to ORCID Ø Launch a new window with the Authorize URI Ø URI starts the login/sign up process on the ORCID site

1.  asks the user to grant the requested permissions 2.  Return user to the redirect_uri with an authorization code

3.  Read the ORCID ID/Record and more Ø Get an access token from the authorization code with the Token URI Ø Use the token to get information from the ORCID Record and more

Ø Fill a form Ø Store data for later use Ø etc

iD

ORCID.org

Create IDs for Employees

Get permission from Scholars via your own processes and policies

Gather information and create the ORCID ID/Record via the API

ORCID notifies scholars who can claim and manage their ID/Record

1 2 3

Organizations can centralize ID/Record creation

iD

ORCID.org

Create IDs for Employees How to do it

1. Get permission from scholars to create records Ø Using your own internal processes outside of the ORCID system

2.  Format and send the scholar information Ø Format data as an ORCID API Message Ø Send API Message to the ORCID Server using the /orcid-profile/

create scope for each scholar.

3. ORCID Site asks the scholar to claim the ID/Record Ø The system notifies the scholars Ø Scholars claim the record and start to manage it on their own.

iD

ORCID.org

Add a Scholar’s Works

Enable scholars on your website to send meta data about works or other research activities to ORCID

Prepare the ORCID API Message and ask the scholar for permission to send it

Send the API Message up append works to the scholar’s Record

1 2 3

Help disambiguate authors by adding works and other research activities from your records to a scholar’s ORCID Record

iD

ORCID.org

Add a Scholar’s Works How to do it

1. On your site enable scholars to add to their ORCID Record Ø You choose what to enable

2.  Format information and ask permission to send to ORCID Ø Format one or more works in the ORCID API message format Ø Launch a new window with the Authorize URI Ø User grants permission to create works in their ORCID Record

3. Create the ORCID Record element Ø Get an access token from the authorization code with the Token

URI Ø Use the code to post works to the ORCID Record Ø The system confirms the data creation with the scholar via email

iD

ORCID.org

Add Your ID to a Scholar’s ORCID Record

Enable scholars on your website to link your site’s scholar page on their ORCID Record

Prepare the ORCID API Message and ask the scholar for permission to send it

Send the API Message up append the External-ID to the scholar’s Record

1 2 3

Help others to find the scholar on your sites by adding your ID to the scholar’s ORCID Record.

iD

ORCID.org

Add Your ID to a Scholar’s ORCID Record How to do it

1. On your site enable scholars to add to their ORCID Record Ø You choose what to enable

2.  Format information and ask permission to send to ORCID Ø Format external-id element in the ORCIC API Message format Ø Launch a new window with the Authorize URI; User grants

permission to create external IDs in their ORCID Record

3. Create the ORCID Record element Ø Get an access token from authorization code with the Token URI Ø Use the code to post external-ids to the ORCID Record Ø The system confirms the data creation with the scholar via email

iD

ORCID.org

ADDITIONAL RESOURCES ORCID Member Site Integration

iD

ORCID.org

ORCID OAuth URIs •  AUTHORIZE: To get Authorization Code http://devsandbox.orcid.org/oauth/authorize?

redirect_uri=[URL to return user when done] &response_type=code &client_id=[Client ID from your client app registration] &scope=[The permissions you would like to request] &access_type=offline

•  TOKEN: To get Access Token http://api.devsandbox.orcid.org/oauth/token?

code=[returned authorization code] &redirect_uri=[URL to return to when done] &client_id=[Client ID from your client app registration] &client_secret=[Client secret from client app reg] &grant_type=authorization_code

iD

ORCID.org

ORCID OAuth URIs •  TOKEN: To get Access Token ** for creating new IDs

http://api.devsandbox.orcid.org/oauth/token? client_id=[Client ID from your client app registration] &client_secret=[Client secret from client app reg] &scope=/orcid-profile/create &grant_type=client_credentials

iD

ORCID.org

The API Message •  Describe the XML message and its sections •  Biography – includes:

•  Lists of External Identifiers •  Lists of Affiliations

•  Research Activities •  Works •  Grants •  Technologies (including patents)

•  Message Data Return Formats

Biography Activities •  Works •  Grants •  Technologies

ORCID Record

Ø  http://orcid.github.com/ORCID-Parent/schemas/orcid-message/1.0.3/

iD

ORCID.org

Key Resources •  Developer Technical Documentation

http://dev.orcid.org/resources •  Structure of the ORCID ID

http://dev.orcid.org/structure-orcid-identifier •  Read / Query API

http://dev.orcid.org/docs/query-api •  Update / Append API

http://dev.orcid.org/docs/deposit-update-api •  The ORCID API Message

http://orcid.github.com/ORCID-Parent/schemas/orcid-message/1.0.3/ •  UML Flow Diagram

http://goo.gl/I9wIB

•  Technical Support (Available after launch)

iD

ORCID.org

To Be Released in October For Individuals •  Public Registry – Anyone can create an ORCID ID and search

the Registry •  ORCID Record •  Link ID to other identifier schemes, synch data •  Enhance ID with information on research activities, including

biography, works, grants and technology/products

For Member Organizations •  Updated APIs / XML •  Create IDs for employees and students (institutions only) •  Trusted relationship management to share information

iD

ORCID.org

Resource: News/Documentation •  Developers Portal (dev.orcid.org) •  Latest about the Launch (dev.orcid.org/launch) •  Documentation, code samples (dev.orcid.org/resources) •  Blog with the latest updates (dev.orcid.org/blog) •  Links to support (available in Oct)

iD

ORCID.org

Resource: Sandbox-Try the API •  Sandbox Site (devsandbox.orcid.org) •  Fully functioning API •  Tokens available at dev.orcid.org/create-client-app •  Limited web interface •  In synch with the production server and Registry •  Non-persistent. Data is refreshed periodically

iD

ORCID.org

Next Steps q Get a token to use the Sandbox

(dev.orcid.org/create-client-app)

q Review documentation (dev.orcid.org/resources)

q Try the things described in this presentation

q Review previous webinars (/goo.gl/dGrRe) •  Include links to each

q Subscribe to the blog for the latest updates (RSS: dev.orcid.org/blog/51/feed)

iD

ORCID.org

THANK YOU!

Laura Paglione Technical Director ORCID [email protected]

orcid integration: contributing data

Technology