Downloaded 12 times
Uploaded by4Science
4Science presentes: ORCiD API Tutorial
This document provides an introduction and overview of the ORCID API. It discusses the ORCID data model, security model, XML structure, and how to access and use the API. The ORCID API uses OAuth2 for authorization and allows developers to retrieve, update, and add researcher profiles and activities like publications, affiliations, and funding through API calls. Documentation and support resources are also referenced.
More Related Content
Similar to 4Science presentes: ORCiD API Tutorial
4Science presentes: ORCiD API Tutorial
- 1.
- 2. • ORCID data model • Security model • ORCID-XML structure • Example of use of APIs from DSpace-CRIS Agenda
- 3. Research centric datamodel Affilia+ons - Educa+on - Employment Fundings Start / End dates; Role +tle; Department name; Organiza+on (with ID as much as possible) Works Title, Journal, Abstract, Cita+on, Type, publica+on date, iden+fiers, url, contributors, language, country Start / End dates; Title, Descrip+on, inves+gators, Types, iden+fiers, Funder (with ID as much as possible)
- 4.
- 5.
- 6.
- 7.
- 8. How to getthe API • Public API can be requested for free by any person who holds an ORCID ID • Demonstra+on: [email protected] / t3s3st hps://sandbox.orcid.org/developer-tools • Member API are reserved to ORCID members, can be requested using a web form hps://orcid.org/content/register-client-applica+on-produc+on- trusted-party • A sandbox environment is available for anyone also to test member & premium API hps://orcid.org/content/register-client-applica+on-sandbox
- 9. Authoriza9on and security • The ORCID API uses OAUTH2 as authoriza+on model • Client is authen+cated using client_id & client_secret • Ask authoriza+on to the researcher to perform some ac+ons (scopes /read-limited, /orcid-bio/update, etc.) • Receive an authen+ca+on token to use in the subsequent API calls • How it looks like to the user: hp://dspacecris.eurocris.org/ hps://dspace-cris.4science.it
- 10.
- 11.
- 12. The request URIstructure hps://members.orcid.org/api/explore-orcid-api-google-oauth-playground
- 13. How to READinforma9on hps://members.orcid.org/api/tutorial-retrieve-data-orcid-record
- 14. ORCID Message Schema Current version 1.2 Release candidate 2.0 ORCID – XML have 4 sec+ons • <orcid-iden+fier> & <orcid-history> reserved to informa+on managed by the registry • <orcid-bio> contains the personal informa+on of the researcher • <orcid-ac+vi+es> contains the informa+on related to all the ac+vi+es of the researcher: works, affilia+on, funding
- 15.
- 16.
- 17.
- 18.
- 19.
- 20. How to useit • Demo: hps://dspace-cris.4science.it
- 21. • You need member API for that! • You can POST or PUT • POST: create addi+onal informa+on à append • PUT: replace all the informa+on owned by your applica+on • You can update/create specific sec+on or subparts • <ORCID-ID>/orcid-bio • <ORCID-ID>/affilia+ons • <ORCID-ID>/orcid-works • <ORCID-ID>/finding • More details hps://members.orcid.org/api/api-calls How to update informa9on
- 22. How to useit • Demo: hps://dspace-cris.4science.it
- 23. How to getsupport & more informa9on • Extended online documenta+on: hp://members.orcid.org/api • GitHub ORCID repository hps://github.com/ORCID/ORCID-Source • Google group: hps://groups.google.com/forum/#!forum/orcid-api-users • ORCID Support: [email protected]
- 24.