Page History

...

# These URLs are for testing against ORCID's Sandbox API
# These are only useful for testing, and you must first request a Sandbox API Key from ORCID
orcid.domain-url= https://sandbox.orcid.org
orcid.api-url = https://api.sandbox.orcid.org/v3.0
orcid.public-url = https://pub.sandbox.orcid.org/v3.0
# Keep in mind, these API keys MUST be for the Sandbox API if you use "sandbox.orcid.org" URLs above!
orcid.application-client-id = <YOUR-SANDBOX-ORCID-CLIENT-ID>
orcid.application-client-secret = <YOUR-SANDBOX-ORCID-CLIENT-SECRET>

# Once you are ready to switch to Production, you need to update these settings to use ORCID's production API
# See https://github.com/ORCID/ORCID-Source/tree/master/orcid-api-web#endpoints
# orcid.domain-url= https://orcid.org
# orcid.api-url = https://api.orcid.org/v3.0
# orcid.public-url = https://pub.orcid.org/v3.0
# DON'T FORGET TO UPDATE YOUR API KEY! It must be a valid Public or Member API Key
# orcid.application-client-id = <YOUR-PRODUCTION-ORCID-CLIENT-ID>
# orcid.application-client-secret = <YOUR-PRODUCTION-ORCID-CLIENT-SECRET>

• Enable in Production: To enable the main integration (i.e. connect a local profile with ORCID and push data to the ORCID registry) you

...

• MUST to be an ORCID Member, get a Member API Key and properly enable and configure the feature in DSpace.  See also "How do I register for Member API credentials?" from ORCID.
• Enable in Testing: To test ORCID integration, it's possible to use the ORCID Sandbox (without being an ORCID member). However, to do so, you must request a Sandbox Member API Key. See also "How do I register a public api client?".
• Setting the "redirect URL" in ORCID: In the ORCID API Credentials request form you will be asked to enter one or more redirect URLs for

...

• your application (DSpace). You will need to enter here the root URLs of your REST and

...

• user interfaces, which could be different.

...

• If the root URLs of both are the same, then just enter the URL of your

...

• user interface.
  • For example, for the DSpace 7 official demo, we use these

...

• • redirect URLs:

  ...

  • • • User Interface: https://demo7.dspace.org   (please note the absence of a /home or any

  ...

  • • • subpaths)
      • REST API: https://api7.dspace.org (please note the absence of a

  ...

  • • • /server or any subpaths)
    • For more information on valid ORCID redirect URLs, see "How do redirect URIs work?" from ORCID. 
  • Configure the Client ID and Client Secret in DSpace: Once ORCID has reviewed and approved your request, you will get from them the Client ID and Client Secret that need to be set in the local.cfg  among other properties See the configuration examples above.

  Please note that by default DSpace will request permissions to READ and WRITE all the information from the ORCID profile, as this will enable support for all of the features. You can fine-tune that by overriding the following properties. Please note that if you are going to configure Public API Credentials you MUST update this configuration keeping only the /authenticate  scope as all the other scopes require Member API.

  ...

  Code Block
  2022-08-04 11:43:42,124 ERROR unknown unknown org.dspace.authenticate.OrcidAuthenticationBean @ An error occurs registering a new EPerson from ORCID java.lang.IllegalStateException: The email is configured private on orcid

  
  

  After logging in via ORCID, a new DSpace account was created instead of using my existing DSpace account

  Currently, the ORCID integration with DSpace relies on a matching email address to find your existing account.  If your ORCID account and DSpace account have different email addresses associated with them, then it is possible that a new (duplicative) user account will be created. 

  I'm having trouble creating test accounts on ORCID to experiment with the features

  ...