ORCID API in action (A. Wrigley)
•Download as PPTX, PDF•
3 likes•546 views
ORCID provides persistent digital identifiers for researchers and connects their activities and affiliations through its APIs. The ORCID Public API allows anyone to authenticate users and access public data, while the Member API provides additional capabilities for ORCID member organizations. These APIs can be used to collect ORCID IDs, display them on websites and in metadata, and connect systems to ORCID records by adding or updating data with user permission.
Recommended
Recommended
More Related Content
What's hot
What's hot (20)
Viewers also liked
Viewers also liked (9)
Similar to ORCID API in action (A. Wrigley)
Similar to ORCID API in action (A. Wrigley) (20)
More from ORCID, Inc
More from ORCID, Inc (20)
Recently uploaded
Recently uploaded (20)
ORCID API in action (A. Wrigley)
- 1. orcid.orgContact Info: p. +1-301-922-9062 a. 10411 Motor City Drive, Suite 750, Bethesda, MD 20817 USA Getting connected with the ORCID API Alainna Therese Wrigley ORCID Community Engagement & Support support@orcid.org | orcid.org/0000-0002-6036-0903
- 2. ORCID provides 2orcid.org Persistent digital identifiers to distinguish researchers from each other Member-built integrations that connect researchers and their activities/affiliations A hub for synchronizing machine-readable connections between identifiers for people, organizations, and research activities ✔ Plumbing for research information ✔ Tools to build trust in digital information
- 3. 3 Organizations are use ORCID APIs to authenticate, collect, display, and connect persistent identifiers for people, places, and things in research workflows ORCID enables assertions
- 4. orcid.org 4 ORCID Public and Member APIs API Features Public API Freely available to anyone • Authenticate: Get a user’s authenticated ORCID iD • Read (Public): Search/retrieve public data • Create: Facilitate creation of new ORCID records (via on-demand process) Member API ORCID member organizations (Sandbox test environment freely available to anyone) • Read (Limited): Search/retrieve "limited-access" data • Add: Post new items to a record • Update: Edit or delete items you previously added • Webhooks (Premium only): Receive notifications of updates
- 5. orcid.org 5 • Permissions/scopes: your contract with the user • ORCID message (schema): 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
- 6. orcid.org 6 Connecting to the ORCID Registry Two models: 1. Connect via a vendor system • Manuscript submission/publication • Document/data repositories • Profile systems • CRIS systems 2. Develop a custom connection
- 7. orcid.org 7 Custom integration Via the ORCID APIs • Fine-tuned control and permissions • Customized buttons, user flows, & user feedback Current integration list: http://members.orcid.org/current-integrations
- 8. orcid.org 8 Vendor system integration Publishing • eJournal Press • Editorial Manager • ScholarOne Document / data repositories • DSpace • ePrints • Hydra/Fedora CRIS Systems • Converis • Elements • IRMA • Pivot • PlumX • Pure • Vivo http://members.orcid.org/orcid-enabled-systems
- 9. 1 July 2016 9 DISPLAY • In metadata • On sites • In publications CONNECT • Affiliations (employers) • Works (publishers) • Awards (funders) orcid.org Collect & Connect
- 10. Collect & Connect goals • Clarify how plumbing works • Standardize user experience • Standard connection installation guidelines • Increase predictability and trust in the “utility” • Community approach to reliable connections 1 July 2016 orcid.org 10
- 11. Collect COLLECT validated ORCID iDs for individuals • Explain what ORCID is • Explain why you’re collecting iDs • Consistent user experience • Authenticated connections 1 July 2016 orcid.org 11 Ensure individuals are correctly connected with your institution Many vendor systems use the OAuth process
- 12. 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 1 July 2016 12orcid.org
- 13. 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
- 14. Get permission: touch points 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
- 15. Step 1: fancy URL https://sandbox.orcid.org/oauth/authorize? client_id=APP-XT8FBKJRO3MR8WDR& response_type=code& scope=/orcid-profile/read-limited%20 /activities/update& redirect_uri=https://my.URL.org& family_names=Researcher&given_names=Bob& email=bobresearcher@mailinator.com& 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
- 16. ORCID sends the user to your redirect, with a code https://my.URL.org?htA3yE you... • Save the code – needed 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? Step 2: User feedback & auth code Authentication code
- 17. Step 3a: Change code into token Use the code to gain access using the ORCID API https://api.orcid.org/oauth/token HEADER: accept:application/json DATA: client_id=APP-XT8FBKJRO3MR8WDR client_secret=e285575c-4794-464b-a807-6f1c06b63 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 auth code confirming that you are the right one to get this information
- 18. Step 3b: Store the result The result of the call "access_token”:"6710dfee-6aab-445b-a266-205dd9085273", "token_type” : "bearer", "expires_in” : 631138518, "scope” : "/orcid-profile/read-limited /activities/update", "orcid” : "0000-0001-6356-0580", "name” : "Bob Researcher" store the access token and iD when permission expires (in seconds) your permission iD & name for the person who gave permission What you can do ✔ iD Collected!
- 19. Display 1 July 2016 orcid.org 19 DISPLAY iDs on your website, platform, systems • iDs shown as a link • iDs in metadata • Use the ORCID Member logo • Explain why iDs are collected Signal to your researchers and the wider community that your systems are plumbed to support ORCID iDs http://orcid.org/trademark-and-id-display-guidelines
- 21. Connect 1 July 2016 orcid.org 21 CONNECT your data to ORCID Records • Request permission to write to Records • Store long-lived tokens • Add data that you uniquely can (authoritative) • Explain the connection nable researchers to provide validated data to other systems they us https://orcid.org/blog/2015/10/26/auto-update-has-arrived-orcid-records-move-next-level
- 22. Connect to send data Verb: POST BASE URL: https://sandbox.api.orcid.org/v1.2/0000-0001-6356-0580/affiliations HEADERS: Content-type:application/json Authorization: Bearer 6710dfee-6aab-445b-a266-205dd9085273 DATA (if adding or updating): the file location=@employment.xml Relevant area: /orcid-bio, /funding data format Access token from before Type of action, also: READ; PUT 1. Your client sends data 2. Researcher’s record updated
- 23. Synchronize 1 July 2016 orcid.org 23 SYNCHRONIZE with your systems • Update information when it changes • Auto-add new information • Search & link wizards • Sync data from others Saved time, better reporting, improved information flow https://members.orcid.org/api/tutorial-webhooks https://orcid.org/blog/2015/10/26/auto-update-has-arrived-orcid-records-move-next-level
- 24. API in action: Create on demand http://orcid-create-on-demand.herokuapp.com
- 25. Resources • Collect and Connect documentation https://members.orcid.org • ORCID API documentation https://members.orcid.org/api • ORCID API bootcamp (step-by-step introduction) https://github.com/alainna/VALA2016 • Technical webinars https://members.orcid.org/event-list • ORCID API Users Listserv http://groups.google.com/group/orcid-api-users • ORCID Community Engagement & Support team support@orcid.org
Editor's Notes
- API (Application Programming Interface): an interface that lets one software program “talk” with another, exchanging data behind the scenes. One major assertion for research institutions – affiliation This requires collaborations among all actors in the research community: identifier providers, for sure, but also publishers, societies, universities, repositories, funders, and researchers themselves. This is not a trivial endeavor. Everyone needs to expend some work. But, it is happening. Here is an example of one such collaboration involving ORCID, Ringgold, and the IT, library, research office, and faculty affairs at a large research university. Lots of moving parts, culminating in a public, electronic, and validated record of a person’s affiliation. This record is available through a public API and can be used during a manuscript submission or peer review invitation process to auto-populate and/or validate affiliation. Save your authors time, improve data quality, and improve trust in one package.
- Our new Collect & Connect program is designed to enable better interoperability between systems and sectors, through improved guidance and support for member integrations, and by taking a community approach – sharing ideas and experiences, recognizing great integrations, and working together to achieve ORCID’s vision. Consists of five main elements In the upcoming version of our integration list, you’ll see current integrations given badges based on the elements they meet / fufil in the Collect & Connect programme
- It is the researchers that benefit greatly from ORCID iDs. They can use them throughout their career, and can already use them to distinguish themselves in publications and grants. And many are starting to see the benefits of using ORCID records in outcome tracking. For example, researchers in Portugal who receive federal funding provide their ORCID iD, and benefit from coordinated outcomes reporting by using the ORCID registry as a hub.
- It is the researchers that benefit greatly from ORCID iDs. They can use them throughout their career, and can already use them to distinguish themselves in publications and grants. And many are starting to see the benefits of using ORCID records in outcome tracking. For example, researchers in Portugal who receive federal funding provide their ORCID iD, and benefit from coordinated outcomes reporting by using the ORCID registry as a hub.
- It is the researchers that benefit greatly from ORCID iDs. They can use them throughout their career, and can already use them to distinguish themselves in publications and grants. And many are starting to see the benefits of using ORCID records in outcome tracking. For example, researchers in Portugal who receive federal funding provide their ORCID iD, and benefit from coordinated outcomes reporting by using the ORCID registry as a hub.
- It is the researchers that benefit greatly from ORCID iDs. They can use them throughout their career, and can already use them to distinguish themselves in publications and grants. And many are starting to see the benefits of using ORCID records in outcome tracking. For example, researchers in Portugal who receive federal funding provide their ORCID iD, and benefit from coordinated outcomes reporting by using the ORCID registry as a hub.
- It is the researchers that benefit greatly from ORCID iDs. They can use them throughout their career, and can already use them to distinguish themselves in publications and grants. And many are starting to see the benefits of using ORCID records in outcome tracking. For example, researchers in Portugal who receive federal funding provide their ORCID iD, and benefit from coordinated outcomes reporting by using the ORCID registry as a hub.
- It is the researchers that benefit greatly from ORCID iDs. They can use them throughout their career, and can already use them to distinguish themselves in publications and grants. And many are starting to see the benefits of using ORCID records in outcome tracking. For example, researchers in Portugal who receive federal funding provide their ORCID iD, and benefit from coordinated outcomes reporting by using the ORCID registry as a hub.
- It is the researchers that benefit greatly from ORCID iDs. They can use them throughout their career, and can already use them to distinguish themselves in publications and grants. And many are starting to see the benefits of using ORCID records in outcome tracking. For example, researchers in Portugal who receive federal funding provide their ORCID iD, and benefit from coordinated outcomes reporting by using the ORCID registry as a hub.
- Mostly to assert university affiliation, but if they want to assert other things –awards, publications, etc. That is also great
- It is the researchers that benefit greatly from ORCID iDs. They can use them throughout their career, and can already use them to distinguish themselves in publications and grants. And many are starting to see the benefits of using ORCID records in outcome tracking. For example, researchers in Portugal who receive federal funding provide their ORCID iD, and benefit from coordinated outcomes reporting by using the ORCID registry as a hub.
- It is the researchers that benefit greatly from ORCID iDs. They can use them throughout their career, and can already use them to distinguish themselves in publications and grants. And many are starting to see the benefits of using ORCID records in outcome tracking. For example, researchers in Portugal who receive federal funding provide their ORCID iD, and benefit from coordinated outcomes reporting by using the ORCID registry as a hub.