Embed Size (px)
Citation preview
• ORCIDdatamodel
• Securitymodel
• ORCID-XMLstructure
• ExampleofuseofAPIsfromDSpace-CRIS
Agenda
Research centric data model
Affilia+ons- Educa+on- Employment
Fundings
Start/Enddates;Role+tle;Departmentname;Organiza+on(withIDasmuchaspossible)
WorksTitle,Journal,Abstract,Cita+on,Type,publica+ondate,iden+fiers,url,contributors,language,country
Start/Enddates;Title,Descrip+on,inves+gators,Types,iden+fiers,Funder(withIDasmuchaspossible)
Common proper9es
Put-code:aninternalIDforsuchdataintheORCIDdatabasetouseforupdate(inv2)Visibility:public/private/protectedLast-Modified/CreatedDateSource:whohasaddedsuchinforma+on(theresearcheritselforatrustedapplica+on)
Visibility
Public:theinforma+onisshowninthepublicORCIDprofileeveryonecanaccessitalsoviaAPI
Protected:theinforma+onisavailableonlytoapplica+onstrustedbytheresearcherviaAPI(andtheresearcheritself)
Private:theinforma+onisavailableonlytotheresearcher,thetrustedindividual(delegate)andeventuallytotheapplica+onthathaveaddedtheinforma+onviaAPI
SlidecourtesyofORCID
h\p://orcid.org/organiza+ons/integrators/API
How to get the API
• PublicAPIcanberequestedforfreebyanypersonwhoholdsanORCIDID• Demonstra+on:
[email protected]/t3s\3sth\ps://sandbox.orcid.org/developer-tools
• MemberAPIarereservedtoORCIDmembers,canberequestedusingawebformh\ps://orcid.org/content/register-client-applica+on-produc+on-trusted-party
• Asandboxenvironmentisavailableforanyonealsototestmember&premiumAPI
h\ps://orcid.org/content/register-client-applica+on-sandbox
Authoriza9on and security
• TheORCIDAPIusesOAUTH2asauthoriza+onmodel• Clientisauthen+catedusingclient_id&client_secret• Askauthoriza+ontotheresearchertoperformsomeac+ons(scopes/read-limited,/orcid-bio/update,etc.)
• Receiveanauthen+ca+ontokentouseinthesubsequentAPIcalls
• Howitlooksliketotheuser:h\p://dspacecris.eurocris.org/h\ps://dspace-cris.4science.it
SlidecourtesyofORCID
SlidecourtesyofORCID
The request URI structure
h\ps://members.orcid.org/api/explore-orcid-api-google-oauth-playground
How to READ informa9on
h\ps://members.orcid.org/api/tutorial-retrieve-data-orcid-record
ORCID Message Schema
Currentversion1.2Releasecandidate2.0ORCID–XMLhave4sec+ons• <orcid-iden+fier>&<orcid-history>reservedtoinforma+onmanagedbytheregistry• <orcid-bio>containsthepersonalinforma+onoftheresearcher• <orcid-ac+vi+es>containstheinforma+onrelatedtoalltheac+vi+esoftheresearcher:works,affilia+on,funding
h\ps://members.orcid.org/api/record-xml-structure
h\ps://members.orcid.org/api/record-xml-structure
h\ps://members.orcid.org/api/record-xml-structure
h\ps://members.orcid.org/api/record-xml-structure
h\ps://members.orcid.org/api/record-xml-structure
How to use it
• Demo:h\ps://dspace-cris.4science.it
• YouneedmemberAPIforthat!• YoucanPOSTorPUT• POST:createaddi+onalinforma+onàappend• PUT:replacealltheinforma+onownedbyyourapplica+on
• Youcanupdate/createspecificsec+onorsubparts• <ORCID-ID>/orcid-bio• <ORCID-ID>/affilia+ons• <ORCID-ID>/orcid-works• <ORCID-ID>/finding• Moredetailsh\ps://members.orcid.org/api/api-calls
How to update informa9on
How to use it
• Demo:h\ps://dspace-cris.4science.it
How to get support & more informa9on
• Extendedonlinedocumenta+on:h\p://members.orcid.org/api
• GitHubORCIDrepositoryh\ps://github.com/ORCID/ORCID-Source
• Googlegroup: h\ps://groups.google.com/forum/#!forum/orcid-api-users
• ORCIDSupport:[email protected]
AndreaBollini(CTIO)<[email protected]>
mobile:+393339341808
skype:a.bollini
linkedin:andreabollini
orcid:0000-0002-9029-1854
Thanks for your aJen9on
