APIs and Documentation

Knowledge Hub PIDs for Developers
1

Documentation for some of the main PID providers is described below. For more details about working with these, see Working with some PID Providers

DataCite

The DataCite REST API allows any user to retrieve, query and browse DataCite DOI metadata records. In addition, DataCite Clients can register DOIs and DataCite Providers can manage Clients and prefixes via the API. DataCite’s REST API documentation is available here

Graph QL: The DataCite GraphQL API powers the PID Graph, containing information about all DataCite DOIs, all ORCID IDs, 9 million Crossref DOIs and all of the Research Organization Registry (ROR). The API supports queries in the GraphQL query language and is an alternative to the DataCite REST API. It currently only supports queries, but not mutations (create or update actions, e.g. registering a new DOI), or subscriptions.
Examples how to use GraphQL API can be found in the PID Graph category of the PID Forum and in Jupyter notebooks

Prov API: Exposing DOI metadata provenance

There are also links from this page to other APIs offered by DataCite, including the Event Data API which allows for the collection and exposure of links to Crossref and DataCite DOIs and to track usage of them.

Crossref

Documentation for Crossref’s API is available through Github here They have also described various case studies.

ORCID

ORCID offers two APIs (Application Programming Interfaces) that allow organizations to connect with individual users’ ORCID records. Documentation and case studies for the public API is available here. The member API documentation is only accessible to ORCID members. All the documentation that you need to build your own custom integration using our APIs can be found starting here. You can also find out what you need to do if you are using a third-party system that has already integrated with ORCID.

For a first look into ORCID go to sample workflows and suggested integration points, which provides detailed information and best practices for organizations that are integrating ORCID into their systems. To start planning the integration as an experienced user start with the basic tutorials for step-by-step instructions on how to read, add, and update your users’ ORCID records. You can also access our Swagger UI for our public and member APIs. For in depth technical information visit there Github pages. Here you can find tutorials as well as version 2.1 and the latest 3.0_rc1 specific documentation.

A ‘Sandbox’ version for practice integration work is also offered, letting you create test user accounts and develop your integration without having to worry about affecting data on the live (production) ORCID Registry.

Turtorial on searching ORCID

ROR

ROR provides organization identifiers that are globally unique, stable, discoverable, and resolvable. See New Types of Persistent Identifiers. More information about this can be found Some useful links can be found below.

3 Likes