-
Notifications
You must be signed in to change notification settings - Fork 98
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #20 from andreyyudin/feature/new-backend
Added the documentation of ORCID backend
- Loading branch information
Showing
1 changed file
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
ORCID | ||
=============================== | ||
|
||
ORCID_ uses OAuth 2 for authentication. | ||
|
||
- Register an ORCID account, go to `Developer tools`_, enable the public API, | ||
create a new application, set the redirect URI to | ||
``http://example.com/complete/orcid/`` replacing ``example.com`` with your | ||
domain. | ||
|
||
- Fill the ``Client ID`` and ``Client secret`` values from the app details in | ||
`Developer tools` (you might need to press "Show details") in the settings:: | ||
|
||
SOCIAL_AUTH_ORCID_KEY = '' | ||
SOCIAL_AUTH_ORCID_SECRET = '' | ||
|
||
|
||
Sandbox | ||
------- | ||
|
||
ORCID supports a sandbox mode for testing, there's a custom backend for it | ||
which name is ``orcid-sandbox`` instead of ``orcid``. Same settings apply | ||
but use these instead:: | ||
|
||
SOCIAL_AUTH_ORCID_SANDBOX_KEY = '' | ||
SOCIAL_AUTH_ORCID_SANDBOX_SECRET = '' | ||
|
||
.. _ORCID: https://orcid.org/ | ||
.. _Developer tools: https://orcid.org/developer-tools |