VIVO Documentation
Page History
Table of Contents |
---|
Panel | ||
---|---|---|
|
Overview
VIVO contains code that will converse with the ORCID registry through its API. When this conversation is enabled, a VIVO user can authoritatively confirm his ORCID iD in VIVO, and cite his VIVO page in his ORCID record as an external identifier.
...
The user must grant authorization before VIVO can read or write to their ORCID record. Some of the text they see will come from your credentials. Notice this section of the application:
The name of your client application will be displayed to the user as they use the integration screens. Here is an example, where the name of the client application is "Cornell VIVO-ORCID Integration".
If the user clicks on the question mark, they will see the short description of your client application. In this example, the short description is "Connect your VIVO identity with your ORCID identity."
Connecting to your application
Once the user logs in to their ORCID account, and grants authorization to your application, the ORCID pages will transfer control of the session back to VIVO. In order to do that, it needs to know where your application is located. Notice this section of the application:
You may provide just the domain of your application, such as http://vivo.mydomain.edu
.
...
Property name | orcid.messageVersion |
---|---|
Description | The version of ORCIDs API protocol that VIVO will expect.The integration code in VIVO 1.7 requires a value of |
Default value | NONE |
Example value | 1.0.23 |
...
Property name | orcid.oauthAuthorizeUrl |
---|---|
Description | The entry point for ORCID's OAuth implementationThis changes, depending on whether you are using the sandbox API or the production API. |
Default value | NONE |
Example value | http://sandbox.orcid.org/oauth/authorize http://orcid.org/oauth/authorize |
...
Property name | orcid.oauthTokenUrl |
---|---|
Description | A callback URL within ORCID's OAuth implementationThis changes, depending on whether you are using the sandbox API or the production API. |
Default value | NONE |
Example value | http://api.sandbox.orcid.org/oauth/token http://api.orcid.org/oauth/token |