You may be trying to access this site from a secured browser on the server. Please enable scripts and reload this page.
Turn on more accessible mode
Turn off more accessible mode
Skip Ribbon Commands
Skip to main content
Turn off Animations
Turn on Animations
SharePoint
Sign In
Sign In
Sign In
My LYRASIS
Lyrasis Learning
It looks like your browser does not have JavaScript enabled. Please turn on JavaScript and try again.
HOME
Innovation and Learning
Currently selected
Lyrasis Learning
Classes
Course Catalog
Member Summit
Leaders Forums
Catalyst Fund
Leaders Circle
Consulting
Open Source Sustainability
Lyrasis Research
Knowledge and Content
Program Overview
Featured Offers
Open Access Programs
All Offers
Digitization
Hosting Services
Hosting Services
ArchivesSpace Hosting
CollectionSpace Hosting
DSpaceDirect Hosting
DuraCloud
Islandora Hosting
Palace Hosting
Community Programs
ArchivesSpace
CollectionSpace
DSpace
DataCite US Community
Fedora
The Palace Project
It Takes a Village
ORCID US
VIVO
Membership
Become a Member
Our Members
Member Dues
New Membership Application
About
Mission and Strategic Plan
Our Members
Meet the Teams
Lyrasis Now Blog
Member Services
Annual Report
Board of Trustees
Careers at LYRASIS
Contact
News
Staff Directory
Job Bank
Job Bank Submission Form
Code of Conduct
US Community
API Basics
What is the ORCID API?
ORCID
= Open Researcher & Contributor Identifier (learn more
about ORCID
)
API
= Application Programming Interface (APIs allow machine-to-machine communication between different software systems)
The
ORCID API
provides instructions for configuring a system to communicate with the ORCID registry and thus individual researchers’ ORCID iD records
ORCID provides two
API options
:
Public API
- Anyone with an ORCID iD can use the API to search for and read publicly visible data in ORCID
Member API
- Member organizations can use the API to connect with their affiliated researchers’ ORCID iD records as “
trusted parties
” to read public & limited-access data as well as to write data to ORCID records
What are the benefits of using the ORCID Member API?
The ORCID Member API allows research institutions to
gather authenticated ORCID iDs
read and write
the following types of data on an individual’s ORCID record electronically to save time and reduce administrative burden:
Biographical
information
Past and current
employment
,
education
,
memberships, & service
Funding
awards received
Works
and contributions, including
peer review
activity
Research resources
used ( such as labs, facilities, equipment, collections, etc.)
What systems can use the ORCID API?
Any system can be configured to integrate with the ORCID API, although
vendor systems
require the vendor to configure the integration, whereas open source or home-built
custom systems
require a developer to configure the integration. Common types of systems include central ID management and HR systems, research reporting and profiling, grants management, publishing, and repositories (see a list of c
ommon systems in the US
and
ORCID workflows
for various types of systems).
How does the ORCID API work?
The basis of the ORCID API is
OAuth 2.0
, which enables authenticated connections between researchers’ ORCID iD records and a system (see ORCID’s
OAuth workflow
)
Data is transferred between the ORCID registry and systems via XML or JSON
ORCID is a
RESTful
API: HTTPS calls are required to communicate between the ORCID registry and a system (see
tutorials
)
Where to go for more information?
Start
exploring the ORCID APIs
and learn how to
get started with a custom integration
. Link to this document:
https://www.lyrasis.org/Leadership/Documents/ORCID-API.pdf
ORCID US Menu
ORCID US
Membership
Technical Support
Community Resources
Get Involved
FAQ
ORCID API Basics (PDF)
Lyrasis Learning
Classes
Course Catalog
Member Summit
Leaders Forums
Catalyst Fund
Leaders Circle
Consulting
Open Source Sustainability
Lyrasis Research
Please ensure Javascript is enabled for purposes of
website accessibility