This documents describes the application programmer interface (API) for querying and
searching the ORCID system. This API will allow third parties to integrate ORCID profiles into
their submission and evaluation systems.
The document provides an introduction to the ORCID API, including what an API is, how the ORCID API works, and how to access the ORCID API. It discusses the ORCID registry, the sandbox and production APIs, application credentials, search queries, OAuth authentication, and examples of searching through the public API using cURL commands.
The Crossref/ORCID Auto-Update: all you need to knowCrossref
This webinar describes the practical details of the ORCID auto update functionality that authors and publishers need to know.
It covers:
- Purpose and benefits
- What researchers need to know
- What Crossref publishers need to know
This presentation took place on October 29, 2015.
The link to the recording of this webinar is: https://bitly.com/orcidautoupdatewebinar.
ORCID Outreach Conference 2014 Best practices technicalPeter Flynn
This document summarizes Boston University's integration of ORCID identifiers into their faculty profiles system. It describes how BU created a standalone web application to allow faculty to create ORCID identifiers, provide existing identifiers, and update ORCID profile information from BU profile data. It also discusses how BU merged this functionality into a new version of their profiles system, including creating relevant database tables, using the ORCID API to create and update profiles, and some issues encountered during development.
Simple Object Access Protocol (SOAP) and Representational State Transfer (REST) are two answers to the same question: how to access Web services. The choice initially may seem easy, but at times it can be surprisingly difficult. SOAP is a standards-based Web services access protocol that has been around for a while and enjoys all of the benefits of long-term use. Originally developed by Microsoft, SOAP really isnt as simple as the acronym would suggest. The Difference between SOAP vs REST APIs REST is the newcomer to the block. It seeks to fix the problems with SOAP and provide a truly simple method of accessing Web services. Shabnam Kumari | Deepak"REST based API" Published in International Journal of Trend in Scientific Research and Development (ijtsrd), ISSN: 2456-6470, Volume-1 | Issue-4 , June 2017, URL: http://www.ijtsrd.com/papers/ijtsrd2200.pdf http://www.ijtsrd.com/computer-science/computer-security/2200/rest-based-api/shabnam-kumari
What is the ORCID API and what you can do with it? (R. Peters)ORCID, Inc
The ORCID API allows developers to integrate ORCID identifier services into their applications. It uses OAuth2 for authentication and provides a RESTful interface for retrieving and updating ORCID profile and activity record data. Developers can build tools that authenticate users via their ORCID ID, push citations and other works to ORCID records, and provide insights into researcher impact by linking datasets to ORCID profiles. Several existing tools demonstrate uses of the ORCID API such as allowing user profile linking, citation importing, and research analytics services.
ORCID Update - AAP PSP Annual Meeting February 2011hratner
Update on the ORCID initiative for the AAP/PSP Meeting of Publishers in Washington, DC. Demonstrates how ORCID is valuable to publishers as well as other members of the scholarly communication community.
This presentation was given by guest lecturer Jordon Holt of ORCID, Inc., during the second session of the NISO Spring training series "Working with Scholarly APIs." Session Two, ORCID, was moderated by Phill Jones of MoreBrains Cooperative and held on May 5, 2022.
Learn how to take advantage of Apigility to create APIs from scratch or to expose current functionality from an existent system. You'll learn the core API concepts, processes, functionality, logic, and in general how you can create good APIs, including documentation and all the considerations you must have.
The document provides an introduction to the ORCID API, including what an API is, how the ORCID API works, and how to access the ORCID API. It discusses the ORCID registry, the sandbox and production APIs, application credentials, search queries, OAuth authentication, and examples of searching through the public API using cURL commands.
The Crossref/ORCID Auto-Update: all you need to knowCrossref
This webinar describes the practical details of the ORCID auto update functionality that authors and publishers need to know.
It covers:
- Purpose and benefits
- What researchers need to know
- What Crossref publishers need to know
This presentation took place on October 29, 2015.
The link to the recording of this webinar is: https://bitly.com/orcidautoupdatewebinar.
ORCID Outreach Conference 2014 Best practices technicalPeter Flynn
This document summarizes Boston University's integration of ORCID identifiers into their faculty profiles system. It describes how BU created a standalone web application to allow faculty to create ORCID identifiers, provide existing identifiers, and update ORCID profile information from BU profile data. It also discusses how BU merged this functionality into a new version of their profiles system, including creating relevant database tables, using the ORCID API to create and update profiles, and some issues encountered during development.
Simple Object Access Protocol (SOAP) and Representational State Transfer (REST) are two answers to the same question: how to access Web services. The choice initially may seem easy, but at times it can be surprisingly difficult. SOAP is a standards-based Web services access protocol that has been around for a while and enjoys all of the benefits of long-term use. Originally developed by Microsoft, SOAP really isnt as simple as the acronym would suggest. The Difference between SOAP vs REST APIs REST is the newcomer to the block. It seeks to fix the problems with SOAP and provide a truly simple method of accessing Web services. Shabnam Kumari | Deepak"REST based API" Published in International Journal of Trend in Scientific Research and Development (ijtsrd), ISSN: 2456-6470, Volume-1 | Issue-4 , June 2017, URL: http://www.ijtsrd.com/papers/ijtsrd2200.pdf http://www.ijtsrd.com/computer-science/computer-security/2200/rest-based-api/shabnam-kumari
What is the ORCID API and what you can do with it? (R. Peters)ORCID, Inc
The ORCID API allows developers to integrate ORCID identifier services into their applications. It uses OAuth2 for authentication and provides a RESTful interface for retrieving and updating ORCID profile and activity record data. Developers can build tools that authenticate users via their ORCID ID, push citations and other works to ORCID records, and provide insights into researcher impact by linking datasets to ORCID profiles. Several existing tools demonstrate uses of the ORCID API such as allowing user profile linking, citation importing, and research analytics services.
ORCID Update - AAP PSP Annual Meeting February 2011hratner
Update on the ORCID initiative for the AAP/PSP Meeting of Publishers in Washington, DC. Demonstrates how ORCID is valuable to publishers as well as other members of the scholarly communication community.
This presentation was given by guest lecturer Jordon Holt of ORCID, Inc., during the second session of the NISO Spring training series "Working with Scholarly APIs." Session Two, ORCID, was moderated by Phill Jones of MoreBrains Cooperative and held on May 5, 2022.
Learn how to take advantage of Apigility to create APIs from scratch or to expose current functionality from an existent system. You'll learn the core API concepts, processes, functionality, logic, and in general how you can create good APIs, including documentation and all the considerations you must have.
The document discusses how to integrate with the ORCID API. It describes the features of the public, member, and premium member APIs. It provides examples of connecting systems like manuscript submission systems and CRIS systems to ORCID to collect and display researcher IDs. The document outlines the OAuth workflow to authenticate users and connect data to their ORCID records using the API, and resources for learning more about synchronization and custom integrations.
This presentation provides an overview of how to build and manage an ORCID profile. It discusses linking ORCID with other researcher profiles like ResearcherID and Scopus to automatically add publications. It also explains how to manually add publications, funding, patents and other works. The presentation provides information on permission settings, visibility settings, and using linked profiles on ResearcherID and Scopus to obtain metrics like an H-index.
About the Webinar
In the world of authority control, it is a bit of an alphabet soup of acronyms. ORCID (Open Researcher and Contributor ID), which is a system to uniquely identify scientific and other academic authors; ISNI (International Standard Name Identifier), which identifies the public identities of contributors to media content such as books, television programs, and newspaper articles; and VIAF (Virtual International Authority File) a system that combines multiple name authority files into a single authority service, hosted by OCLC, all have their place when discussing identifiers for authority control.
Identity issues and disambiguating authors, researchers, other content creators, and their institutional affiliations are crucial as we move into a world of linked data. In this webinar, presenters will cover the implications and differences between ORCID, ISNI, and VIAF, what is the proper use of each, and some of the benefits that come with using authority files and making that information available on the Web.
Agenda
Introduction
Todd Carpenter, Executive Director, NISO
ORCID identifiers in research workflows
Simeon Warner, Director of Repository Development, Cornell University Library
ISNI: How It Works And What It Does
Laura Dawson, Product Manager, ProQuest
VIAF and its Relationships with Other Files
Thomas Hickey, Chief Scientist, OCLC
This document discusses Nature Publishing Group's integration of ORCID identifiers. It outlines how authors can create or link an ORCID on nature.com and during manuscript submission. The corresponding author can search for co-authors using ORCID to pre-populate forms. NPG customer service can also find users based on ORCID. The document notes upcoming integrations like ORCID call-back APIs and completing the virtuous circle of data exchange between NPG, CrossRef, and ORCID.
The document summarizes ORCID and its APIs. ORCID is a registry that provides unique identifiers for researchers and connects them to their activities such as publications, funding, employment, etc. The ORCID APIs allow organizations to authenticate users, collect and display ORCID identifiers, and connect information from organizational systems to researchers' ORCID records. The summary provides an overview of the ORCID APIs and how organizations can utilize them to integrate ORCID identifiers into their workflows and systems.
The document discusses ORCID, a system for providing researchers with unique identifiers. It notes that without identifiers, it is difficult to accurately connect researchers with their work. ORCID aims to address this by assigning each researcher a unique 16-digit number and ID and enabling the import and export of researcher profiles and publication data between different systems. The document outlines how ORCID is being integrated into publishing, funding, and other research workflows to link researcher profiles with their activities.
This document provides an overview of web services and APIs for mobile application development. It defines web services and APIs, describes their characteristics and differences. It also discusses the common types of web services for Android like XML-RPC, UDDI, SOAP and REST. The document explains the components of an API request including endpoints, headers, methods, and request data. It introduces JSON formats and provides examples. Finally, it discusses tools for testing APIs like web browsers and Postman and introduces fake APIs for development and testing purposes.
ORCID iDs in the Academic Publishing Workflow: ORCID iDs in PublicationORCID, Inc
ORCID iDs in Publication
Rebecca Barr, Ingrid McNamara, Nature Publishing Group
Learn about the process that NPG is using to integrate ORCID iDs in their publishing workflow. Hear about the challenges that they faced, and what they learned along the way. Also see the choices that they made in displaying ORCID iDs to authors and others.
See related presentations:
https://orcid.org/about/events/orcid-implementation-workshop-publishers-sept-19-2013
Talk about Salesforce REST API: how to perform query, search or single-record CRUD operations; how to retrieve versions, list of custom object and object metadata and field metadata and presentation of demo page performing these requests
DSpace-CRIS slides presented at ORCID's Better Together webinar on 19.09.2019, full slide deck with ORCID introduction at https://doi.org/10.23640/07243.9884033.v2.
Video Recording available at https://vimeo.com/361523018
Build Business Web Applications with PHPOpenbiz Framework and Cubi PlatformAgus Suhartono
Openbiz is php application framework that provides an object-oriented metadata-driven platform for application developers to build web application with least possible programming code (80% metadata, 20% programming code).
Sharing information between systems: The ORCID API (Alainna Wrigley)ORCID, Inc
The document discusses ORCID, which provides persistent digital identifiers for researchers to distinguish them from each other. It describes how ORCID enables sharing information between systems by connecting researchers and their activities/affiliations through a central hub. The ORCID API allows member organizations to authenticate users, collect and display ORCID IDs, connect additional information to ORCID records, and synchronize data between systems.
ORCID identifiers in research workflowsSimeon Warner
ORCID identifiers provide a unique identifier for researchers and link their activities like publications, datasets, and grants. Over 1.1 million identifiers have been created since launch in just over 2 years. ORCID aims to be integrated into research workflows to reduce name ambiguity and save effort by pre-populating information. Publishers are beginning to include ORCID identifiers in publication metadata to improve discovery and allow updating researcher profiles. ORCID serves as a hub, linking other identifiers and profiles for a researcher across different systems and organizations.
API testing validates application programming interfaces (APIs). API testing focuses on functionality, reliability, performance, and security of programming interfaces. Common protocols for API testing include HTTP, REST, SOAP, JMS, and UDDI. REST uses normal HTTP verbs like GET, POST, PUT, and DELETE and supports data formats like plain text, HTML, XML, and JSON. CRUD (create, read, update, delete) operations can be performed through HTTP requests in API testing.
Bollini, Andrea, Lombardi, Corrado, Digilio, Giuseppe, Giamminonni, Luca, & Mornati, Susanna. (2022, June 7). DSpace 7 ORCID Integration. Open Repositories 2022 (OR2022), Denver, Colorado. Zenodo. https://doi.org/10.5281/zenodo.6733036
The relevance and benefits of the ORCID persistent identifiers in the research ecosystem are increasingly evident. Nowadays users expect a good integration between the repository platform and ORCID with a bidirectional exchange of information. Unfortunately, up to now DSpace was lacking in this regard except for a very minor and limited integration allowing the submitter to query the ORCID public registry during the deposit. On the other hand, the cousin project DSpace-CRIS has featured a full integration [3] since 2014 at the time of the ORCID v1.2 API and based on a version 4 of DSpace.
Since the release of DSpace 7, the DSpace governance has been encouraging a progressive merge of these projects, backporting from DSpace-CRIS the most user-demanded features.
As a result, the DSpace 7.3 release plan includes the porting of the core ORCID integration [2], enabling DSpace users to finally connect their local DSpace profiles with ORCID, showing an authenticated ORCID badge where appropriate and pushing DSpace records to their ORCID profiles.
The presentation will show in detail the functionalities now available, the requirements to enable them in terms of ORCID membership and DSpace configuration, and the plans to bring more ORCID-related features to DSpace.
ORCID Collect & Connect: understanding integrations and the API (M. Buys)ORCID, Inc
ORCID provides persistent digital identifiers for researchers and connects their activities and affiliations across systems. The presentation discusses ORCID's vision and services, including integrations by region and sector. It outlines goals and best practices for collect, display, connect, and synchronize functions using ORCID identifiers and APIs. Examples show displaying identifiers, connecting data through the API, and enabling synchronization between systems.
This presentation was provided by Ralph LeVan of OCLC, during the NISO event "Next Generation Discovery Tools: New Tools, Aging Standards," held March 27 - March 28, 2008.
This document discusses Linked Open Data (LOD) and the Semantic Web. It defines LOD according to Tim Berners-Lee's four rules: using URIs to identify things; using HTTP URIs so things can be looked up; providing useful information about the thing when the URI is dereferenced; and including links to related things. It presents the LOD Star rating system with five levels for publishing structured data on the web. It also discusses the purpose of the Semantic Web in allowing machines to more easily find, share, and combine information.
This document discusses developing a content model for machine-actionable links to enable hypermedia applications. It reviews current web architecture and link usage. Example scenarios for data discovery, access, and processing are examined. An initial proposal is made for a link content model that includes properties like link, title, type, rel, overlayAPI, template, and profile. The goal is to allow hypermedia applications to direct machine agents through semantic links. Further development of vocabularies and example links is suggested.
ORCID Overview: Why your Lifelong Identifier is Important in the Digital Age ...ORCID, Inc
"ORCID overview: why your lifelong identifier is important in the digital age" presented by Nobuko Miyairi, ORCID Regional Director for Asia Pacific, at the ORCID workshop on 28 February 2017.
"Identifying Springer's Author (with ORCID iD) on SpringerLink and the benefits" presented by Hazman Aziz, Account Development Manager for Southeast Asia at Springer Nature, at ORCID's Malaysia workshop on 28 February 2017.
The document discusses how to integrate with the ORCID API. It describes the features of the public, member, and premium member APIs. It provides examples of connecting systems like manuscript submission systems and CRIS systems to ORCID to collect and display researcher IDs. The document outlines the OAuth workflow to authenticate users and connect data to their ORCID records using the API, and resources for learning more about synchronization and custom integrations.
This presentation provides an overview of how to build and manage an ORCID profile. It discusses linking ORCID with other researcher profiles like ResearcherID and Scopus to automatically add publications. It also explains how to manually add publications, funding, patents and other works. The presentation provides information on permission settings, visibility settings, and using linked profiles on ResearcherID and Scopus to obtain metrics like an H-index.
About the Webinar
In the world of authority control, it is a bit of an alphabet soup of acronyms. ORCID (Open Researcher and Contributor ID), which is a system to uniquely identify scientific and other academic authors; ISNI (International Standard Name Identifier), which identifies the public identities of contributors to media content such as books, television programs, and newspaper articles; and VIAF (Virtual International Authority File) a system that combines multiple name authority files into a single authority service, hosted by OCLC, all have their place when discussing identifiers for authority control.
Identity issues and disambiguating authors, researchers, other content creators, and their institutional affiliations are crucial as we move into a world of linked data. In this webinar, presenters will cover the implications and differences between ORCID, ISNI, and VIAF, what is the proper use of each, and some of the benefits that come with using authority files and making that information available on the Web.
Agenda
Introduction
Todd Carpenter, Executive Director, NISO
ORCID identifiers in research workflows
Simeon Warner, Director of Repository Development, Cornell University Library
ISNI: How It Works And What It Does
Laura Dawson, Product Manager, ProQuest
VIAF and its Relationships with Other Files
Thomas Hickey, Chief Scientist, OCLC
This document discusses Nature Publishing Group's integration of ORCID identifiers. It outlines how authors can create or link an ORCID on nature.com and during manuscript submission. The corresponding author can search for co-authors using ORCID to pre-populate forms. NPG customer service can also find users based on ORCID. The document notes upcoming integrations like ORCID call-back APIs and completing the virtuous circle of data exchange between NPG, CrossRef, and ORCID.
The document summarizes ORCID and its APIs. ORCID is a registry that provides unique identifiers for researchers and connects them to their activities such as publications, funding, employment, etc. The ORCID APIs allow organizations to authenticate users, collect and display ORCID identifiers, and connect information from organizational systems to researchers' ORCID records. The summary provides an overview of the ORCID APIs and how organizations can utilize them to integrate ORCID identifiers into their workflows and systems.
The document discusses ORCID, a system for providing researchers with unique identifiers. It notes that without identifiers, it is difficult to accurately connect researchers with their work. ORCID aims to address this by assigning each researcher a unique 16-digit number and ID and enabling the import and export of researcher profiles and publication data between different systems. The document outlines how ORCID is being integrated into publishing, funding, and other research workflows to link researcher profiles with their activities.
This document provides an overview of web services and APIs for mobile application development. It defines web services and APIs, describes their characteristics and differences. It also discusses the common types of web services for Android like XML-RPC, UDDI, SOAP and REST. The document explains the components of an API request including endpoints, headers, methods, and request data. It introduces JSON formats and provides examples. Finally, it discusses tools for testing APIs like web browsers and Postman and introduces fake APIs for development and testing purposes.
ORCID iDs in the Academic Publishing Workflow: ORCID iDs in PublicationORCID, Inc
ORCID iDs in Publication
Rebecca Barr, Ingrid McNamara, Nature Publishing Group
Learn about the process that NPG is using to integrate ORCID iDs in their publishing workflow. Hear about the challenges that they faced, and what they learned along the way. Also see the choices that they made in displaying ORCID iDs to authors and others.
See related presentations:
https://orcid.org/about/events/orcid-implementation-workshop-publishers-sept-19-2013
Talk about Salesforce REST API: how to perform query, search or single-record CRUD operations; how to retrieve versions, list of custom object and object metadata and field metadata and presentation of demo page performing these requests
DSpace-CRIS slides presented at ORCID's Better Together webinar on 19.09.2019, full slide deck with ORCID introduction at https://doi.org/10.23640/07243.9884033.v2.
Video Recording available at https://vimeo.com/361523018
Build Business Web Applications with PHPOpenbiz Framework and Cubi PlatformAgus Suhartono
Openbiz is php application framework that provides an object-oriented metadata-driven platform for application developers to build web application with least possible programming code (80% metadata, 20% programming code).
Sharing information between systems: The ORCID API (Alainna Wrigley)ORCID, Inc
The document discusses ORCID, which provides persistent digital identifiers for researchers to distinguish them from each other. It describes how ORCID enables sharing information between systems by connecting researchers and their activities/affiliations through a central hub. The ORCID API allows member organizations to authenticate users, collect and display ORCID IDs, connect additional information to ORCID records, and synchronize data between systems.
ORCID identifiers in research workflowsSimeon Warner
ORCID identifiers provide a unique identifier for researchers and link their activities like publications, datasets, and grants. Over 1.1 million identifiers have been created since launch in just over 2 years. ORCID aims to be integrated into research workflows to reduce name ambiguity and save effort by pre-populating information. Publishers are beginning to include ORCID identifiers in publication metadata to improve discovery and allow updating researcher profiles. ORCID serves as a hub, linking other identifiers and profiles for a researcher across different systems and organizations.
API testing validates application programming interfaces (APIs). API testing focuses on functionality, reliability, performance, and security of programming interfaces. Common protocols for API testing include HTTP, REST, SOAP, JMS, and UDDI. REST uses normal HTTP verbs like GET, POST, PUT, and DELETE and supports data formats like plain text, HTML, XML, and JSON. CRUD (create, read, update, delete) operations can be performed through HTTP requests in API testing.
Bollini, Andrea, Lombardi, Corrado, Digilio, Giuseppe, Giamminonni, Luca, & Mornati, Susanna. (2022, June 7). DSpace 7 ORCID Integration. Open Repositories 2022 (OR2022), Denver, Colorado. Zenodo. https://doi.org/10.5281/zenodo.6733036
The relevance and benefits of the ORCID persistent identifiers in the research ecosystem are increasingly evident. Nowadays users expect a good integration between the repository platform and ORCID with a bidirectional exchange of information. Unfortunately, up to now DSpace was lacking in this regard except for a very minor and limited integration allowing the submitter to query the ORCID public registry during the deposit. On the other hand, the cousin project DSpace-CRIS has featured a full integration [3] since 2014 at the time of the ORCID v1.2 API and based on a version 4 of DSpace.
Since the release of DSpace 7, the DSpace governance has been encouraging a progressive merge of these projects, backporting from DSpace-CRIS the most user-demanded features.
As a result, the DSpace 7.3 release plan includes the porting of the core ORCID integration [2], enabling DSpace users to finally connect their local DSpace profiles with ORCID, showing an authenticated ORCID badge where appropriate and pushing DSpace records to their ORCID profiles.
The presentation will show in detail the functionalities now available, the requirements to enable them in terms of ORCID membership and DSpace configuration, and the plans to bring more ORCID-related features to DSpace.
ORCID Collect & Connect: understanding integrations and the API (M. Buys)ORCID, Inc
ORCID provides persistent digital identifiers for researchers and connects their activities and affiliations across systems. The presentation discusses ORCID's vision and services, including integrations by region and sector. It outlines goals and best practices for collect, display, connect, and synchronize functions using ORCID identifiers and APIs. Examples show displaying identifiers, connecting data through the API, and enabling synchronization between systems.
This presentation was provided by Ralph LeVan of OCLC, during the NISO event "Next Generation Discovery Tools: New Tools, Aging Standards," held March 27 - March 28, 2008.
This document discusses Linked Open Data (LOD) and the Semantic Web. It defines LOD according to Tim Berners-Lee's four rules: using URIs to identify things; using HTTP URIs so things can be looked up; providing useful information about the thing when the URI is dereferenced; and including links to related things. It presents the LOD Star rating system with five levels for publishing structured data on the web. It also discusses the purpose of the Semantic Web in allowing machines to more easily find, share, and combine information.
This document discusses developing a content model for machine-actionable links to enable hypermedia applications. It reviews current web architecture and link usage. Example scenarios for data discovery, access, and processing are examined. An initial proposal is made for a link content model that includes properties like link, title, type, rel, overlayAPI, template, and profile. The goal is to allow hypermedia applications to direct machine agents through semantic links. Further development of vocabularies and example links is suggested.
ORCID Overview: Why your Lifelong Identifier is Important in the Digital Age ...ORCID, Inc
"ORCID overview: why your lifelong identifier is important in the digital age" presented by Nobuko Miyairi, ORCID Regional Director for Asia Pacific, at the ORCID workshop on 28 February 2017.
"Identifying Springer's Author (with ORCID iD) on SpringerLink and the benefits" presented by Hazman Aziz, Account Development Manager for Southeast Asia at Springer Nature, at ORCID's Malaysia workshop on 28 February 2017.
"ORCID at Universiti of Kuala Lumpur" presented by Puan Pazilah Hamzah, Senior Manager and Head of the Tunku Azizah Knowledge Centre at Universiti Kuala Lumpur, at the ORCID Malaysia workshop on 28 February 2017.
The document discusses several ways that ORCID IDs can be integrated with other research systems and services. It describes how OJS (Open Journal Systems) allows authors to integrate their ORCID ID during manuscript submission to automatically capture publications. It also explains how Hong Kong Baptist University is working to equip all faculty with ORCID IDs to upload employment and works information. Additionally, it outlines how SciENCV and Scopus can be linked to an ORCID profile to auto-populate and clean up research profiles. The document encourages giving permissions to ORCID-enabled systems so research activities are discoverable through an ORCID ID.
ORCID as a Community Initiative (N. Miyairi)ORCID, Inc
1) ORCID is a nonprofit organization that provides unique identifiers for researchers and connects their works and affiliations. It aims to solve name ambiguity issues.
2) Over 3 million researchers from over 40 countries have signed up for ORCID IDs. Major research institutions, publishers, and funders have integrated ORCID into their systems.
3) In Asia Pacific, China has the most ORCID ID holders, followed by India and Japan. Several countries have formed ORCID consortia to promote adoption.
Spreading the ORCID Word: ORCID Communications Webinar (2016.12)ORCID, Inc
This webinar, delivered 13 December 2016, discusses effective practices in encouraging adoption and use of ORCID iDs by researchers in your community.
Topics include:
- Key messages about ORCID (by audience, where applicable)
- Successful techniques for delivering those messages
- Useful resources from ORCID and the ORCID Community
The document discusses Khalifa University's implementation of ORCiD identifiers to capture faculty publications, avoid name ambiguity, and easily link publications to citation profiles. Key tasks completed include starting the implementation in September, creating an intranet page for faculty sign up, and conducting training sessions. Ongoing tasks involve connecting more faculty IDs, harvesting data for the institutional repository using an ORCiD plugin, and adding features to the dashboard. The future plans are to show ORCiD links for authors, push repository data to faculty profiles, and automate collecting data for faculty pages using ORCiD.
ORCID Integration with Institutional Repositories (D. Grenz)ORCID, Inc
The document discusses KAUST's approach to integrating ORCID IDs within its institutional repository and other research systems. It began ORCID integration in 2014 by requiring IDs for electronic theses and dissertations. Since becoming an ORCID member in 2014, it has integrated ORCID throughout its repository and research evaluation processes. Over 730 IDs have been created or identified, covering over 80% of faculty and 45% of postdocs. Future goals include increasing ID coverage and automating more processes to reduce researcher workload and keep systems up-to-date.
Research in a world where machines read (M. Buys)ORCID, Inc
This document discusses ORCID, a registry that provides researchers with a unique identifier to help distinguish them from others with similar names. It notes challenges in identifying researchers due to name variations and ambiguities. ORCID aims to address this by assigning persistent digital IDs that uniquely identify individuals and can link to their professional activities and affiliations. The document outlines how ORCID benefits researchers, universities, publishers, funders and more by enabling identity verification and information sharing through its registry and API. It provides statistics on ORCID usage and member organizations.
Benefits to researchers who use ORCID (P. Purnell)ORCID, Inc
ORCID provides identifiers for individual researchers and authors to solve the problem of name disambiguation. Registration for an ORCID takes less than one minute. While journal impact factors and university rankings provide citation metrics at higher levels of aggregation, ORCID identifiers allow for assessment of citation impact at the individual researcher level through metrics like total citations and h-index.
ORCID overview: why your lifelong identifier is important in the digital age ...ORCID, Inc
ORCID is a nonprofit organization that provides researchers with a unique identifier to distinguish themselves from others with similar names. Over 2.6 million researchers have registered for an ORCID ID to connect their academic work and contributions. ORCID helps link researchers to their publications, funding, and other research activities to improve recognition and discoverability. Many publishers, funders, universities, and other organizations are integrating ORCID to make it easier for researchers to manage their information and comply with ID requirements. Researchers are encouraged to register for a free ORCID ID to reliably connect their work, alleviate mistaken identity issues, and help make the research process more efficient.
ORCID in the Publishing Workflow (Mochammad Tanzil Multazam)ORCID, Inc
The document discusses the benefits of using ORCID for researchers, research institutions, and publishers. As a research institution, ORCID allows better management of researcher publications and metrics. For researchers, ORCID provides a way to uniquely identify work including publications, reviews, and funding, and helps integrate this information across different systems. For publishers, ORCID streamlines the publication process and disambiguates author identities. The research institution aims to implement ORCID integration in more of its systems to better track faculty work and improve research management.
ORCID Indonesia Workshop provides an introduction to ORCID. ORCID is an open, non-profit organization that provides a persistent digital identifier for researchers. It allows researchers to connect their various activities and affiliations together through a single identifier. ORCID aims to become an international standard that distinguishes researchers from each other through unique, researcher-controlled identifiers. The presentation outlines ORCID's core principles of researcher control, community governance, openness and persistence. It also discusses ORCID's governance structure, vision, community and integration with various research systems and publishers.
ORCID as a Community Initiative (Miyairi)ORCID, Inc
This document discusses ORCID (Open Researcher and Contributor ID) and its role as a community initiative. It notes that ORCID allows publishers, repositories, associations, funders, and universities to collect researcher IDs and connect them to publications, grants, and other work. This enables information to be entered once and then reused across different systems. The document provides membership details and statistics on ORCID adoption in Asia Pacific countries. It emphasizes that ORCID is a community effort that requires support from researchers' affiliated organizations to promote its benefits.
The document discusses several ways that ORCID IDs can be integrated into research workflows and systems. It describes how OJS (Open Journal Systems) allows manuscripts submitted through it to be associated with an ORCID ID. It also outlines how Hong Kong Baptist University is working to give all faculty ORCID IDs to upload employment and works information. Additionally, it notes that SciENCV through the National Library of Medicine allows adding publications and funding to an ORCID profile, and that Scopus enables linking publications to an ORCID record. Finally, it encourages giving permissions to ORCID-enabled systems to help make a researcher more visible and have their activities captured in their ORCID record.
The document discusses changes in the ORCID API from version 1.2 to version 2.0. Some key points discussed include:
- Version 2.0 allows reading and writing data in smaller sections or individual items rather than large chunks, improving performance.
- Permissions are simplified with just 4 scopes in version 2.0 compared to many overlapping scopes in version 1.2.
- Version 2.0 returns activity summaries with basic details rather than full representations of each activity, reducing payload size.
- Version 2.0 introduces display indexes and ordering to control item ordering, unlike version 1.2 which had no defined ordering.
What’s New in ORCID Tech 2016 (Robert Peters)ORCID, Inc
This document summarizes new features and updates from ORCID in 2016. Key points include: opening the ORCID license to be free instead of $400/year; increased support for additional languages and Unicode scripts; growth in the number of user connections through Facebook, Google, and institutions; updates to the V2 API to improve scalability and clarity; additional details shown for individual profiles; and planned improvements like a member directory and cross-linking institutional sign-ins.
1. ORCID Phase 1 Query API
Authors: Michael Taylor (mi.taylor@elsevier.com), Geoffrey Bilder (gbilder@crossref.org)
V1: 4-JUL-2011
V2: 4-AUG-2011 (corrected mime types)
V3: 11-AUG-2011 (updated following API meeting August 9th)
V4: 26-AUG-2011 (some further updates based on August 9th meeting and emails)
V5: 20-SEP-2011 (correcting curl url strings to remove reference from content in header)
V6: 28-SEP-2011 (made public)
V7: 18-OCT-2011 (changed “Authorization: OAuth” to “Authorization: Bearer” as per spec.
V8: 26-OCT-2011 (added JSON access token details)
V9: 2-NOV-2011 (updated URLs, and changed accept header for search API)
V10: 17-JAN-2012 (Removed option to authenticate using IP and API key)
V11: 15-FEB-2012 (Removed x- from mime-types)
V12: 19-APR-2012 (Added search API details)
v13: 24-APR-2012 (Added email address as search field)
v14: 21-AUG-2012 (Updated to match schema version 1.0.3)
v15: 29-Aug-2012 (Updated to update terminology inconsistencies with other documents)
Introduction
This documents describes the application programmer interface (API) for querying and
searching the ORCID system. This API will allow third parties to integrate ORCID profiles into
their submission and evaluation systems.
Separate documents will describe ORCID APIs for enabling third parties to batch deposit
records into the system as well as the API which third parties will need to support in order to
allow ORCID users to import profile data from their systems.
Note: where this document refers to researchers, paper authors or contributors, it does so
interchangeably. Our intention is to refer to those individuals who have made a scholarly
contribution.
Warnings, Caveats and Weasel Words
This is preliminary documentation and has been produced as the first draft of a specification for
a system that does not yet exist. In short, there is no ORCID API yet, so please don’t attempt to
experiment with the system using this documentation, you will just be disappointed.
Having said that, our goal is to get this specification robust enough so that we can get a
development team to create a working sandbox version of the API (aka “Mock API”) as soon
1
2. as possible. This will allow third parties to start their integration efforts in parallel with the rest of
ORCID’s phase 1 development. The proposed sandbox functionality is explained in appendix A.
Terminology
Private data
Profile data that the user has chosen to restrict access to. This data may be used in hashed,
anonymized form for internal disambiguation purposes by the ORCID system, but it will not be
made available to third parties or the public.
Protected data
Profile data that the user chooses to share with selected third parties (e.g. specific funding
agencies, publishers, etc.) but which is not made available publicly.
Public data
Profile data that the user chooses to make available to the public. This data will be made
available under a CC-zero waiver via APIs and via periodic data dumps.
Public API
The API made available to the general public and which can be used without any sort of
authentication. This API will only return data marked by users as “public” and will come with no
service level agreement (SLA). The API may be throttled at the IP / transaction level in order to
discourage inadvertent overloading and/or deliberate abuse of the system.
Member API
The API made available to third parties requiring production-level integration of the ORCID
service. The API will come with defined service level agreements and will allow authenticated
third parties to retrieve “protected” profile data from those users who have authorized them to do
so.
The Member API will be architecturally isolated from the Public API in order to allow separate
scaling to meet SLA requirements.
Bio Record
The default result when querying the ORCID APIs will be to return “bio records”. Bio records
only include biographical information relating to the ORCIDs (subject to the user’s privacy
settings) and do not include activities (publications, patents, grants). This default behavior is
designed to minimize the size of returned records for default queries and will work the same in
both the Public and Member APIs.
Works
The list of “works” for this ORCID: published articles, books or other documents for which this
person was recognized as a contributor. Privacy settings can apply to these relationships as
well, so the response list can depend on the entity making the query.
2
3. Full Record
This is provided for convenience so that a single request includes *both* the biographical
information and activities information (subject to the user’s privacy settings) related to the
ORCIDs queried.
HTML
● Web pages will be semantically marked-up using schema.org microdata.
● They will be freely accessible webpages.
Overview
The ORCID query APIs will enable third parties to search the system and obtain data through a
simple RESTFUL1 interface. The interface will support the following query types:
Name Key Returned Description
Bio ORCID Profile metadata Given a contributor, give me name
and affiliation data.
Works ORCID List of work metadata Given a contributor, tell me what
works they have contributed to.
Full ORCID Profile metadata, activities Given an contributor, tell me what
metadata and ORCIDs activities they have contributed to,
name and affiliation data.
Work Work identifiers ORCIDs & associated Given a work, tell me what
(e.g. DOIs) metadata contributors are responsible for it.
Search ORCID, Work ORCIDs & associated Given whatever metadata I have,
identifiers, or metadata give me a ranked list of potential
profile metadata contributors identified by that
metadata.
The Public API will require no authentication on the part of those querying it, while the Member
API will require third parties to authenticate using the OAuth2 open standard for authentication
between computer systems.
Using the Public ORCID Query API
The ORCID APIs will support returning ORCID records in various representations, including, to
start with, HTML, XML and JSON. The preferred representation of the record can be specified
using content negotiation. Examples of the XML representation of both bio and full responses
1 http://en.wikipedia.org/wiki/Representational_State_Transfer
3
4. can be found at:
http://orcid.github.com/ORCID-Parent/schemas/orcid-message/1.0.3/
Users of the API will be able to specify the particular version of a representation that they are
expecting. This will enable ORCID to change the representations (e.g. by adding, moving or
removing elements, etc.) without breaking third party applications which are expecting particular
representations. Note carefully that the “version” refers to the version of the representation of
the record returned - not the version of the record itself.
The following examples illustrate querying the Public ORCID Query APIs using the command
line tool, curl2. Note that all of the queries below will only return data that users have marked as
being “public.”
Note inclusion of examples that specify type request in URL alone.
Example 0: Request the HTML representation of an ORCID profile
curl -H "Accept: text/html" "http://api.orcid.org/{orcid}/orcid-bio" -D - -L
Example 1: Request an XML representation of the “bio record” for an
ORCID
curl -H "Accept: application/orcid+xml" "http://api.orcid.org/{orcid}/orcid-
bio" -D - -L
Example 2: Request the JSON representation of the “bio record” for
an ORCID
curl -H "Accept: application/orcid+json" "http://api.orcid.org/{orcid}/orcid-
bio" -D - -L
Example 3: Request XML representation version 1.1 of the “bio
record” for an ORCID
curl -H "Accept: application/orcid+xml ; version=1.1" "http://api.orcid.org/
{orcid}/orcid-bio" -D - -L
Example 4: Asking XML representation 1.1 of the “full record” for an
ORCID
curl -H "Accept: application/orcid+xml ; version 1.1" "http://api.orcid.org/
{orcid}/orcid-profile" -D - -L
2 http://curl.haxx.se/
4
5. Example 5: Request an XML representation of the “works” for an
ORCID
curl -H "Accept: application/orcid+xml" "http://api.orcid.org/{orcid}/orcid-
works" -D - -L
Searching using the ORCID Public API.
The ORCID API will support searching a subset of ORCID metadata using the popular SOLR
query syntax.
Query syntax
The ORCID search API will be based on SOLR, and will support all query syntaxes available in
SOLR 3.6, including the following.
● Lucene with SOLR extensions
● DisMax
● Extended DisMax
The default syntax will be Lucene with SOLR extensions.
Search URL
The base URL for searching will be as follows. SOLR query parameters will be appended to this
URL.
http://api.orcid.org/search/orcid-bio/
Search results format
The results of the search will be a list of “bio records” in the same format returned by the REST
API call for a single record, described above. Each bio in the list will have a relevancy score, as
determined by SOLR.
The search API will use content negotiation to determine whether to return XML or JSON, in the
same way as the REST API calls for a single record.
Search fields
SOLR field name XPath for corresponding Description
profile data
orcid //orcid-profile/orcid The ORCID identifier for the
researcher or contributor.
5
6. given-names //orcid-profile/orcid-bio/personal- The given names of the
details/given-names researcher of contributor
family-name //orcid-profile/orcid-bio/personal- The family name of the
details/family-name researcher of contributor
past-institution- //orcid-profile/orcid-bio/ The name of any past
affiliation-name affiliations/affiliation[affiliation- institution in the researcher or
type="past-institution"]/affiliation- contributor’s profile
name
current-primary- //orcid-profile/orcid-bio/ The name of the primary
institution-affiliation- affiliations/affiliation[affiliation- institution of the researcher or
name type="current-primary-institution"] contributor
/affiliation-name
current-institution- //orcid-profile/orcid-bio/ The name of non-primary
affiliation-name affiliations/affiliation[affiliation- institutions of the researcher
type="current-institution"]/ or contributor
affiliation-name
credit-name //orcid-profile/orcid-bio/personal- The name that normally
details/credit-name appears on publications by
the researcher or contributor
other-names //orcid-profile/orcid-bio/personal- Alternative names that
details/other-names may have appeared on
publications by the researcher
or contributor
email //orcid-profile/orcid-bio/contact- The email address of the
details/email researcher or contributor
digital-object-ids //orcid-profile/orcid-activities/ The DOI of any work in the
orcid-works/orcid-work/work- researcher or contributor’s
external-identifiers/work-external- profile
identifier[work-external-identifier-
type="doi"]/work-external-
identifier-id
work-titles //orcid-profile/orcid-activities/ The titles of any work in the
orcid-works/orcid-work/work-title/ researcher or contributor’s
(title|subtitle) profile
grant-numbers //orcid-profile/orcid-activities/ The grant number of any
orcid-grants/orcid-grant/grant- grant associated with the
6
7. number researcher or contributor
patent-numbers //orcid-profile/orcid-activities/ The patent numbers of any
orcid-patents/orcid-patent/patent- patent associated with the
number researcher or contributor
keywords //orcid-profile/orcid-bio/keywords/ Any keywords associated with
keyword the researcher or contributor
text All the above data are combined All the above fields. This
into this field is also the default field for
Lucene syntax queries.
Example queries
Name Example 1
Description Search family names of all ORCID records for the name ‘Carberry’
Syntax Lucene
Paging First 10 rows only
URL http://api.orcid.org/search/orcid-bio/?q=family-
name:Carberry&start=0&rows=10
Name Example 2
Description Search all searchable fields of all ORCID records for the word ‘Carberry’
Syntax Lucene
Paging First 10 rows only
URL http://api.orcid.org/search/orcid-bio/?q=text:Carberry&start=0&rows=10
Name Example 3
Description Search family names of all ORCID records for the name ‘Carberry’ and
the keyword ‘Physics’. Only records containing both the family name and
7
8. the keyword will be returned.
Syntax Lucene
Paging First 10 rows only
URL http://api.orcid.org/search/orcid-bio/?q=family-
name:Carberry%20AND%20keyword:Physics&start=0&rows=10
Name Example 4
Description Search given names and family names of all ORCID records
for ‘Raymond’ but boost the family name. Records with given names
containing ‘Raymond’ and family name containing ‘Raymond’ will be
returned, but those with family name will appear at the top of the list and
will have a higher relevancy score.
Syntax Extended DisMax
Paging First 10 rows only
URL http://api.orcid.org/search/orcid-bio/?
defType=edismax&q=Raymond&qf=given-names^1.0%20family-
name^2.0&start=0&rows=10
Name Example 5
Description Search given names and family names of all ORCID records
for ‘Raymond’ but boost the family name. Records with given names
containing ‘Raymond’ and family name containing ‘Raymond’ will be
returned, but those with family name will appear at the top of the list and
will have a higher relevancy score.
The two records with ORCID ID 281877-5816-0747-5659 and 6181-9093-
3346-6284 will be excluded from the results.
Syntax Extended DisMax
Paging First 10 rows only
URL http://api.orcid.org/search/orcid-bio/?defType=edismax&q=Raymond%20-
orcid:%281877-5816-0747-5659%206181-9093-3346-
8
9. 6284%29&qf=given-names^1.0%20family-name^2.0&start=0&rows=10
The search API will support opensearch in version 1.1 of the API release.
Using the Member ORCID Query API
The Member ORCID Query API will allow authenticated third parties to retrieve “protected” data
from the profiles of researchers who have explicitly agreed to share their data. In order to use
the API to query for protected data, the third party will first have authenticate using the OAuth
protocol.
OAuth
OAuth is an open standard for authorization between computer systems. Technology built using
OAuth allows users to share their private resources stored on one system with another one
without having to use credentials, (username, password, etc). Once a relationship between
two systems has been approved, that relationship is remembered via a process of retaining
exchanged secure tokens. Either side may revoke the relationship in the future.
For example, when installing a Facebook or Twitter application on a smartphone, you’ll often
go through a simple mechanism of using your username and password to establish that
relationship - and after this, in your Facebook or Twitter application pages, you’ll see that
relationship between phone and web service listed, detailed and revokable. The process feels
just like a simple username / password login to the user, but the underlying technology protocol
is far more complex and secure.
ORCID will utilize OAuth 2. At the time of writing the current specification version is v2-22, and
can be found at: http://tools.ietf.org/html/draft-ietf-oauth-v2-22
9
10. Twitter settings page. The user has granted access to three applications to share data with
Twitter via OAuth. Permission may be revoked either at Twitter or on the applications.
It is proposed that Orcid uses Oauth to establish relationships between itself and partners who
have the authority to access and use the Member API data interface. Once the relationship
is made, it is permanent until such time it is revoked (for example at the end of a subscription
period, contract, terms and conditions infringements, etc).
OAuth is used by Google, Microsoft, Facebook, Yahoo and Twitter to control to their APIs.
An overview of the entire Oauth work flow can be seen in appendix B.
Obtaining An Oauth Consumer (API) Key
In order for a third party to query the Member API ORCID Query API, they will first need
to obtain a Consumer Key from the ORCID service. The ORCID system will provide a web
interface which will allow authorized third parties to generate Consumer Keys for their
applications.
For Example, the Society of Psychoceramics, who wants to to be able to integrate ORCID into
their manuscript submission process, would go to a form on the ORCID site and fill in relevant
information.
10
11. Upon submitting this information, the developers at the Society for Psychoceramics would
be returned to a page listing all the relevant keys and API end-points needed in order to
authenticate their users against the ORCID system.
11
12. Once the developer has generated the needed application Consumer Keys, they can start to
integrate ORCID into their own systems.
In summary, the flow for obtaining a Consumer Key looks like this:
12
13. Retrieving Protected Data
The Member API allows third parties to query the ORCID API and retrieve protected data from
the profiles of those ORCID users that have authorized them to do so. This means that third
parties will need to support a process that allows ORCID users to explicitly authorize them to
access protected profile data. Once an ORCID user has authorized a particular third party to
have access to their protected data, then the third party can query said data without having to
go through the authorization process again. That is- unless the ORCID user (or ORCID itself)
revokes the third parties authorization.
The process of authorizing a third party to access protected data involves a simple workflow.
For example. Josiah Carberry submits his first manuscript to the Journal of Psychoceramics.
The manuscript submission system can offer to expedite the submission process by importing
his ORCID profile information.
The manuscript tracking system will then redirect Josiah Carberry to the ORCID site where, if he
hasn’t already, he is prompted to authenticate and log-in.
13
14. Once Josiah has authenticated with ORCID, the ORCID system will ask him if he wants to
share his protected profile information with the Journal of Psychoceramics Manuscript Tracking
system. At this point, the Journal of Psychoceramics Manuscript Tracking System will be
authorized to generate an “access token”. When requesting this, it will also return the user’s
ORCID, thus allowing the system to verify and, or omit the necessity for the user to supply their
ORCID.
The JSON response for the access token request will be similar to:
{
"access_token": "5a7a4062-3d26-4b10-aa6d-3d48458535c5",
"expires_in": 43199,
"orcid": "4444-4444-4444-4",
"refresh_token": "007e7701-769b-461d-bac4-ed8133003e49",
"scope": "read",
"token_type": "bearer"
}
The access token will allow access to the protected data within the user’s ORCID profile.
14
16. Once Josiah grants permission for the Journal of Psychoceramics manuscript tracking system
to query his protected profile, then the manuscipt tracking system will be able to query Josiah’s
profile as often as it likes, without re-authenticating, until either Josiah or ORCID revokes the
16
17. Journal’s permissions. So, once Josiah has authorized the Journal- then the work-flow simplifies
to this:
This latter transaction would be accomplished using curl as follows:
curl curl -H "Accept: application/orcid+xml" -H "Authorization: Bearer
{YOUR_ACCESS_TOKEN}" “https://api.orcid.org/{orcid}" -D - -L
All such queries will honor the researcher’s privacy settings. That is, profile data that
the researcher marks as “private” will not be shared with anybody. Profile data marked
as “protected” will only be shared with third parties to whom which the researcher has explicitly
granted access. Profile data marked as “public” will be shared with everybody.
Error codes
The following error codes will be implemented in the ORCID API and in the sandbox.
● 400 - Bad request (invalid search syntax)
● 401 - Unauthorized (the application is not authorized to access the resource)
● 406 - Not acceptable (bad accept header, version, etc)
● 413 Request Entity Too Large (search was overly broad and needs to be restricted,
partial results may be returned)
● 416 Requested Range Not Satisfiable (bad pagination parameters for search results,
other large result list)
● 426 Upgrade required (version the client is requesting is too old)
Appendix A: Sandbox
17
18. NB- the “Sandbox API” is now know as the “Mock API” and is available on Github.
A query sandbox will be built at the earliest opportunity to allow partners to develop applications
that interface with the Orcid system. The sandbox will:
● Parse query strings, as specified above and respond with appropriate error messages
● Decipher the content preference (web, XML, JSON) and display appropriately.
● Having parsed the query, the sandbox will reply with a static payload.
● Will dummy an OAuth transaction, success or fail.
The sandbox will be maintained and versioned to always support the full set of query strings and
response formats.
Sandbox: Response formats
● Web pages will be semantically marked-up using schema.org microdata.
● XML and JSON format detail to be discussed.
● Consideration will be given to inclusion of human-readable messages in response
payload files, possibly of url to full message. This would be to enable alerting API clients
(particularly public API clients for whom we don’t necessarily have any contact details) to
changes in format, functionality, throttling alerts, etc.
● Search responses will be in the form of Orcid IDs plus a match score in the first version.
Additional fields will be added in subsequent versions of the API.
Appendix B: Overview of ORCID/OAuth Flow
18