Integrating ORCID v3 API for Author Identification & Reviewer Credit
Comprehensive implementation guide for the ORCID v3 API in OJS. Learn how to configure OAuth2 credentials, send automated verification emails, and deposit reviewer credit.
Real Problem
Allowing authors to type plain-text ORCID numbers leads to typos, fake credentials, and an inability to automatically sync publication records to ORCID profiles.
Practical Solution
Deploy the official PKP ORCID Profile Plugin with the ORCID v3 API, enabling OAuth2 single sign-on authentication, automated email verification links, and Reviewer Credit synchronization.
The Essential Value of ORCID in Contemporary Research
Open Researcher and Contributor ID (ORCID) provides unique, persistent digital identifiers for scholars, distinguishing researchers with common names (such as "John Smith" or "Wei Zhang") and connecting their publications, grants, and peer review contributions across their entire career.
Major international funding bodies (including NIH, Wellcome Trust, and the European Research Council) mandate that researchers submit works using authenticated ORCID iDs.
Step 1: Obtaining ORCID API Credentials
1. Create or log into your account at orcid.org.
2. Navigate to Developer Tools.
3. Register your journal application:
- Application Name: Journal of Academic Research
- Website URL: https://journal.institution.edu
- Redirect URI: https://journal.institution.edu/index.php/jar/orcid/authorize
4. Copy your Client ID and Client Secret.
Step 2: Configuring the ORCID Profile Plugin in OJS
Navigate to Settings > Website > Plugins > Generic Plugins > ORCID Profile Plugin:
- API Type: Select ORCID Public API (or ORCID Member API if your university is an institutional member).
- Client ID: Paste your 16-character client ID.
- Client Secret: Paste your confidential client secret.
- ORCID API Environment: Select Production (orcid.org). Use Sandbox (sandbox.orcid.org) only for local testing.
Step 3: The Author Authentication Workflow
Once configured, authors encounter a "Create or Connect your ORCID iD" button during registration and submission:
1. Clicking the button redirects the author securely to orcid.org.
2. The author logs in and grants permission to the journal.
3. ORCID redirects the author back to OJS with an authorization code.
4. OJS exchanges the code for a verified access token and stores the authenticated ORCID iD in the database.
A green authenticated ORCID icon is now permanently displayed beside the author’s name on all published article landing pages and in Crossref metadata deposits.
Step 4: Automated Co-Author Verification Emails
When a primary author submits a paper listing five co-authors, OJS automatically generates personalized authorization emails to each co-author containing an authenticated link, ensuring all collaborators receive verified attribution prior to publication.
Step-by-Step Action Plan
Register for ORCID API Credentials
Obtain Public or Member API Client ID and Client Secret from the official ORCID Developer Portal.
Install ORCID Profile Plugin
Install the verified ORCID Profile Plugin from the PKP Plugin Gallery in your OJS administration panel.
Configure OAuth2 Redirect URIs
In the ORCID Developer Portal, register your journal’s exact redirect callback URI matching the OJS plugin endpoint.
Configure config.inc.php & Plugin Settings
Input Client ID, Client Secret, and select the production ORCID v3 endpoint in the plugin settings modal.
Enable Automated Author Authorization Emails
Activate automated emails prompting co-authors to authenticate their ORCID iDs upon submission acceptance.
Questions People Usually Ask
What is the difference between the ORCID Public API and Member API?
The Public API is free and allows authors to authenticate and link their verified ORCID iDs. The Member API (requires institutional membership) allows journals to automatically write published articles and peer review credit directly into the researcher’s ORCID profile.
Why can’t authors just type their 16-digit ORCID into their profile?
Unauthenticated typing frequently leads to typographical errors or unauthorized claims of another researcher’s profile. Leading indexers mandate cryptographically authenticated OAuth2 ORCID links.
Can reviewers receive public recognition on their ORCID profile for blind reviews?
Yes! When using the Member API, OJS deposits review credit to ORCID showing the journal name and year of review, while strictly keeping the manuscript title and author identity confidential.
Connect Your Journal to the Global ORCID Registry
AcademiaTech configures authenticated ORCID API integrations, ensuring 100% compliance with international research funder mandates.