rorcid is an R programmatic interface to the Orcid public API.
rorcid is not a product developed or distributed by ORCID®.
rorcid docs: https://docs.ropensci.org/rorcid/
Orcid API docs:
The package now works with the
v3.0 ORCID API. It’s too complicated to allow users to work with different versions of the API, so it’s hard-coded to
There are three ways to authenticate with
client_secretto do 2-legged OAuth. ORCID docs at https://members.orcid.org/api/oauth/2legged-oauth and https://members.orcid.org/api/post-oauthtoken-reading-public-data This requires you to register a “client application”. See https://orcid.org/content/register-client-application-2 for instructions
dc0a6b6b-b4d4-4276-bc89-78c1e9ede56e. You can get this token by running
orcid_auth(), then storing that key (the uuid alone, not the “Bearer” part) either as en environment variable in your
.Renvironfile in your home directory (with the name
ORCID_TOKEN), or as an R option in your
.Rprofilefile (with the name
orcid_token). See [Startup] for more information. Either an environment variable or R option work. If we don’t find either we do the next option.
We recommend the 3rd option if possible, specifically, storing the token as an environment variable permanently.
If authentication fails, you can still use
rorcid. ORCID does not require authentication at this point, but may in the future - this prepares you for when that happens.
See https://info.orcid.org/documentation/integration-guide/getting-started-with-your-orcid-integration/#easy-faq-2569 for more about ORCID OAuth Scopes.
One pitfall is when you are using
rorcid on a server, and you’re ssh’ed in, so that there’s no way to open a browser to do the OAuth browser flow. Similarly for any other situation in which a browser can not be opened. In this case, run
orcid_auth() on another machine in which you do have the ability to open a browser, then collect the info that’s ouptput from
orcid_auth() and store it as an environment variable (see above).
Get started with rorcid at https://docs.ropensci.org/rorcid/