Diese Präsentation wurde erfolgreich gemeldet.
Wir verwenden Ihre LinkedIn Profilangaben und Informationen zu Ihren Aktivitäten, um Anzeigen zu personalisieren und Ihnen relevantere Inhalte anzuzeigen. Sie können Ihre Anzeigeneinstellungen jederzeit ändern.

Beyond what is ORCID... using the API (L. Paglione)

390 Aufrufe

Veröffentlicht am

Presentation at the 2016 ORCID Ottawa Workshop (20 May 2016)

Veröffentlicht in: Bildung
  • Als Erste(r) kommentieren

  • Gehören Sie zu den Ersten, denen das gefällt!

Beyond what is ORCID... using the API (L. Paglione)

  1. 1. orcid.org beyond what is ORCID... ...using the API 2016 May 20 Laura Paglione Director of Strategic Initatives, 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
  2. 2. orcid.org 2 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
  3. 3. orcid.org 3 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
  4. 4. orcid.org 4 •  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
  5. 5. 19 May 2016 orcid.org 5 DISPLAY •  In metadata •  On sites •  In publications CONNECT •  Affiliations (employers) •  Works (publishers) •  Awards (funders)
  6. 6. orcid.org Get permission, use permission 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
  7. 7. PHOTO: electronic circuit board www.flickr.com/photos/creative_stock/5227842611 Get permission: API-edition 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)
  8. 8. PHOTO: Job Meeting www.flickr.com/photos/jobmeeting/14375164286 Involving the user orcid.org Key benefits: •  You know the user controls the iD •  User knows what’s going on/ user choice •  Privacy/ data control trends •  Position/ strengthen your system as a service How? •  Just a “fancy” URL •  Prior iD not needed •  Hard things: promotion, finding touch points
  9. 9. PHOTO: Job Meeting www.flickr.com/photos/jobmeeting/14375164286 Get permission: touch points orcid.org Look for natural fits: •  Your sign in – why not link your iD? •  Your account settings/ user profile •  Submission (of any type) •  Form fills: pre-fill from your Record! •  Registration: for conference or meeting •  Reporting: Link your iD to get started
  10. 10. PHOTO: electronic circuit board www.flickr.com/photos/creative_stock/5227842611 The “fancy” URL orcid.org 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=Paglione&given_names=Laura&email=l.paglione %2B2014@orcid.org&orcid=0000-0001-6356-0580 The base URL – displays the screen who’s asking? what permission? where the user goes next Personalize the experience The OAuth call: part I
  11. 11. PHOTO: electronic circuit board www.flickr.com/photos/creative_stock/5227842611 what the user sees orcid.org
  12. 12. 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
  13. 13. 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
  14. 14. 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 ✔ iD Collected!
  15. 15. You have the iD, now display it! iDs in print Royal Society, Biology Letters iDs electronically Nature, Genetics orcid.orgPHOTO: Job Meeting
  16. 16. You have the iD, now display it! Hindawi, Geometry orcid.orgPHOTO: Job Meeting www.flickr.com/photos/jobmeeting/14375164286 iDs in profiles
  17. 17. You have the iD, now display it! ORCID iD in DOI metadata: <person_name> <given_name>Karl</given_name> <surname>Ward</surname> <ORCID authenticated=“true”> http://orcid.org/0000-0002-4121-9960 </ORCID> </person_name> •  iD available in search orcid.orgPHOTO: Job Meeting
  18. 18. 20 May 2016 orcid.org 18 DISPLAY •  In metadata •  On sites •  In publications CONNECT •  Affiliations (employers) •  Works (publishers) •  Awards (funders) ✔✔ ✔
  19. 19. orcid.org Get permission, use permission 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
  20. 20. PHOTO: electronic circuit board www.flickr.com/photos/creative_stock/5227842611 Get permission: API-edition 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)
  21. 21. PHOTO: electronic circuit board www.flickr.com/photos/creative_stock/5227842611 Use permission: API-edition orcid.org •  Read data: GET •  Add data: POST •  Update data: PUT BASE URL: https://api.orcid.org/v2.0/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
  22. 22. Read & update through a “message” orcid.org
  23. 23. PHOTO: electronic circuit board www.flickr.com/photos/creative_stock/5227842611 Examples orcid.org •  Add a work: POST https://api.orcid.org/v2.0/0000-0000-0000-0000/work •  Update employment info PUT https://api.orcid.org/v2.0/0000-0000-0000-0000/employment •  Read updated award data from another organization GET https://api.orcid.org/v2.0/0000-0000-0000-0000/funding/19328 include: •  Access token •  Data file location & type Unique reference to the award
  24. 24. 20 May 2016 orcid.org 24 DISPLAY •  In metadata •  On sites •  In publications CONNECT •  Affiliations (employers) •  Works (publishers) •  Awards (funders) ✔✔ ✔ ✔
  25. 25. PHOTO: electronic circuit board www.flickr.com/photos/creative_stock/5227842611 Enabling synchronization orcid.org ORCID API features & tips: •  Update notifications (webhooks) •  Your system registers iDs you’re watching •  ORCID notifies when changes happen •  Internal triggers •  Employment status change •  Publication acceptance •  Publication correction •  Funding award
  26. 26. 20 May 2016 orcid.org 26 DISPLAY •  In metadata •  On sites •  In publications CONNECT •  Affiliations (employers) •  Works (publishers) •  Awards (funders) ✔✔ ✔ ✔ ✔
  27. 27. 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
  28. 28. 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 •  •  •  •  • 
  29. 29. thank you ● http://orcid.org ● BLOG: http://orcid.org/about/news ● TWITTER: @ORCID_Org orcid.org

×