You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You have just followed a method a custom integration would use to get ORCIDs from users. The following
5
+
6
+
##Vendor systems
7
+
8
+
Some publishing, research information and repository software systems support collecting authenticated iDs and permissions right out of the box. See our list of [ORCID-enabled systems](https://members.orcid.org/api/orcid-enabled-systems) for more details.
9
+
10
+
Configuration steps and customization options vary widely between systems - check your system's documentation for complete information.
11
+
12
+
##Institutional sign-in
13
+
14
+
You can enable access using institutional credentials. Check out the (Members Documentation)[http://members.orcid.org/api/integrate/institution-sign-in] for more information.
15
+
16
+
17
+
##Share my iD
18
+
19
+
Need a quick way to collect authenticated iDs with no programming or IT resources needed?
20
+
[Share my iD](https://share-my-id.orcid.org/) is a new app from ORCID that allows anyone with an ORCID iD to get iDs from other ORCID users.<br>
21
+
<imgsrc="../images/04-4_share-my-id.png"width="600"alt="ORCID Share my iD app home page" />
22
+
23
+
##DOI metadata
24
+
25
+
Many systems now collect authenticated ORCID iDs and publish them in DOI (and other persistent identifier) metadata. If you have a DOI for a publication, dataset, or other digital object, you can check its metadata for author ORCID iDs.
26
+
27
+
###Example: CrossRef API
28
+
For example, using the [CrossRef REST API](https://github.com/CrossRef/rest-api-doc/blob/master/rest_api.md), we can find an author's ORCID iD in the DOI metadata for ```http://dx.doi.org/10.1155/2013/364301```
29
+
30
+
1. In a new window or tab, visit ```https://api.crossref.org/v1/works/10.1155/2013/364301```
31
+
2. In the JSON data that appears, ORCID iDs submitted by the publisher in the DOI metadata are included in the ```author``` element.
32
+
<br>
33
+
<imgsrc="../images/04-5_doi-metadata.png"width="400"alt="ORCID in DOI metadata" />
<imgsrc="../images/04-2_auth-code.png"width="400"alt="Browser address bar showing OAuth authorization code" />
78
78
79
79
###Exchange authorization code for access token & authenticated iD
80
-
Once you have an Authorization Code, you can exchange it for an Access Token and the Authenticated iD of the user who signed in, which you'll need in order to take the API action(s) you requested permission for.
80
+
Once you have an Authorization Code, you can exchange it for an Access Token and the Authenticated iD of the user who signed in, which you'll need in order to take the API action(s) you requested permission for. You need to store this securely and privately as it contains access tokens, normally you would store this in a database, for now you can store it in a text file on your computer.
81
81
82
82
In a real-world situation, this exchange would be done by your system, using a programming language such as PHP, Java, or Ruby on Rails. For this tutorial, we'll use Google OAuth Playground to simulate a web application.
Copy file name to clipboardExpand all lines: docs/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ In this tutorial you will learn:
36
36
37
37
You can also use
38
38
- [cURL](http://curl.haxx.se/download.html): Free, command-line application available for Mac or Windows (pre-installed on most Mac OS versions; accessible within Terminal application)
39
-
- Or other online tools, like [hurl.it](http://hurl.it">hurl.it)
39
+
- Or other online tools, like [Insomnia](https://insomnia.rest/)
40
40
41
41
Once you have got to grips with the APIs you can use our [Swagger](https://pub.sandbox.orcid.org/v2.0/) graphical interface.
Copy file name to clipboardExpand all lines: docs/post.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,6 @@
1
-
Now that we've got an Access Token, we can use it like a password to take the API actions we requested permission for (in this case, to update activities). In this section, we'll add an education affiliation to our Sandbox record.
1
+
Now that we've got an Access Token, we can use it like a password to take the API actions we requested permission for.
2
+
3
+
In this section, we'll add an education affiliation to our Sandbox record. You can use the API to, POST (add), PUT (update), DELETE, or read any section of the record, the only things you need to change are the endpoints and the XML for each section. In the following example we are using the /education endpoint with the [correct XML](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/samples/write_sample/education-2.1.xml) to add the information, but you can just as well add Employment or Works for example. See our [Github documentation](https://github.com/ORCID/ORCID-Source/blob/master/orcid-model/src/main/resources/record_2.1/README.md) for more example files and endpoints and the permissions you need for each.
2
4
3
5
##Add an education affiliation
4
6
Still have that Google OAuth Playground window open? If so, continue with step 1 below. If not, go back and repeat the [Get an authorization code](/collect/#get-an-authorization-code) and [Exchange authorization code for an access token](/collect/#exchange-authorization-code-for-access-token-authenticated-id) steps from the previous section before moving on to the steps below.
@@ -21,7 +23,7 @@ Still have that Google OAuth Playground window open? If so, continue with step 1
21
23
7. Copy the education affiliation XML at the end of this section and paste it into the **Request Body** text box<br>
22
24
<imgsrc="../images/06-1_request-body.png"width="600"alt="Google OAuth Playground Request Body configuration for new education affiliation" />
23
25
9.**OPTIONAL:** In the **Request Body** text box, edit the XML to reflect your institution.<br>
24
-
*For ```<disambiguated-organization-identifier>```, use the [Ringgold Identify database](http://ido.ringgold.com/identify_new/cfm/si_pd.cfm?PID=1) to find the Ringgold ID for your institution (you'll need to [register a free Ringgold account](http://ido.ringgold.com/identify_new/cfm/si_pd.cfm?PID=24) in order to search the database).*
26
+
*For ```<disambiguated-organization-identifier>```, use the [Ringgold Identify database](https://www.ringgold.com/identify/) to find the Ringgold ID for your institution (you'll need to [register a free Ringgold account](https://ido.ringgold.com/register) in order to search the database).*
25
27
10. Click **Close**.
26
28
11. Click **Send the request**.
27
29
12. The results will appear in the **Request/Response** section at right. Scroll to the bottom – if you see **HTTP/1.1 201 Created**, your education affiliation was successfully added!<br>
@@ -37,7 +39,7 @@ Still have that Google OAuth Playground window open? If so, continue with step 1
0 commit comments