Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

Info
titleOrcid Api Version 3

Currently the last line of development DSpace-CRIS 5.10.x  use ORCID API v3, see https://members.orcid.org/api/news/xsd-30-update


Info
titleORCID API version

Since DSpace-CRIS 5.8.0 we use the ORCID API v2, see https://members.orcid.org/api/news/xsd-20-update

...

Info
titleORCID Metadata mandatory definition

Note that "orcid" metadata in the Researcher Profile entity MUST be a "text" property definition (check https://github.com/4Science/DSpace/blob/dspace-5_x_x-cris/dspace/etc/orcid_from_link_to_text.sql to perform the migration)


Info
titleAbout ORCID

more info about ORCID here https://orcid.org/


DSpace-CRIS provides the most advanced and complete integration between a CRIS / Repository system and ORCID, achieving most of the ORCID integration use cases.

...

Code Block
#####################
# ORCID
#####################
#Production Registry
#Step        |     Member API                                |    Public API
#--------------------------------------------------------------------------------------------------------
#Authorize   |    https://orcid.org/oauth/authorize          |    https://orcid.org/oauth/authorize
#Exchange    |    https://orcid.org/oauth/token              |    https://orcid.org/oauth/token
#Use         |    https://api.orcid.org/v2v3.10                 |    https://pub.orcid.org/v2v3.10
#--------------------------------------------------------------------------------------------------------
#
#Sandbox
#Step        |     Member API                                |    Public API
#--------------------------------------------------------------------------------------------------------
#Authorize   |     https://sandbox.orcid.org/oauth/authorize |    https://sandbox.orcid.org/oauth/authorize
#Exchange    |     https://sandbox.orcid.org/oauth/token     |    https://sandbox.orcid.org/oauth/token
#Use         |     https://api.sandbox.orcid.org/v2v3.1o        |    https://pub.sandbox.orcid.org/v2v3.10
#--------------------------------------------------------------------------------------------------------
authentication-oauth.orcid-api-url = https://pub.orcid.org/v2v3.10
authentication-oauth.application-token-url = https://orcid.org/oauth/token
authentication-oauth.application-authorize-url = https://orcid.org/oauth/authorize

# register for free on ORCID to use an institutional Public API
# IMPORTANT!! Please fill authentication-oauth.application-client-name with name of client registered into orcid registries (need by the putcode flow retrieve) 
authentication-oauth.application-client-name =
authentication-oauth.application-client-id =
authentication-oauth.application-client-secret =
authentication-oauth.application-client-redirect = ${dspace.baseUrl}/oauth-login

# If you have only PUBLIC API the scope need to be; /authenticate scope now includes /read-public scope
authentication-oauth.application-client-scope =/authenticate
# if you have MEMBER API the suggested scopes are as following; /authenticate scope now includes /read-public scope
#authentication-oauth.application-client-scope =/authenticate /read-limited /person/update /activities/update

...

Info

The synchronization procedures use a convention to discover which preference are available, see Mapping local properties to ORCID 81953196 below.

The system monitors changes to the researcher profile and linked entities (publications and projects) putting in a queue (the orcid_queue table on the database) the list of objects that it is necessary to synchronize. This is done for the DSpace items via a consumer enabled by default in the dspace.cfg

...