Skip to content

Latest commit

聽

History

History
244 lines (221 loc) 路 8.88 KB

README.md

File metadata and controls

244 lines (221 loc) 路 8.88 KB
Raw

Orcid module

This module has been developed by blocshop.cz, with support of AAS. The module itself has been substantially remodelled by ADS (to actually work; here my rant should end...eh?)

Documentation

Initially, there was none...

ORCID is using 3-legged OAuth: which means the user has to be redirected to ORCID, authenticate with ORCID and authorize 'ADS application' to gain access to user's records.

  • Originally, this mechanism was implemented through a separate window (orcidLoginContainer.html)
  • When authenticated, ORCID redirects to /oauthRedirect.html
  • which in turn passes code to /oauth/exchangeOauthCode; to exchange code for access token (this method is implemented in server.js)

Here a link to page which describes authentication example with ORCID:

http://support.orcid.org/knowledgebase/articles/179969-methods-to-generate-an-access-token-for-testing

Basically, for ADS it goes like this:

the contents of the authorize.json file:

   {
    "errors": [],
    "userName": {
        "errors": [],
        "value": "",
        "required": true,
        "getRequiredMessage": null
    },
    "password": {
        "errors": [],
        "value": "",
        "required": true,
        "getRequiredMessage": null
    },
    "clientId": {
        "errors": [],
        "value": "APP-P5ANJTQRRTMA6GXZ",
        "required": true,
        "getRequiredMessage": null
    },
    "redirectUri": {
        "errors": [],
        "value": "http://localhost:8000/oauthRedirect.html",
        "required": true,
        "getRequiredMessage": null
    },
    "scope": {
        "errors": [],
        "value": "/orcid-profile/read-limited /orcid-works/create /orcid-works/update",
        "required": true,
        "getRequiredMessage": null
    },
    "responseType": {
        "errors": [],
        "value": "code",
        "required": true,
        "getRequiredMessage": null
    },
    "approved": true,
    "persistentTokenEnabled": true
  }

response should be st like:

  {"errors":[],"userName":{"errors":[],"value":"","required":true,"getRequiredMessage":null},"password":{"errors":[],"value":"","required":true,"getRequiredMessage":null},"clientId":{"errors":[],"value":"APP-P5ANJTQRRTMA6GXZ","required":true,"getRequiredMessage":null},"redirectUri":{"errors":[],"value":"http://localhost:8000/oauthRedirect.html?code=bG0GoE","required":true,"getRequiredMessage":null},"scope":{"errors":[],"value":"/orcid-profile/read-limited /orcid-works/create /orcid-works/update","required":true,"getRequiredMessage":null},"responseType":{"errors":[],"value":"code","required":true,"getRequiredMessage":null},"approved":true,"persistentTokenEnabled":true}

response is:

  {"access_token":"ea12a66a-2a07-49fc-b0cb-9d0967c484c8","token_type":"Bearer","expires_in":3599,"scope":"/orcid-works/create /orcid-profile/read-limited /orcid-works/update","orcid":"0000-0001-8178-9506","name":"Roman Chyla"}

then with the access_token, we can start doing stuff:

  - search: curl -H 'Content-Type: application/json' -H 'Authorization: Bearer ea12a66a-2a07-49b-9d0967c484c8' -H 'Accept: application/json'  'https://api.sandbox.orcid.org/v1.1/search/orcid-bio/?q=ads'

Alternative, obtain permanent access token (this can be good only for testing, it must be the ADS testing account):

curl -i -L -H 'Accept: application/json' --data 'client_id=APP-P5ANJTQRRTMA6GXZ&client_secret=989e54c8-7093-4128-935f-30c19ed9158c&grant_type=client_credentials&scope=/orcid-profile/read-limited%20/orcid-works/create%20/orcid-works/update' 'https://api.sandbox.orcid.org/oauth/token'

{"access_token":"8f314d8d-928f-4df1-b276-5be866eac3b2","token_type":"Bearer","expires_in":3599,"scope":"/activities/read-limited /activities/update /affiliations/create /affiliations/read-limited /affiliations/update /authenticate /funding/create /funding/read-limited /funding/update /orcid-bio/external-identifiers/create /orcid-bio/read-limited /orcid-bio/update /orcid-profile/read-limited /orcid-works/create /orcid-works/read-limited /orcid-works/update /person/read-limited /person/update /read-public","orcid":null}

{
  "message-version": "1.2",
  "orcid-profile": {
    "group-type": null,
    "client-type": null,
    "orcid-identifier": {
      "path": "0000-0001-8178-9506",
      "host": "sandbox.orcid.org",
      "uri": "http://sandbox.orcid.org/0000-0001-8178-9506",
      "value": null
    },
    "orcid-activities": {
      "affiliations": null,
      "orcid-works": {
        "scope": null,
        "orcid-work": [
          {
            "work-title": {
              "subtitle": null,
              "title": {
                "value": "ADS 3.0"
              }
            },
            "work-external-identifiers": {
              "work-external-identifier": [
                 {
                 "work-external-identifier-type": "source_work_id",
                 "work-external-identifier-id": "aaaabbbbccccdddd"
                 }
              ],
            },
            "last-modified-date": {
              "value": 1422645668284
            },
            "created-date": {
              "value": 1422645668284
            },
            "visibility": "PUBLIC",
            "work-type": "JOURNAL_ARTICLE",
            "publication-date": {
              "month": {
                "value": "01"
              },
              "day": {
                "value": "01"
              },
              "media-type": null,
              "year": {
                "value": "2015"
              }
            },
            "journal-title": {
              "value": "foo"
            },
            "url": null
          }
        ]
      }
    },
    "orcid": null,
    "type": "USER",
    "orcid-preferences": {
      "locale": "EN"
    },
    "orcid-history": {
      "last-modified-date": {
        "value": 1424114629494
      },
      "creation-method": "DIRECT",
      "submission-date": {
        "value": 1422645321288
      },
      "verified-primary-email": {
        "value": false
      },
      "verified-email": {
        "value": false
      },
      "visibility": null,
      "source": null,
      "claimed": {
        "value": true
      }
    }
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<orcid-message xmlns="http://www.orcid.org/ns/orcid"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="https://raw.github.com/ORCID/ORCID-Source/master/orcid-model/src/main/resources/orcid-message-1.2.xsd">
<message-version>1.2</message-version>
<orcid-profile>
  <orcid-activities>
    <orcid-works>
      <orcid-work>
        <work-title>
          <title>API Test Title</title>
          <subtitle>My Subtitle</subtitle>
          <translated-title language-code="fr">API essai Titre</translated-title>
        </work-title>
        <journal-title>Journal Title</journal-title>
        <short-description>My Abstract</short-description>
        <work-citation>
          <work-citation-type>formatted-apa</work-citation-type>
          <citation>My correctly formatted citation</citation>
        </work-citation>
        <work-type>journal-article</work-type>
        <publication-date>
          <year>2010</year>
          <month>11</month>
        </publication-date>
        <work-external-identifiers>
          <work-external-identifier>
            <work-external-identifier-type>锘縮ource-work-id</work-external-identifier-type>
            <work-external-identifier-id>1234</work-external-identifier-id>
          </work-external-identifier>
        </work-external-identifiers>
        <url>www.orcid.org</url>
        <work-contributors>
          <contributor>
            <credit-name>LastName, FirstName</credit-name>
            <contributor-attributes>
              <contributor-sequence>first</contributor-sequence>
              <contributor-role>author</contributor-role>
            </contributor-attributes>
          </contributor>
        </work-contributors>
        <language-code>en</language-code>
        <country>US</country>
      </orcid-work>
    </orcid-works>
  </orcid-activities>
</orcid-profile>
</orcid-message>