当请求您的用户创建或连接他们的 ORCID iD 到您的系统,您可以通过填写您的系统已经存储的关于他们的信息、设置他们的显示语言以及让他们退出任何活动会话以确保他们已登录到正确的会话中,从而节省研究人员的时间和精力。 ORCID 帐户。
ORCID API 提供了多种用于自定义用户体验的选项
预先填写注册/登录表格
ORCID 为成员提供了使用 https:// 上的参数预填写 OAuth 注册/登录表单作为 API 交互的一部分的选项orcid.org/oauth/授权网址
可以使用任何或所有参数:
产品型号 | 领域 | |
姓 | 给定的名称 | 名字 字段将填写在 登记表格 如果指定的电子邮件地址或 ORCID iD 与活跃的不匹配 ORCID 记录。 |
姓氏 | 姓 | 姓氏 字段将填写在 登记表格 如果指定的电子邮件地址或 ORCID iD 与活跃的不匹配 ORCID 记录。 |
邮箱地址 | 电邮 | 电子邮件/ORCID iD 字段将填写在 登录表格 如果在我们的系统中找到指定的电子邮件地址并且无效 ORCID iD 是指定的。 邮箱地址 字段将填写在 登记表格 如果在我们的系统中找到指定的电子邮件地址并且无效 ORCID iD 已指定。电子邮件地址应为 网址编码,包括将“@”更改为“%40”。如果您知道用户的 ORCID iD 和电子邮件地址,我们建议 仅由 提供 ORCID iD ,在 orcid 参数。 |
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:// 上的“lang”参数将 OAuth 注册/登录表单的显示语言指定为 API 交互的一部分的选项orcid.org/oauth/authorize 网址。 这还将设置用户的语言显示首选项。
用户 可以随时自行更改显示语言. 以下语言设置可用:
语言 | 代码 |
عربى(阿拉伯语) | ar |
切什蒂纳(捷克语) | cs |
英语 | 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 参数。
请注意,状态参数有 2000 个字符的限制。
(可选)强制退出
如果您担心一台机器上有多个用户,您可以注销该用户。
如果您担心多个用户在同一台机器上并且不在会话之间退出,您可以强制他们在 OAuth 过程中重新进行身份验证。 只需包括 prompt=login
在 OAuth 请求中。 您还可以以秒为单位设置 max_age,以强制用户在会话超过一定长度时重新进行身份验证。 查看我们的 OpenID Connect 文档 以获得更多细节。
跳过授权
ORCID 在某些情况下跳过授权。