Skip to content

Commit 0c488e5

Browse files
Merge pull request #9 from ORCID/missing-page
push all the things to git
2 parents 4b93b02 + 90146d5 commit 0c488e5

23 files changed

+107
-0
lines changed

docs/images/03_01_oauth-config.png

92.4 KB
Loading
93.4 KB
Loading
115 KB
Loading
88.3 KB
Loading
353 KB
Loading

docs/read.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
## Read the record
2+
3+
**_Important! Make sure you have added something to your record before going any further. The subsequent calls won't work properly otherwise. Skip back to [Add info to your Sandbox record](/sandbox) if you are unsure about this._**
4+
5+
The next thing we can do with our newly acquired token is to read the record. This is the next logical step and a useful way of acquiring put-codes that you will need for PUT step later.
6+
7+
8+
Revisit Google playground, hopefully you have kept the window open, if not, you could re-initialise it with the url you saved earlier(Clicking ok on the warning that comes up). Or you can set up for the call again by filling all the relevant fields, making sure they look like the screenshots below:
9+
10+
1. Make sure the **configuration** has your **client and secret**
11+
12+
<img src="../images/03_01_oauth-config.png" width="600" alt="Google Oauth Playground Configuration for client and secret" />
13+
14+
2. below Step 2 you should have your **token** filled in
15+
16+
It should either still have the token from earlier or you can fill it in from the previous exercise like so:
17+
18+
<img src="../images/03_02_step-2-playground-access-token.png" width="600" alt="Google Oauth Playground step 2 access token field" />
19+
20+
3. Beneath Step 3 Click **Add headers**, enter the values below, then click **Add** and **Close**
21+
- **Header name:** ```Content-type```
22+
- **Header value:** ``application/vnd.orcid+xml``
23+
- **Header name:** ```Authorization```
24+
- **Header value:** ``Your token``
25+
26+
The step 3 Configurations should look like the screenshots below. You should add two headers,
27+
28+
29+
4. Set the HTTP Method to **GET**.
30+
31+
<img src="../images/03_03_Step-3-playground-set-up-header.png" width="600" alt="Google Oauth Playground step 3 headers" />
32+
33+
34+
5. In the request URI field enter :
35+
36+
``https://api.sandbox.orcid.org/v3.0/0000-XXXX-XXXX-XXXX/record``
37+
38+
<br>
39+
*Replace [ORCID ID] with the iD for your Sandbox record, format XXXX-XXXX-XXXX-XXXX*<br>
40+
41+
42+
Note the _endpoint_ This is the word at the end of the URI. In this case we are reading a _summary_ of the whole record so we end the URL with /record as shown above.
43+
44+
45+
<img src="../images/03_04_Step-3-playground-set-up-URI.png" width="600" alt="Google Oauth Playground step 3 URI" />
46+
47+
48+
6. Click **Send the request**
49+
50+
In the Request/Response field you should see an XML summary of the whole record. It will look a bit like the example below which shows the first part of the response. If you added something to your record as shown in [Add info to your Sandbox record](sandbox.md) you should have at least one **put-code** returned as shown below :
51+
52+
<img src="../images/03_05_google-playground-response.png" width="600" alt="Google Oauth Playground response" />

site/assets/javascripts/application.b260a35d.js

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

site/assets/javascripts/lunr/lunr.ja.js

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

site/assets/javascripts/lunr/lunr.nl.js

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

site/assets/javascripts/lunr/lunr.th.js

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)