Thanks for meeting with me today. Here are the links to the documentation that will be helpful for you:
ORCID has 3 APIs: Public, Basic Member, and Premium Member:
- Comparison chart: https://orcid.org/about/membership/comparison - the public API allows for only reading data from ORCID, the member API allows for both reading and writing data from/to ORCID. The premium membership also allows for webhooks notifications.
- Prices for membership: https://orcid.org/about/membership - contact CRKN for Canadian consortium prices
You will need to get sandbox credentials for development and testing:
- To get public API sandbox credentials: go to https://sandbox.orcid.org/register and register for a sandbox ORCID iD (using a mailinator.com email address), then see documentation: https://support.orcid.org/hc/en-us/articles/360006897174-Register-a-public-API-client-application
- To get member API sandbox credentials: fill out this form: https://orcid.org/content/register-client-application-sandbox - ORCID will send you a client ID and client secret. However, you can not get production credentials unless your organization is an ORCID member.
Read this: Getting started with ORCID API: https://members.orcid.org/api/getting-started
- You will need to create a fake ORCID iD in the sandbox for testing at https://sandbox.orcid.org/register - make sure to use a @mailinator.com email address
- You will need to make sure the authorization URL that is already built in to VIVO is updated to include the scopes that you want to use: ORCID scopes: https://members.orcid.org/api/oauth/orcid-scopes
Other helpful documentation:
- ORCID model: https://github.com/ORCID/orcid-model
- Data fields in ORCID: https://www.lyrasis.org/Leadership/Pages/ORCID-Data-Fields.aspx
- ORCID schema, sample files, etc: https://github.com/ORCID/orcid-model/tree/master/src/main/resources/record_3.0
- How to read data from ORCID: https://members.orcid.org/api/tutorial/read-orcid-records
- How to write data to ORCID: https://members.orcid.org/api/tutorial/update-orcid-records
- How to use webhooks: https://members.orcid.org/api/tutorial/webhooks
Best,
Sheila
Sheila Rabun, MA, MLIS https://orcid.org/0000-0002-1196-6279
ORCID US Community Specialist
Web: http://orcid-us.org
Twitter: https://twitter.com/USconsortium
