ORCID

NB: this documentation is out of date as noted in issue 1485 (https://github.com/BirkbeckCTP/janeway/issues/1485). ORCID integration is being updated in a work package being completed by CDL. Login with ORCID will continue to work as the ORCID_API_URL is currently not in use by core.

Currently Janeway's only ORCiD operation is login, though in the future we hope to be able to allow authors to link papers directly to their ORCiD account from within Janeway.

Logging in with ORCiD requires some setup, and changes to settings in settings.py.

Here are the ORCiD settings:

ORCID_API_URL = 'https://pub.orcid.org/v1.2_rc7/'
ORCID_URL = 'https://orcid.org/oauth/authorize'
ORCID_TOKEN_URL = 'https://pub.orcid.org/oauth/token'
ORCID_CLIENT_SECRET = ''
ORCID_CLIENT_ID = ''

Janeway uses ORCiD's API version 1.2. You wont need to change the URL or TOKEN_URL, but will need to get a CLIENT_SECRET and CLIENT_ID. These can be obtained by registering with ORCiD and selecting the Developer Tools option.

You will need to add a Redirect URL for each of your journals in the domain or path format. The redirect URL is located at /login/orcid/

Domain Examples

• https://journal_one.example.com/login/orcid/
• https://journal_two.example.com/login/orcid/

Path Examples

• https://example.com/journal_one/login/orcid/
• https://example.com/journal_two/login/orcid/

If a user attempts to login with ORCiD and:

1. They have not added their ORCiD to their profile: they can login to link their accounts
2. They have not got an account on your site: they can register and link their accounts

ORCiD operations are handled by utils.orcid.py

ORCiD developer tools page: https://orcid.org/developer-tools