Introduction for developers

The information you need to start integrating persistent identifiers PIDs depends on your use cases. Some services will be concerned with creating DOIs while others simply need to query the metadata. Likewise, some systems may require authenticated ORCID IDs to aid interoperability, others will want to retrieve metadata or update records.

Integrating DOIs

Querying DOI metadata

Querying DOI metadata is as simple as making a request to the DOI URL using content negotiation. See Accessing DOI metadata for more details.

Searching DOI registries

Searching DOI registries is complicated by the fact there is more than one of them. Each offers its own search API. Searching DOI registries contains more information.

Creating DOI metadata

Creating DOI metadata is a bit more complex. You need to work with a DOI registration agency, become a member, create XML in the correct format and submit it. Workflows vary between registrars. Creating DOIs and DOI metadata. explains this in more detail.

Integrating ORCID

ORCID has a Public API and a Member API. At a high level, the public API is read only and the member API allows updates. With the user's permission, the member API also enables you to query data users have marked as 'limited access' and set up notifications.

There are other differences so make sure you understand the difference and choose the right one for your use case.

Querying ORCID metadata

The ORCID API enables client applications to retrieve biographical information about a researcher and their works, peer review activities, education and employment. The ORCID Public API section contains a couple of examples and further information.

Updating ORCID records

Updating records requires the ORCID Member API. With the members permission, you can add and update an ORCID record.

Authenticating ORCID users

ORCID uses OAuth to authenticate users and authorise actions with the API. The two-step (application) flow is used to access public data or authenticate a user. Actions that require user authorisation use the three-legged approach. See the ORCID API - Authenticating users section for more details.

Searching the ORCID registry

ORCID exposes a SOLR endpoint for machine to machine searching. Searching ORCID explains how this works with examples.

See the tutorial Hands on with the ORCID API: Getting Authenticated ORCID iDs, OAuth Permissions and updating records for more information.

External information

There is a great integration presentation on the ORCID website that walks through the integration process. There is also extensive ORCID API documentation

There is an excellent help system at Crossref and API documentation at Datacite contains detailed information about using content negotiation to resolve DOIs into metadata.