Omeka S has an incomplete module for talking to ORCID, so there might be some code in there to look at

The OAuth step might be tricky -- at least when I was working on it they were pretty firm about authentications. There are methods in the Module.php file and the controller that might be a starting point.


Module to pull data about researchers from ORCID into Omeka S installations - omeka-s-modules/OrcidConnector

Patrick Murray-John

Associate Director for Systems

Digital Scholarship Group, Snell Library

Northeastern University

[log in to unmask]

From: Code for Libraries <[log in to unmask]> on behalf of Owen Stephens <[log in to unmask]>
Sent: Wednesday, July 31, 2019 6:48:07 AM
To: [log in to unmask] <[log in to unmask]>
Subject: Re: [CODE4LIB] ORCID

The ORCID API is documented at;data=02%7C01%7Cp.murray-john%40NORTHEASTERN.EDU%7C16e49dbfd29c45c8135708d715a4ba8c%7Ca8eec281aaa34daeac9b9a398b9215e7%7C0%7C0%7C637001669566818318&amp;sdata=6d9KOae35ZFI1VbeYzrviPYSZpa4gqLh5xHEGQKkneQ%3D&amp;reserved=0. Despite the URL this includes information on the public API as well;data=02%7C01%7Cp.murray-john%40NORTHEASTERN.EDU%7C16e49dbfd29c45c8135708d715a4ba8c%7Ca8eec281aaa34daeac9b9a398b9215e7%7C0%7C0%7C637001669566818318&amp;sdata=avFjzoLlkaSkCqucAU%2B3Qf5NdnBEEMdbrFSlPRJQyAE%3D&amp;reserved=0

In case it is of any interest, in the UK Jisc has run several hackdays around using the ORCID API and there are some outputs from the latest round at;data=02%7C01%7Cp.murray-john%40NORTHEASTERN.EDU%7C16e49dbfd29c45c8135708d715a4ba8c%7Ca8eec281aaa34daeac9b9a398b9215e7%7C0%7C0%7C637001669566818318&amp;sdata=xqAvpYd2yy19VT21q1Zn0VXe5bXfoaMs2xQs1qwV6CI%3D&amp;reserved=0

The hackday had a slightly broader topic than just working with the API so not all the outputs might be relevant, but in particular you might be interested in the app I wrote which is designed to retrieve information based on an institution identifier (Ringgold).

The app is at;data=02%7C01%7Cp.murray-john%40NORTHEASTERN.EDU%7C16e49dbfd29c45c8135708d715a4ba8c%7Ca8eec281aaa34daeac9b9a398b9215e7%7C0%7C0%7C637001669566818318&amp;sdata=xs9GxpU6oitmi1P9NXmCciiJIlVxJ0hnk%2BfhJXi8TWs%3D&amp;reserved=0
The code is at;data=02%7C01%7Cp.murray-john%40NORTHEASTERN.EDU%7C16e49dbfd29c45c8135708d715a4ba8c%7Ca8eec281aaa34daeac9b9a398b9215e7%7C0%7C0%7C637001669566828322&amp;sdata=hP3sRmf0QX2PPgmushEEmjNAWM%2Fg7Q6t727f9EYHbJE%3D&amp;reserved=0

The app finds all ORCIDs related to a specific institution based on ringgold ID using:;data=02%7C01%7Cp.murray-john%40NORTHEASTERN.EDU%7C16e49dbfd29c45c8135708d715a4ba8c%7Ca8eec281aaa34daeac9b9a398b9215e7%7C0%7C0%7C637001669566828322&amp;sdata=R9DQXUK3vS%2B%2B387jIrVi%2FylFNTUxldFhaZCIZM1sR%2Bc%3D&amp;reserved=0:<ringgold ID>&rows=200

200 is max records you can retrieve in one go so you have to page through results 200 at a time

Details for an individual ORCID can be retrieved using;data=02%7C01%7Cp.murray-john%40NORTHEASTERN.EDU%7C16e49dbfd29c45c8135708d715a4ba8c%7Ca8eec281aaa34daeac9b9a398b9215e7%7C0%7C0%7C637001669566828322&amp;sdata=1SldEDnqLj3ID9t4AbKGBhSNoDgFTJ2hmMsJ%2FaB%2B3YY%3D&amp;reserved=0<orcid>

This returns XML by default. You can change this by setting a http Accept header in your request

To demo the app above this is the URL for USRA affiliated ORCIDs:;data=02%7C01%7Cp.murray-john%40NORTHEASTERN.EDU%7C16e49dbfd29c45c8135708d715a4ba8c%7Ca8eec281aaa34daeac9b9a398b9215e7%7C0%7C0%7C637001669566828322&amp;sdata=%2FCZv8hc1sdnvAahjup%2F%2Bb89dXNW%2Fp4tNj8CgqylEOr4%3D&amp;reserved=0

As Kyle noted, retrieving data on ORCIDs with some Ďaffiliationí to your institution requires that the person who the ORCID is for has stated that they are affiliated (either as employee or as student) to your institution. In addition you can control whether data on your ORCID profile is public or not. Because the app Iíve written uses the public API only, then I only can only access data that has been set as public by the ORCID owner. This is a key point of ORCID - data is under the researchers control - but it makes for challenges in terms of instituitons getting a clear view of who in their institution has an ORCID and what data is recorded.

The other place you may find integrations with the ORCID API in an institution is in CRIS systems - CRIS systems that integrate with ORCID can be used to help with the other issue Kyle noted - keeping the liset of publications on ORCID up to date.

Finally, on a slightly more general point, if you want an introduction to Web APIs such as the one used by ORCID then I wrote this a few years ago which might be helpful;data=02%7C01%7Cp.murray-john%40NORTHEASTERN.EDU%7C16e49dbfd29c45c8135708d715a4ba8c%7Ca8eec281aaa34daeac9b9a398b9215e7%7C0%7C0%7C637001669566828322&amp;sdata=8vCnzO2ahI1u1uq7ocTXMoTEanC7pIH3R8LD55A9U2M%3D&amp;reserved=0

Best wishes


Owen Stephens
Owen Stephens Consulting
Email: [log in to unmask]
Telephone: 0121 288 6936

> On 30 Jul 2019, at 16:16, Bigwood, David <[log in to unmask]> wrote:
> ORCID provides an API that can be queried by ORCID or institution name (I think). Has anyone written code to query the API on a regular basis to pull down articles by their faculty? Is it something you'd care to share? I've not the faintest idea of a way to write an API query.
> Thanks,
> David Bigwood
> [log in to unmask]<mailto:[log in to unmask]>
> Regional Planetary Image Facility/Library
> Lunar and Planetary Institute