Tutorial: ORCID Profile Plugin Setup
Role: Journal Manager / Site Administrator
Time: 20–40 minutes
OJS Version: 3.5+
This tutorial explains how to enable the ORCID Profile Plugin in OJS, obtain ORCID API credentials, and configure the plugin so that authors can connect their ORCID iDs during submission.
Before You Start
- You have Journal Manager or Site Administrator access in OJS.
- Your journal has a public-facing URL (required for the ORCID redirect callback).
- You have registered for ORCID API credentials (see Step 1 below).
ORCID (Open Researcher and Contributor ID) is a persistent digital identifier for researchers. The ORCID Profile Plugin lets authors authenticate their iDs directly in OJS, and the verified iDs are included in CrossRef metadata deposits.
Step 1 — Register for ORCID API Credentials
- Go to orcid.org/content/register-client-application.
- Log in with your ORCID account (or create one at orcid.org/register).
- Choose one of the following API tiers:
| API Tier | Use Case | Cost |
|---|---|---|
| Public API | Basic iD collection and display | Free |
| Member API | Writes to author ORCID records; auto-update publications | Requires ORCID membership |
- Fill in the registration form:
- Application name: Your journal name
- Application URL: Your OJS journal home URL
- Redirect URIs:
https://yourdomain.com/index.php/journalCode/orcidapi/orcidAuthorize
- Submit. ORCID will provide a Client ID and Client Secret — save these.
Step 2 — Install the ORCID Profile Plugin
If the plugin is not already installed:
- Go to Administration → Plugin Gallery.
- Search for ORCID Profile.
- Click Install.
If it is already listed under Installed Plugins, skip this step.
Step 3 — Enable and Configure the Plugin
- Go to Settings → Website → Plugins → Installed Plugins.
- Find ORCID Profile Plugin and toggle it to Enabled.
- Click the Settings (gear) icon next to the plugin.
- Fill in the settings:
| Field | Value |
|---|---|
| ORCID API | Select Public API or Member API |
| Client ID | Your ORCID Client ID (from Step 1) |
| Client Secret | Your ORCID Client Secret (from Step 1) |
| Send email to request author ORCID | Enable to automatically invite authors to authenticate |
| Require ORCID for submission | Optional — tick to make ORCID authentication mandatory |
- Click Save.
Step 4 — Test the Integration
- Log out of OJS.
- Register a test author account and begin a new submission.
- In the Contributors step, you should see an "Authenticate with ORCID" button next to each contributor.
- Click the button — you will be redirected to orcid.org to authorise.
- After authorising, you will return to OJS with the ORCID iD filled in and marked as authenticated.
Step 5 — Display ORCID iDs on Article Pages
OJS displays authenticated ORCID iDs on article landing pages automatically. Verified iDs show the ORCID icon (green) next to the author name.
If iDs are not displaying, check:
- The DOI plugin is enabled (ORCID data is included in CrossRef deposits).
- Your article template includes the ORCID metadata block.
Troubleshooting
| Problem | Solution |
|---|---|
| Redirect error after ORCID authentication | Check the redirect URI in your ORCID application matches your OJS URL exactly |
| Client ID / Secret rejected | Ensure you are using Public API credentials with the Public API setting, or Member API credentials with Member API |
| ORCID button not appearing in submission | Check the plugin is enabled and settings are saved |
| Authors not receiving email invitation | Check your OJS SMTP configuration is working |
Next Steps
- Enable DOIs with CrossRef — include ORCID iDs in CrossRef metadata deposits
- Plugins Reference — overview of all OJS plugins
- ASEO & Discoverability — how ORCID iDs improve indexing and discoverability