Integrations need to store more than just ORCID records. Your system will need to be able to:
- Accept and store ORCID iDs: Your system will need to know the iD of the ORCID record to display the iD and to update correctly. Store it together with the researcher’s information which is returned in the token exchange response. Our recommendation is to store the full https URI: https://orcid.org/0000-0001-5727-2427.
- Accept and store persistent access tokens and refresh tokens: Access tokens can be used to read and update records, as well as indicate that the iD has been authenticated. Access tokens are valid for approximately 20 years or until the user revokes them. We also recommend you store the token scope, token expiry and refresh tokens. Refresh tokens can be used to create new access tokens with the same or limited scopes if required. Store the access token token data together with the researcher’s information.
- Accept and store put codes : Every item that you add to the ORCID Registry will be returned with a put code by the ORCID API. Save this 6 digit put code along with the item in your system‚ it’s how you will identify which item needs to be read, updated or deleted.
- Provide error messages and a support contact when an interaction does not go as expected.