當請求您的用戶創建或連接他們的 ORCID iD 到您的系統,您可以通過填寫您的系統已經存儲的關於他們的信息、設置他們的顯示語言並讓他們退出任何活動會話以確保他們已登錄到正確的會話中,從而節省研究人員的時間和精力。 ORCID 帳戶。
ORCID API 提供了多種用於自定義用戶體驗的選項
預先填寫註冊/登錄表格
ORCID 為成員提供使用 https://orcid.org/oauth/authorize URL 上的參數預先填寫 OAuth 註冊/登入表單的選項,作為 API 互動的一部分
可以使用任何或所有參數:
參數 | 場 | 筆記 |
姓 | 給定的名稱 | 名字 字段將填寫在 登記表 如果指定的電子郵件地址或 ORCID iD 與活躍的不匹配 ORCID 記錄。 |
姓氏 | 姓 | 姓 字段將填寫在 登記表 如果指定的電子郵件地址或 ORCID iD 與活躍的不匹配 ORCID 記錄。 |
電子郵件 | 電郵 | 電子郵件/ORCID iD 字段將填寫在 登錄表格 如果在我們的系統中找到指定的電子郵件地址並且無效 ORCID iD 是指定的。 電子郵件 字段將填寫在 登記表 如果在我們的系統中找到指定的電子郵件地址並且無效 ORCID iD 已指定。電子郵件地址應為 網址編碼,包括將“@”更改為“%40”。如果您知道用戶的 ORCID iD 和電子郵件地址,我們建議 僅由 提供 ORCID iD 在 orcid 參數中。 |
蘭花 | ORCID iD | 電子郵件/ORCID iD 字段將填寫在 登錄表格 如果指定 ORCID iD 在我們的系統中找到。 登記表 否則將顯示如果指定 ORCID iD 在我們的系統中找不到。 ORCID iD 必須在 16 位格式 iD 的URI. |
帶有這些參數的示例 URL 是
https://sandbox.orcid.org/oauth/authorize?client_id=APP-NPXKK6HFN6TJ4YYIn&response_type=coden&scope=/authenticaten&redirect_uri=https%3A%2F%2Fdevelopers.google.com%2Foauthplaygroundn&family_names=Finn&given_names=Huckleberry&email=huckle%40mailinator.com
設置顯示語言
ORCID 提供使用 https://orcid.org/oauth/authorize URL 上的「lang」參數指定 OAuth 註冊/登入表單的顯示語言的選項,作為 API 互動的一部分。這也將設定用戶的語言顯示首選項。
用戶 可以隨時自行更改顯示語言。 可以使用以下語言設置:
語言 | 推薦碼 |
阿拉伯語 | ar |
切什蒂納(捷克語) | cs |
English | en |
西班牙語(西班牙) | es |
法語(法國) | fr |
德語(德國) | de |
義大利文(義大利文) | it |
日本語(日語) | ja |
한국어(韓語) | ko |
波蘭語(波蘭語) | pl |
Português(葡萄牙語) | pt |
Русский(俄語) | ru |
Türkçe(土耳其語) | tr |
簡體中文(簡體中文) | zh_CN的 |
繁體中文(繁體中文) | zh_TW的 |
例
此示例預先填寫表單並將語言設置為西班牙語
https://sandbox.orcid.org/oauth/authorize?client_id=APP-NPXKK6HFN6TJ4YYI
&response_type=code
&scope=/authenticate
&redirect_uri=https%3A%2F%2Fdevelopers.google.com%2Foauthplayground
&family_names=Finn&given_names=Huckleberry&email=huck%40mailinator.com
&lang=es
默認為登錄表單或註冊表單
目前, ORCID OAuth 屏幕默認顯示登錄表單,並提供切換到註冊表單的鏈接。 無論默認行為如何,都可以通過添加參數“&show_login=true”來顯示登錄表單或“&show_login=false”來顯示註冊表單來設置顯示的表單。 請注意,如果電子郵件地址或 ORCID iD 在 URL 中提供,顯示的表單將由這些參數確定,&show_login 參數將被忽略。
ORCID 強烈建議允許最終用戶調整 OAuth 登錄窗口的大小以提高可訪問性,這與我們圍繞包容性的價值觀一致。
通過自定義“狀態”參數識別研究人員
出於技術原因,某些集成使用它。 它不會出現在登錄屏幕上。
可以在授權 URL 中包含狀態參數以識別用戶,例如轉換為系統內用戶內部標識符的唯一數字序列。 該參數不影響用戶體驗,但會與授權碼一起返回,可用於識別用戶或會話。 如果用戶拒絕訪問,也會返回 state 參數。
請注意,state 參數有 2000 個字符的限制。
(可選)強制退出
如果您擔心一台機器上有多個用戶,您可以註銷該用戶。
如果您擔心多個用戶在同一台機器上並且不在會話之間退出,您可以強制他們在 OAuth 過程中重新進行身份驗證。 只需包括 prompt=login
在 OAuth 請求中。 您還可以以秒為單位設置 max_age,以強制用戶在會話超過一定長度時重新進行身份驗證。 查看我們的 OpenID Connect 文檔 閲讀更多的細節。
跳過授權
ORCID 在某些情況下跳過授權。