ORCID 提供多种 API,允许您的系统连接到 ORCID 注册表,包括读取和写入 ORCID 记录。 某些 API 函数对任何人都可以免费使用(公共 API); 其他人只能使用 ORCID 会员组织(会员和高级会员 API)。
任何人都可以在我们的沙盒测试服务器上自由测试 API 我们鼓励所有组织使用 ORCID – 会员和非会员 – 加入我们 API用户组,您可以在这里提问并了解新技术的发展。
在此处搜索常见问题解答:
基础知识
当您要求研究人员使用他们的身份登录时,您会收集经过身份验证的 ID ORCID ID。 此过程使用称为“OAuth”或“SSO”的技术,应内置到您的工作流程中。
请参阅 API 教程 '获得认证 ORCID iD' 更多细节。
获得添加或更新用户数据权限的过程 ORCID 记录使用 OAuth,如我们的 3 条腿 OAuth 常见问题解答。 只要 ORCID 会员可以使用会员 API 请求更新权限。 简单来说,它的工作原理是这样的:
- 您的本地系统会创建一个特殊链接
- 单击时,用户将被发送到 ORCID, 登录并授予权限
- ORCID 使用“授权码”将用户发送回您的系统
- 您的系统将该代码交换为“访问令牌”
- 访问令牌可让您更新用户的记录
收集验证 ORCID 通过 OAUTH 流程为个人提供的 iD 很重要。 个人登录他们的 ORCID 帐户使用他们注册的电子邮件地址和密码,或者他们可以创建一个新帐户,然后授权您的系统获取他们的 ORCID ID。 这可确保您获得正确的 ORCID iD 对于研究人员,该记录上的信息反映了他们的研究活动(见 签名 I 有什么特别之处). � �
您可以通过将经过验证的信息连接到他们的 ORCID 记录。 您还将帮助建立对学术交流的信任,并且通过使数据保持最新,您可以减轻用户的报告负担并提高数据质量。
ORCID 研究机构
除了用作研究人员的持久标识符之外, ORCID 可以帮助您控制您的机构名称在研究系统中的使用方式。 结合其他持久标识符 ORCID 使您能够权威地声明您的教职员工和学生与您所在机构的关系。 你也可以使用 ORCID 用于接收有关研究活动的实时通知、自动更新表格以及关注校友职业的 API。
ORCID 资助机构
通过嵌入 ORCID 在您的资助工作流程中使用 iD,您可以可靠地连接您的受助人和资助计划 - 并节省每个人的时间并减少因手动键入信息而导致的错误。 使用 ORCID 在您的系统中,您可以通过断言个人与您授予他们的资助之间的联系,在构建可信的研究信息基础设施方面发挥自己的作用。
ORCID 对于出版商
研究人员是学术和研究出版商所做一切的核心。 准确的作者和审稿人信息对于索引、搜索和发现、出版物跟踪、资金和资源使用归属以及支持同行评审至关重要。
ORCID 充当信息中心,使您的作者和审稿人能够可靠地连接到他们的贡献,并共享来自他们的信息 ORCID 在他们与您的发布系统交互时进行记录。 在出版过程中为所有作者和审稿人收集 iD——无论是书籍、期刊、数据集、作文、演示文稿、代码还是各种其他作品——允许轻松共享信息,确保研究人员可以同意共享,节省了研究人员的时间和麻烦,降低了出错的风险,而且至关重要的是,使研究人员能够获得他们所做的重要工作应得的荣誉。
会员组织要求 ORCID 通过完成生产(实时)服务器上的成员 API 凭据 生产会员API客户端申请表. 在发布生产会员 API 凭证之前, ORCID 参与团队将审查您在 ORCID 沙箱。 这让我们有机会看到您构建的出色集成并提供工作流程改进,以及检查所有集成是否符合我们的最佳实践。
要提供您的系统的演示,您需要设置与 ORCID 沙箱 ORCID 团队可以预览。 有几种方法可以共享您的工作沙箱集成:
- 推荐: 现场演示: 联系我们安排现场演示. 我们将提供会议软件,允许您共享您的屏幕以演示您的集成。 这也让我们有机会更多地了解您的系统是如何工作的,以及您如何解释您的系统的好处 ORCID 集成,因此我们可以为您和您的用户提供更好的支持。
- 测试地点: 如果您的开发站点是公开的, 把网址发给我们 以及访问系统的测试凭据(如果需要)和描述如何使用系统的说明 ORCID 特征。 提供额外的文档以验证我们无法从用户端看到的内容,例如使用的 API 版本、您的系统存储了哪些数据等。
- 截屏视频或屏幕截图(推荐用于 ORCID- 需要演示的启用系统): 发送录音或一组截图 带有描述,清楚地解释和演示您的集成在每个步骤中的工作方式,包括如果用户拒绝访问或断开其 iD 连接会发生什么。 请务必提供额外的文档来验证我们无法从用户端看到的任何内容,例如使用的 API 版本和数据的存储方式。¬¨‚
如果您正在使用其中一种 ORCID- 无需演示的启用系统,您可以直接 请求生产会员 API 凭证. 请务必在说明中指定您使用的系统(以及,如果适用,版本)。
集成
公共客户凭据授予个人而非组织。 凭证不能从一个人转移到另一个人,但如果收到各方的同意并且该组织是 API 的活跃成员,则它们可以转换为成员 API 凭证 ORCID.
移动客户端 ID 到会员 API 不会更改客户端 ID,只会更改客户端密码,并且您将使用只读权限保留已连接 iD 的数量。
将公共 API 客户端转换为成员 API 客户端时 公共客户服务条款 不再适用,并由会员协议的条款取代。
对于转移,我们需要:
- 公共 API 客户端的确认 ID 被转换。
- 该组织的主要联系人和当前公共 API 客户端的记录持有者 ID 同意服务条款的变更。 (记录持有人需要是成员组织的雇员、承包商或官员)我们将保留双方同意的记录。
- 迁移发生的日期/时间。 作为此迁移的一部分,我们将更新客户端 ID 并通过加密电子邮件向您发送新的客户端密码。 请注意,一旦我们更新了客户端,您的集成将无法工作,直到您更新客户端密码。 这就是为什么我们需要确定完成此操作的日期和时间,以防止给用户带来不便。
要完成转换,您需要更新:
- 旧客户端密码到新客户端密码。
- API主机来自 酒吧。orcid。ORG 至 蜜蜂。orcid。ORG.
使用转换后的成员 API 客户端 ID,您可以更新范围以添加 成员 API 范围. 这将需要用户授权,并且将生成新的访问令牌以包含新的范围/权限。
请注意,我们无法将成员 API 客户端凭据转换为公共 API 凭据。
您还可以 请求沙箱会员 API 凭证 构建和测试您的应用程序。 这些凭据允许您调用沙箱成员 API 以读取、写入和更新 ORCID 记录。 任何人都可以免费访问沙盒测试环境,即使您不是 ORCID 会员组织。
备注: 如果您使用的第三方系统已经支持 ORCID,您可能不需要注册沙盒 API 凭据。
沙箱让您可以创建测试用户帐户并开发您的集成,而不必担心影响实时(生产)上的数据 ORCID 注册表。 沙箱的行为方式与生产相同 ORCID 注册与 一些例外.
创建测试帐户
为了测试 ORCID API 和 API 调用,例如读取和添加信息到 ORCID 记录,您还需要创建一个测试 ORCID 记录在沙箱中。 这可以通过用户界面完成,就像在生产中一样 ORCID 注册表。 去 https://sandbox.orcid.org/register 并注册一个帐户。
邮寄者电子邮件地址
沙箱服务器仅将通知电子邮件发送至 Mailinator (@mailinator.com) 电子邮件地址,以免无意中向邮件服务器发送垃圾邮件。 除非您使用@mailinator.com 地址,否则您不会收到验证电子邮件或密码重置通知,并且需要验证才能对沙盒记录进行任何手动编辑。 详细了解他们免费使用的公共收件箱 点击此处。 如果您不想使用 Mailinator 地址,然后请记下您的用户名和密码(因为您将在测试时使用它们向您的应用程序授予授权),并联系我们请求验证帮助。
Mailinator 是一种具有公共免费服务和私人付费服务的电子邮件服务。 对于测试,您可以使用完全免费的公共服务。 了解更多关于他们的等级 点击此处.
Mailinator 是第三方服务,不受管理或维护 ORCID. 我们建议您在使用这些地址之前查看此服务的工作原理及其限制。
集成需要存储的不仅仅是 ORCID 记录。 您的系统需要能够:
- 接受并存储 ORCID iD:您的系统需要知道 iD 的 ORCID 记录更新。 将其与研究人员的信息存储在一起。 我们的建议是存储完整的 https URI: https://orcid.org/0000-0001-5727-2427.
- 接受并存储持久化 访问令牌 和 刷新令牌:访问令牌可用于读取和更新记录,以及指示 iD 已通过身份验证。 持久性令牌的有效期大约为 20 年,或者直到用户撤销它们为止。 刷新令牌可用于创建具有相同或有限范围的新访问令牌。 将令牌与研究人员的信息一起存储。 我们还建议您将 令牌范围,以及‚令牌到期.
- 接受并存储 把代码 (如果更新 ORCID 记录):您添加到 ORCID 注册表将返回一个放置代码 ORCID 应用程序接口。 将此放置代码与系统中的项目一起保存,这是您识别需要读取或更新的项目的方式。
- 记录交互:您的系统应该记录对 ORCID 收到的 API 和响应。 这是必要的所以 ORCID 如果以后出现问题,可以提供帮助。
- 当交互未按预期进行时,提供错误消息和支持联系人。
我们建议开发人员在 沙盒测试服务器 在使用生产版本之前。 以下是有关如何在沙盒和生产环境中注册公共 API 凭证的步骤。
- 登录你的 ORCID 记录:
生产服务器: https://orcid.org/signin
沙盒测试服务器: https://sandbox.orcid.org/signin - 在右上角点击你的名字
- 点击 开发者工具 从菜单选项
请注意: 为了访问开发人员工具,您必须验证您的电子邮件地址。 如果您尚未验证您的电子邮件地址,系统会提示您进行验证,然后才能注册公共 API 凭据 - 阅读并同意‘ORCID 公共客户服务条款
- 点击“注册 ORCID 公共 API 凭证”按钮。
填写申请详情表
- 注册公共 API 凭证后,您将被引导回开发人员工具(https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
- 您需要填写提交的申请详细信息表以注册新申请。
- 名字:您的应用程序的名称。 当用户授予您的应用程序权限以获取他们的权限时,这将显示给用户 ORCID iD,它将显示在他们的 受信任组织列表. 我们建议使用您的组织或服务的名称(例如期刊名称)。
- 申请网址: 用户可以访问该网站以了解有关您的应用程序的更多信息。 这也将显示在他们的 受信任组织列表.
- 应用说明:有关您正在开发的应用程序以及您将如何使用用户的应用程序的信息 ORCID ID。 这将在 OAuth 屏幕上向用户显示。
添加 重定向 URI
用户授权您的应用程序后,他们将返回到您指定的 URI。 您必须提前提供这些 URI,否则您的集成用户将遇到错误。
- 在提供的框中输入您的重定向 URI
- 如果您需要输入超过 1 个重定向 URI,请单击“添加另一个重定向 URI”
请注意:
- 只有 HTTPS URI 已在生产中接受
- 已注册的域 必须 与使用的域完全匹配,包括子域
- 尽可能完整注册所有重定向 URI。 这是最安全的选项,也是我们推荐的选项。 有关重定向 URI 的更多信息,请参阅我们的 重定向 URI 常见问题解答
保存您的申请
填写完申请表并添加重定向 URI 后,您可以保存您的申请。
- 单击“保存我的应用程序并生成我的客户端” ID 和秘密'
您将被引导回开发人员工具页面,该页面现在将包含您的公共 API 客户端凭据
更新您的凭据
更改您的申请信息非常简单。
- 编辑相关信息,然后点击“保存申请”
使用您的凭据
现在您已拥有凭据,是时候开始使用 ORCID 公共API!
请注意,如果您成为会员,我们可以将您的凭据传输到会员 API ORCID 会员 在未来。
我们希望所有成员集成都能满足许多要求。 这 ORCID 作为集成审查过程的一部分,团队将确保满足这些要求。
- 使用 OAuth的 认证 ORCID iDs(不允许用户搜索或输入 ORCID 身份证。)
- 包括一个 ORCID 品牌按钮或链接 在您的站点上启动 iD 身份验证。
- 根据我们的提示显示 OAuth 授权屏幕 方针
- 将 HTTPS 用于您网站的重定向 URI 和 ORCID API调用
- 接受并存储在令牌交换中返回的所有数据以及您系统中的用户数据
- 使用适当的 范围 和 请求方法 (例如 POST 调用添加新信息和 PUT 调用更新现有信息)
- 公开显示已认证的 ORCID 身份证。 应按照我们的要求显示 ID 商标和 iD 显示指南。
您需要填写 用于注册客户端应用程序的表单. 以下是请求字段的快速概览:
注意事项 ORCID 员工: 使用这个字段让 ORCID 了解您是否正在使用供应商系统、集成是否经过审核等。
联系邮箱地址:我们会将凭据发送到此地址。 这应该是我们在集成方面一直与之合作的联系人或我们为您的组织持有的技术联系人。
用于接收 PIN 以访问凭据的联系人:我们以安全的方式向您发送完整的凭据。 我们将向此联系人发送用于访问您的 API 凭据的密码。 这需要是与之前列出的联系人不同的联系人。
您的客户端应用程序的简短描述:此文本将显示在授权屏幕上,并带有问号图标给您的集成用户。 需要对您的集成进行简短描述。
您的应用程序主页的 URL:显示为用户内受信任组织列表上的链接 ORCID 受信任方页面。 这应该是返回您的组织或应用程序主页的链接。
客户端的 OAuth2 重定向 URI 或回调 URL:您的 Web 应用程序中允许的 URL,用户在授权访问其访问权限后将返回到该 URL ORCID 记录数据。 对于生产(实时)服务器客户端,所有重定向 URI 都必须是 HTTPS。
提出请求后,会通过手动流程向您发放凭据,您将收到一封电子邮件给客户 iD 和客户机密。 通常,这些请求会在 48 小时内得到处理。
搜索和链接向导 是可用于将项目(主要是有效的)导入到 ORCID 注册表。 它们必须在集成商和 ORCID 在它们可以发布到生产注册环境之前。
根据您对以下问题的回答,您的集成可能适合搜索和链接——在开始开发搜索和链接向导之前,请联系我们进一步讨论:
- 向导的目标受众是什么? 例如,国家、学科或全球层面的作者、审稿人或资助申请者
- 预期的观众人数大约有多少?
- 它会服务于现有巫师服务不足的人群吗? 例如,在特定语言或学科中的研究贡献,或者是新颖的类型
- 您将如何确保向导提供良好的用户体验?
- 您将提供哪些用户支持?
- 是否有——或将有——一个 ORCID 贵组织中为向导指定人员,例如产品经理?
- 你将如何确保 ORCID 身份证经过验证?
- 你 - 或者你会 - 摄取和展示 ORCID 您平台上的 ID?
- 您的平台搜索是否由 iD 启用?
请参阅我们的 搜索和链接工作流程 以获得更多细节。
会员组织要求 ORCID 通过完成生产(实时)服务器上的成员 API 凭据 生产会员API客户端申请表. 在发布生产会员 API 凭证之前, ORCID 参与团队将审查您在 ORCID 沙箱。 这让我们有机会看到您构建的出色集成并提供工作流程改进,以及检查所有集成是否符合我们的最佳实践。
要提供您的系统的演示,您需要设置与 ORCID 沙箱 ORCID 团队可以预览。 有几种方法可以共享您的工作沙箱集成:
- 推荐: 现场演示: 联系我们安排现场演示. 我们将提供会议软件,允许您共享您的屏幕以演示您的集成。 这也让我们有机会更多地了解您的系统是如何工作的,以及您如何解释您的系统的好处 ORCID 集成,因此我们可以为您和您的用户提供更好的支持。
- 测试地点: 如果您的开发站点是公开的, 把网址发给我们 以及访问系统的测试凭据(如果需要)和描述如何使用系统的说明 ORCID 特征。 提供额外的文档以验证我们无法从用户端看到的内容,例如使用的 API 版本、您的系统存储了哪些数据等。
- 截屏视频或屏幕截图(推荐用于 ORCID- 需要演示的启用系统): 发送录音或一组截图 带有描述,清楚地解释和演示您的集成在每个步骤中的工作方式,包括如果用户拒绝访问或断开其 iD 连接会发生什么。 请务必提供额外的文档来验证我们无法从用户端看到的任何内容,例如使用的 API 版本和数据的存储方式。¬¨‚
如果您正在使用其中一种 ORCID- 无需演示的启用系统,您可以直接 请求生产会员 API 凭证. 请务必在说明中指定您使用的系统(以及,如果适用,版本)。
Webhooks 允许高级会员“观看” ORCID 记录并通知任何更改。
使用 API 和高级会员客户端凭据,高级会员可以为每个经过身份验证的用户注册回调 URL ORCID iD 他们希望跟踪。 这 ORCID 记录持有者不必授予组织注册 URL 的特定权限,但实际的数据交换基于由组织设置的隐私级别 ORCID iD 持有人。
有了这个 ORCID 当有更改时,将通过发送请求来通知指定的 URL ORCID 记录。
元数据
所有附属部分在 API 中使用相同的元数据集:
- 机构名称:* 最高级别组织的名称(例如“波士顿大学”而不是“波士顿大学医学院”)。
- 组织城市:* 组织所在的城市。
- 组织区域: 组织所在的地区。
- 组织国家* 组织所在的国家/地区。 这应该填充 两个字母的 ISO 3166 Alpha-2 国家代码.
- 组织 ID (ROR、GRID、Ringgold** 或 LEI):* 组织及其来源的唯一标识符。 我们建议上级组织 ID 在附属机构内使用,而不是在部门或部门内使用。
- 角色/头衔: 所担任的职位,或授予或将授予的学位。
- 部门: 上级组织的任何分部。
- 网址: 有关从属关系的资源的 URL
- 开始日期: 研究人员和组织之间的关系开始的日期(可以指定为年、月和日)。
- 结束日期: 研究人员和组织之间的关系结束的日期(可以指定为年、月和日)
- 描述从属关系的外部持久标识符: 实际从属关系断言的唯一标识符
*表示必填字段。
**尽管 Ringgold 标识符仍然存在于 ORCID 截至 1 年 2023 月 XNUMX 日, ORCID 我们不再接收注册机构使用的 RINGGOLD 组织标识符数据库的更新,也无法处理或使用该日期之后创建的 RINGGOLD ID。 看看我们的 常见问题 获取更多信息。
在传记部分下有许多部分 ORCID 记录:
也称为: 这可以包括缩写的名字、变体,包括一个或多个名字的首字母、中间名、旧名或备用名,或不同字符集中的名字。 每个名称都应作为单个项目添加。 这是一个最多 255 个字符的自由文本字段。
网站: 此部分包括说明(可选)和网站 URL(必需)
国家: 国家/地区部分 ORCID record 允许研究人员和成员组织添加一个或多个他们进行研究的国家,或者是他们研究的主题。 国家/地区列表中的项目来自 ISO 3166,即国家和地区代码的国际标准。
外部标识符(其他 ID): 此部分只能由成员组织添加。 请注意,尽管许多组织为其研究人员收集其他外部标识符,例如 Scopus 作者 ID,但只有这些标识符的发布者才能对其进行权威声明。 因此,我们强烈建议您的组织仅添加您的系统创建并用于识别研究人员的标识符。 此部分包括四个组成部分(* 表示必填字段):
- 身份证类型*
- 身份证值*
- 身份证关系*
- 身份证网址
- 标题:* 作品名称
- 字幕: 作品的副标题
- 翻译标题: 作品以另一种语言出现的标题,翻译标题的语言被记录为一个属性
- 期刊名称: 作品所属的更大集合的名称,例如期刊文章的期刊或书籍章节的书籍。 即使这被标记为期刊标题,它也可以用于其他作品
- 简短的介绍: 作品的简要描述或摘要
- 引用类型: 提供引文的格式。此字段是从包含以下值的列表中选择的:APA、BIBTEX、CHICAGO、HARVARD、IEEE、MLA、RIS、UNSPECIFIED、VANCOUVER
- 引文价值: 引文内容
- 工作类型: 作品的对象类型。 该字段必须从 支持的工作类型
- 发布日期: 作品发表的日期。 我们建议使用最早的出版日期
- 外部 ID 类型:* 标识符的类型。 该字段必须从 支持的工作标识符
- 外部 ID 值:* 标识符本身
- 外部 ID 网址: 标识符解析为的 url
- 外部身份关系:* 仅适用于正在添加的作品的标识符将被标记为 Self。 应用于此作品所属的更大集合的标识符将设置为 Part-of。 适用于作品替代版本的标识符将设置为 version-of。 适用于工作资助的标识符将设置为资助者。
- 工作网址: 链接到作品的网址
- 工作贡献者: 有关创作作品的个人的信息
- 语言代码: 用于描述之前领域工作的语言
- 国家: 作品出版地或以其他方式与之相关的国家/地区
* 表示必填字段
有多种类型的研究资源,从一次性试剂到具有专用设施的国际合作。 ORCID 支持可以链接到其他地方以获取特定领域详细信息的高级模型。
有四种高级资源类型:
资源类型 | 定义 | 国际私人包机价格项目范例 |
基础设施 | 用于进行研究的设施、建筑物或其他物理空间 | 中子散裂源、动物设施、数据飞地、考古遗址、望远镜阵列。 船舶、飞机、农场、实验室 |
购物 | 用于研究目的的一个物体或一组物体; 可以是有形的或数字的 | 海洋任务、实地活动、协作数据集或资源、善本收藏; 博物馆收藏,生物标本收藏 |
设备 | 用于研究目的的硬件 | 显微镜、电脑、玻璃器皿、样品、材料 |
服务 | 用于研究目的的服务 | 蛋白质组学分析、计算服务、数据分析、后勤支持、法律服务、文案编辑、专家或员工建议 |
除了资源类型,一个研究资源项目 ORCID 记录包含以下信息。 * 表示必填项目
- 提案/注册名称:* 这是研究资源的主要展示区域,例如“中子束奖”或“束时间和计算资源”
- 提案/注册 ID:* 这是使用资源的提议或请求的公共标识符(DOI、PURL 等)。 理想情况下,此标识符应该是持久的,并解析为包含有关提案或请求的信息的公共登录页面,例如奖励数据库或资源用户日志。
- 提案主持人:* 这是接收和处理资源建议或请求的组织。 提案主机可能与资源主机相同
- 提案主办机构 ID* 这是管理提案或请求流程的组织的公共标识符(ROR、GRID、开放资助者 ID、LEI 之一)
- 资源):* (至100年)
- 资源名称:* – 例如,“中子散裂源”
- 资源 ID:* – 来自可接受的 PID 类型的可扩展列表(例如 RRID、DOI、URI)
- 资源类型:* – “基础设施”、“集合”、“设备”或“服务”之一
- 资源主机:* 这是管理或运营资源的组织,例如国家实验室、政府机构或研究型大学
- 资源宿主组织 ID:* 这是托管资源的组织的公共标识符(ROR、GRID、Ringgold**、开放资助者 ID、LEI 之一)
- 提案网址: 提案的链接
- 提案开始日期: 访问开始日期
- 提案结束日期: 访问结束或将结束的日期
* 表示必填字段
**尽管 Ringgold 标识符仍然存在于 ORCID 截至 1 年 2023 月 XNUMX 日, ORCID 我们不再接收注册机构使用的 RINGGOLD 组织标识符数据库的更新,也无法处理或使用该日期之后创建的 RINGGOLD ID。 看看我们的 常见问题 获取更多信息。
- 角色:* 个人在审稿过程中的角色,可以选择:主席、编辑、成员、组织者、审稿人
- 组标识符:* 该集团 ID 用于聚合目的——对于期刊文章,默认标识符是 eISSN,它通过与 ISSN 数据库的集成自动填充。 请注意,如果您需要分配 ISSN 以外的标识符,则需要 之前创建它。
- 召集机构*: 组织评审的组织——期刊出版商、会议组织者、资助机构、教师等
- 组织标识符: 召集组织的持久标识符。 我们目前支持 ROR、Ringgold**、GRID、LEI 或 Crossref 资助者注册标识符。 请注意:这不是必填字段,但我们建议您发布此数据(如果您有可用的数据)。
- 审查数据:* 此数据指的是审查活动,而不是审查的内容
- 类型: 评审活动类型:评审或评估
- 日期: 审查完成的日期。 这可以是广泛的 (2008) 或具体的 (2010-12-10)
- 评论标识符: 一个独特的,最好是可解析的 识别码 由审查本身的来源提供。 除非评论是公开可用的,否则我们建议这不包含可以追溯到评论主题的可识别数据
- 评论网址: 指向在线评论或评论记录的表示的链接
- 审查对象的相关资料: 无论审稿人如何评论
- 科目类型: 被审查的项目类型,例如期刊文章、会议论文
- 这包括 工作类型列表和资助类型列表 (“补助金”、“合同”、“奖励”、“工资奖”) AND 研究-“资源提案” AND “未定义”
- 科目名称: 审查项目名称
- 主题外部标识符: 评论主题的唯一标识符,例如文章 DOI
- 主题容器名称: 评审主题所属对象的名称,例如论文被评审的会议
- 主题网址: 被审查的主题的 URL
- 科目类型: 被审查的项目类型,例如期刊文章、会议论文
* 表示必填字段
**尽管 Ringgold 标识符仍然存在于 ORCID 截至 1 年 2023 月 XNUMX 日, ORCID 我们不再接收注册机构使用的 RINGGOLD 组织标识符数据库的更新,也无法处理或使用该日期之后创建的 RINGGOLD ID。 看看我们的 常见问题 获取更多信息。
- 资金类型:* 授予的资金类型,此字段从包含以下值的列表中选择:Award、Contract、Grant、Salary-award
- 资金名称:* 资助项目名称
- 字幕: 资助项目的副标题
- 翻译标题: 资助的标题以另一种语言出现,翻译标题的语言被记录为属性
- 产品描述:资助项目的描述或简短摘要。
- 金额: 奖项的价值
- 唯一的资金标识符: 根据您的系统所知添加尽可能多的这些,因为它有助于分组 ORCID 纪录。
- 资金标识符类型: 使用授权号、DOI、URI 或提案 ID
- 标识符的值
- 标识符 URL(可选)
- 关系:自我/部分
这是为了表明资助项目与标识符的关系。 例如,如果资助项目是多部分拨款的一个阶段,而标识符是多部分拨款,那么关系将是“part-of”; 如果标识符用于单个阶段,则关系将是“自我”。
- 资助机构(组织):* 有关授予资助的组织的信息
- 机构名称
- 地址(城市和国家)
- 组织标识符:
- 开始日期: 资金开始日期
- 结束日期: 资助结束日期
- 贡献者信息: 有关获得资助的个人的信息
- ORCID ID: ORCID iD 资助项目的每个合作者; 这应该只包括经过身份验证的 ORCID 身份证
- 角色: 研究人员贡献的性质
* 表示必填字段
所有附属部分在 API 中使用相同的元数据集:
- 机构名称:* 最高级别组织的名称(例如“波士顿大学”,而不是“波士顿大学医学院”)。
- 组织城市:* 组织所在的城市。
- 组织区域: 组织所在的地区。
- 组织国家* 组织所在的国家/地区。 这应该填充 两个字母的 ISO 3166 Alpha-2 国家代码.
- 组织 ID (ROR、GRID、Ringgold** 或 LEI):* 组织及其来源的唯一标识符。 我们建议上级组织 ID 在附属机构内使用,而不是在部门或部门内使用。
- 角色/头衔: 所担任的职位,或授予或将授予的学位。
- 部门: 上级组织的任何分部。
- 网址: 有关从属关系的资源的 URL
- 开始日期: 研究人员和组织之间的关系开始的日期(可以指定为年、月和日)。
- 结束日期: 研究人员和组织之间的关系结束的日期(可以指定为年、月和日)
- 描述从属关系的外部持久标识符: 实际从属关系断言的唯一标识符
*表示必填字段。
**尽管 Ringgold 标识符仍然存在于 ORCID 截至 1 年 2023 月 XNUMX 日, ORCID 我们不再接收注册机构使用的 RINGGOLD 组织标识符数据库的更新,也无法处理或使用该日期之后创建的 RINGGOLD ID。 看看我们的 常见问题 获取更多信息。
所有附属部分在 API 中使用相同的元数据集:
- 机构名称:* 最高级别组织的名称(例如“波士顿大学”,而不是“波士顿大学医学院”)。
- 组织城市:* 组织所在的城市。
- 组织区域: 组织所在的地区。
- 组织国家* 组织所在的国家/地区。 这应该填充 两个字母的 ISO 3166 Alpha-2 国家代码.
- 组织 ID (ROR、GRID、RInggold** 或 LEI):* 组织及其来源的唯一标识符。 我们建议上级组织 ID 在附属机构内使用,而不是在部门或部门内使用。
- 角色/头衔: 所担任的职位,或授予或将授予的学位。
- 部门: 上级组织的任何分部。
- 网址: 有关从属关系的资源的 URL
- 开始日期: 研究人员和组织之间的关系开始的日期(可以指定为年、月和日)。
- 结束日期: 研究人员和组织之间的关系结束的日期(可以指定为年、月和日)
- 描述从属关系的外部持久标识符: 实际从属关系断言的唯一标识符
*表示必填字段。
**尽管 Ringgold 标识符仍然存在于 ORCID 截至 1 年 2023 月 XNUMX 日, ORCID 我们不再接收注册机构使用的 RINGGOLD 组织标识符数据库的更新,也无法处理或使用该日期之后创建的 RINGGOLD ID。 看看我们的 常见问题 获取更多信息。
所有附属部分在 API 中使用相同的元数据集:
- 机构名称:* 最高级别组织的名称(例如“波士顿大学”,而不是“波士顿大学医学院”)。
- 组织城市:* 组织所在的城市。
- 组织区域: 组织所在的地区。
- 组织国家* 组织所在的国家/地区。 这应该填充 两个字母的 ISO 3166 Alpha-2 国家代码.
- 组织 ID (ROR、Ringgold**、GRID 或 LEI):* 组织及其来源的唯一标识符。 我们建议上级组织 ID 在附属机构内使用,而不是在部门或部门内使用。
- 角色/头衔: 所担任的职位,或授予或将授予的学位。
- 部门: 上级组织的任何分部。
- 网址: 有关从属关系的资源的 URL
- 开始日期: 研究人员和组织之间的关系开始的日期(可以指定为年、月和日)。
- 结束日期: 研究人员和组织之间的关系结束的日期(可以指定为年、月和日)
- 描述从属关系的外部持久标识符: 实际从属关系断言的唯一标识符
*表示必填字段。
**尽管 Ringgold 标识符仍然存在于 ORCID 截至 1 年 2023 月 XNUMX 日, ORCID 我们不再接收注册机构使用的 RINGGOLD 组织标识符数据库的更新,也无法处理或使用该日期之后创建的 RINGGOLD ID。 看看我们的 常见问题 获取更多信息。
An ORCID 记录可能包含有关研究人员的工作、隶属关系、资金、同行评审等的信息。
上的项目 ORCID 记录可以分解为 断言 连接 ORCID 具有活动或从属关系的 iD 持有者. 这些断言可以添加到 ORCID 由拥有记录的研究人员或由研究人员授予许可的系统进行记录。 我们称添加断言的实体为 ORCID 记录 资源.
国际私人包机价格项目范例
遵循我们透明和公开的原则,我们认为能够看到断言的来源很重要——谁将这些信息添加到记录中。 这是我们如何做到的:
- 当研究人员(或其委托的 值得信赖的个人) 在他们的记录中添加一个断言, ORCID 自动将该人记录为来源
- 当研究人员批准的系统向记录添加断言时, ORCID 自动记录系统所有者(一个 ORCID 成员)作为来源。
我们在用户界面中显示源名称并使其在 API 中可用(及其唯一标识符):
然而,研究信息工作流程可能比这更复杂,断言的真正来源可能会被一个系统代表一个人或另一个系统添加项目无意中掩盖。 为了确保透明度,我们需要区分谁在人和项目之间建立了联系,以及谁将项目添加到记录中。 如上所述,无论谁将项目添加到 ORCID 记录是 资源; 谁在两者之间建立联系 ORCID iD 该项目是 断言起源。
例如:
- 研究人员将数据导入他们的 ORCID 从系统记录,例如搜索和链接向导。 研究人员正在做出将他们的断言联系起来的断言 iD 与项目,所以他们是 断言起源; 而系统是将断言添加到 ORCID 记录—— 资源
- 研究人员与系统 A(系统 A 断言来源),它使用系统 B 提供的服务来更新 ORCID 记录,使系统 B 成为 资源
我们鼓励我们的社区采取措施来保存和共享有关断言来源的信息,以便每个人都能从查看来源中受益。
欲了解更多信息,请访问:
在...工作 ORCID 根据它们的标识符和这些标识符与作品的关系组合在一起。 有四种类型的关系:
- 自:标识符仅指该作品,可以与具有相同标识符的其他作品分组
- 的一部分:作品是此标识符的一部分,不能与其他作品分组
- 版本:这些标识符适用于作品的替代版本,并且可以与标识符的自我和版本分组
- 受资助:这些标识符适用于工作的资金。 这些标识符不用于对作品进行分组。
我们的 API 在 XSD 中为此提供了支持。 每个项目都有一个显示索引属性,指示其在其组中的排名。 最高显示指数是研究者选择的首选项目,通过API添加的未由研究人员排名的项目显示指数为0。显示指数也决定了阅读时的工作顺序 ORCID 记录。
有关分组的更多信息 ORCID 记录,请参阅我们的 支持文章.
ORCID 允许添加多种类型的作品。 以下是当前支持的工作类型列表,与 CASRAI 输出标准基本一致。
相关文献
工作类型 | 使用 |
书 | 由单一作者撰写或基于研究或学术发现而合作撰写的书籍,这些书籍通常来自同行评审的资助。 |
书章 | 由单个作者或合作撰写的文本,基于某个领域的研究或学术发现和专业知识。 |
书评 | 对小说或非小说作品的批判性评论,突出对艺术、领域或学科的贡献。 |
字典条目 | 新词的条目、现有词的新含义、拼写和连字符在较长时期内的变化以及语法变化。 |
论文 | 论文提出了研究产生的原始观点:博士学位的要求。 这仅适用于 API v2.x |
学位论文 | 一篇通常基于原创研究的论文,证明候选人对自己的学科和学术方法的掌握。 这仅适用于 API v3.0+ |
百科全书条目 | 在参考著作或纲要中创作的条目,侧重于特定领域或所有知识分支。 |
编辑过的书 | 由单一作者编辑或合作编辑的书籍,用于传播通常由同行评审资金产生的研究或学术发现。 |
杂志文章 | 同行评审出版物中传播原创研究和学术成果的文章。 |
期刊问题 | 旨在促进智力辩论和探究的期刊出版物。 |
杂志文章 | 定期出版的专题出版物中的文章。 |
手册 | 为教学目的制作的课程和作业材料。 |
在线资源 | 只能通过传统技术方法在网络上访问的信息 |
通讯文章 | 针对研究人员、决策者、专业人士和公众的出版物中报道研究项目或研究主席或研究中心活动的文章。 |
报纸文章 | 每日、每周或每月出版物中的文章,报道针对公众的新闻和社会问题。 |
预印本 | 在正式同行评审和出版之前公开的论文版本。 这仅适用于 API v3.0+ |
报告 | 传播研究合同的结果和可交付成果的报告。 |
检讨 | 对他人工作的正式评估。 这仅适用于 API v3.0+ |
研究工具 | 从研究中确定的一系列观察、测量或事实。 |
受监督的学生出版 | 与论文导师共同发表或由论文导师监督的研究成果文章。 |
test | 评估包括为一般大学选择、特定课程选择或其他评估目的而设计的测试。 |
翻译 | 识别对原始版本的修改的书籍和文章的翻译,例如新的或修订的序言。 |
官网 | Web 上的独立位置,其中提供了有关特定主题的多种类型的信息。 |
工作文件 | 未经审查但可以共享以征求意见的文章的初步版本。 |
研讨会 首页
工作类型 | 使用 |
会议摘要 | 指定长度的文本,说明将在提议的会议文件中讨论的问题。 |
会议论文 | 单独或合作撰写的论文,在学术会议上发表,并在会议记录中发表(而不是在学术期刊上)。 |
会议海报 | 在会议环境中展示的海报,并通过引人注目的图形以有效的方式传达研究亮点。 |
知识产权
工作类型 | 使用 |
泄露 | 将发明确立为现有技术从而防止他人为同一发明或概念申请专利的出版物。 |
执照 | 签署协议以利用某个 IP,例如流程、产品、数据或软件。 |
专利 | 一种知识产权保护形式,根据法律规定发明人和受让人在有限的时间内使用和利用其发明、产品或工艺的专有权。 |
注册版权 | 根据促进艺术、文学、音乐、戏剧和其他创造性作品的创作和获取的法律体系注册的权利所有权。 |
商标 | 产品或服务的名称、单词、短语、徽标、符号、设计、图像等标记,表明来源并提供控制标识符使用的权利。 |
其他名称
工作类型 | 使用 |
注解 | 注释包含关于另一个资源的注释或描述。 这仅适用于 API v3.0+ |
艺术表演 | 信息记录的集合,这些记录结合起来代表了由个人的研究或学术活动产生的或与之相关的艺术或表演成果的完整和最新历史。 |
数据管理平台 | 一份正式声明,描述如何在整个研究项目中管理和记录研究数据,以及有关随后将数据存储在数据存储库中以进行长期管理和保存的条款。 这仅适用于 API v3.0+ |
数据集 | 从研究中确定的一系列结构化观察、测量或事实,可以存储在数据库介质中。 |
发明 | 研究产生的实用和原创成果。 |
演讲稿 | 向听众提供的与研究相关的信息性演讲。 |
物理对象 | 用于研究目的的标本、样本或其他实物; 无生命的三维物体或物质。 这仅适用于 API v3.0+ |
研究技术 | 应用于确定为研究一部分的特定任务的实用方法或技能。 |
软件 | 用于操作计算机或其他技术设备的程序。 |
分拆公司 | 由研究组织设立的公司,目的是将研究项目的结果和发现用于商业用途。 |
标准和政策 | 用作判断基础的规则或原则的发展。 |
技术标准 | 源自可能开发新协议、方法或材料的研究项目的技术标准(工业或其他)。 |
other | 任何其他类型的工作。 |
我们引入了一个新的系统生成字段,该字段以规范化格式表示外部标识符(DOI、PMCID、PMID、ArXiv、Bibcode、ISSN 和 ISBN),用于匹配和分组。 规范化是根据标识符类型的规则完成的,可能包括将所有字母字符设置为小写,或转换空格、破折号、句点和其他可以视为等效的字符。 它还根据需要添加标准前缀和后缀。 例如, https://doi.org/10.1/123, 10.1/123及 https://dx.doi.org/10.1/123 都将出现在此字段中 https://doi.org/10.1/123. 现有标识符值未修改。
- 姓氏:
- 额外
作品 API 2.0 的角色
以下是使用 API 2.0 支持的贡献者角色列表。- 作者
- 受让人
- 编辑
- 主席或翻译
- 共同调查员
- 共同发明人
- 研究生
- 其他发明人
- 首席研究员
- 博士后研究员
- 技术支持人员
作品 API 3.0 的角色
使用 API 3.0,您可以添加上述角色以及其他 CRedIT 角色。 CRediT 分类法包括 对学术工作的 14 种贡献类型, 以及如何分配这些角色的指南。 下面是包含 UI 值和元数据值的完整列表。 元数据值是根据 NISO 实施建议的 URL 'CRediT 应该在 JATS xml v1.2 中编码,通过此链接描述: https://jats4r.org/credit-taxonomy“。 通过 API 添加角色时,仅接受 URL。示例工作贡献者元数据:
https://orcid.org/0000-0001-5109-3700 0000-0001-5109-3700 orcid.org Laure L. Haak first author
资助角色
- 铅
- 共同领导
- 支持
- 其他贡献
ORCID 提供一个免费的文本引用字段,以便研究人员可以轻松地以文本格式输入信息。 但是,我们强烈鼓励所有 API 用户在机器可读的 BibTeX 中添加引文。 尽管早于互联网,但这种古老的格式可以通过集成和作者转换为所需的格式。 大多数参考管理器和发布平台都支持它
有关 BibTeX 的更多信息,请参阅 https://www.bibtex.org.
出版商使用 Crossref 进行 DOI 注册的任何作者都可以从 Crossref 自动更新集成中受益。
发布者需要包含经过身份验证的 ORCID 在 DOI 注册时发送到 Crossref 的元数据中作者的 ID。
然后,Crossref 将通过向作者发出通知来请求作者的许可 ORCID 收件箱更新他们的 ORCID 记录本出版物和任何出版商的任何新出版物。
有关更多信息,请参阅: https://www.crossref.org/community/orcid/
中的每一项 ORCID iD 分配了一个唯一标识它的放置代码。 读取整个记录或部分时,可以找到放置代码作为项目的属性。 什么时候 调用记录上的特定项目,放置代码用于识别项目。 放置代码在它们所指的项目类型中是唯一的。 使用这个例子,只有一个工作在 ORCID 注册表将有放置代码 733535,但 733535 也可以用作资助项目或关键字的放置代码
作为一个好处 ORCID 会员资格,组织可以询问 ORCID 支持额外的PID类型 ORCID 注册表。 例如,成员可以要求我们添加对他们用于识别地质数据库中的样本或数据集的 PID 的支持。 这使得样本和收集它们的人之间建立了联系。 而且,因为我们添加的所有新 PID 类型必须至少是可解析的,最好是 FAIR,所以这些链接是明确的、随着时间的推移持续存在且可操作的 - 使研究人员、成员组织和更广泛的社区受益。
添加您的PID!
作为一个社区组织,我们希望确保 ORCID 支持我们会员使用的PID。 我们保持一个完整的 注册表中支持的现有标识符列表 并邀请 ORCID 会员使用 这种形式 请求额外的PID。 我们的目标是尽快回复您的请求。
ORCID 有一个单独的部分 ORCID record 记录有关资格、认证、证书和徽章的信息。
每个资格项目将始终包含:
- 资格称号
- 提供者的组织 ID (例如 ROR ID)
- 将其添加到 ORCID 记录
- 谁添加了资格(来源)
它们可能包含:
- 有效期,包括资格到期的结束日期
- 资格永久 ID,标识获得的资格类型。
- 资格 URL,其中包含对获得的资格类型的可读描述。
- 资格永久 ID。 这应该链接到资格证书的在线版本。 这可能是现有的唯一 ID 或者只是一个 URI。
身份验证和 OAuth
任何拥有公共或成员 API 凭证的人都可以收到 /读公开 访问令牌。 要获得令牌,您可以调用 ORCID API 令牌端点。
此过程通常称为客户端凭据 OAuth 流程,或 2 步 OAuth。
获取访问令牌以读取沙箱上的公共数据的示例调用 - 用您的凭据替换占位符(确保删除括号。
URL=https://sandbox.orcid.org/oauth/token
HEADER: Accept: application/json
METHOD: POST
DATA:
client_id=[Your public API client ID]
client_secret=[Your public API secret]
grant_type=client_credentials
scope=/read-public
然后,您将收到类似于以下内容的访问令牌。 返回的令牌是长期存在的(大约 20 年不会过期)并且可以多次使用以从中检索公共数据 ORCID 纪录。
{"access_token":"4bed1e13-7792-4129-9f07-aaf7b88ba88f","token_type":"bearer",
"refresh_token":"2d76d8d0-6fd6-426b-a017-61e0ceda0ad2","expires_in":631138518,
"scope":"/read-public","orcid":null}
注意事项: 具有 /authenticate 范围的所有令牌现在也包含 /read-public 范围。 如果仅使用 /authenticate 范围,则可以使用存储的访问令牌读取公共数据,而无需再次获取访问令牌。
要获得 /read-limited 访问权限,您必须征得研究人员的许可。 您可以使用 OAuth 执行此操作。 具体来说, ”三足OAuth“。
有关更多信息,请参见我们的 API 教程:读取数据 ORCID 记录
ORCID 集成使用“3legged OAuth”来验证用户并请求与他们的记录交互的权限。 任何集成都可以使用公共 API 请求读取权限。 ORCID 会员可以使用会员 API 请求更新权限。 它是这样工作的:
- 您创建了一个特殊链接
- 单击时,用户将被发送到 ORCID
- ORCID 要求用户登录
- ORCID 要求用户授予您的应用程序权限
- ORCID 使用授权码将用户发送回您的系统
- 您的系统将该代码交换为访问令牌
定制的授权 URL 包括您的客户信息,以及指定您希望访问的他们记录的特定区域的“范围”。 登录后,用户授权与您的系统的连接,并与授权代码一起返回到您的登录页面。 然后使用此代码获取他们的 ORCID iD 以及对请求的范围有效的访问令牌。
您可以通过指定 API 凭据的客户端来构建授权链接 ID 和相关的登陆页面(重定向 URI)。 您可以通过设置来选择要请求的权限 范围参数.
下面的示例请求读取限制访问数据的权限 ORCID 沙盒测试服务器。 在现实世界中,您会在您的网站上显示此链接,或者在要求用户进行身份验证和授权时将其包含在电子邮件中。 但是,出于测试目的,您可以简单地将其粘贴到您的网络浏览器中。 用您的客户信息替换括号内的数据,并确保删除方括号!
https://sandbox.orcid.org/oauth/authorize?client_id=[Your client ID]&response_type=code&scope=/read-limited&redirect_uri=[Your landing page]
一个用户点击了链接,登录于 ORCID 并授予权限,它们将被重定向回您的站点,如下所示:
https://[Your landing page]?code=Q70Y3A
您应该立即交换授权码 ORCID iD 和访问令牌。 授权码在使用时过期。 请求看起来像这样 不能在网络浏览器中制作,它必须由您的服务器制作。
URL=https://sandbox.orcid.org/oauth/token
HEADER: Accept: application/json
HEADER: Content-Type: application/x-www-form-urlencoded
METHOD: POST
DATA:
client_id=[Your client ID]
client_secret=[Your client secret]
grant_type=authorization_code
code=Six-digit code
redirect_uri=[Your landing page]
ORCID 然后将返回研究人员的身份验证 ORCID iD 和一个 JSON 格式的访问令牌:
{"access_token":"f5af9f51-07e6-4332-8f1a-c0c11c1e3728","token_type":"bearer",
"refresh_token":"f725f747-3a65-49f6-a231-3e8944ce464d","expires_in":631138518,
"scope":"/read-limited","name":"Sofia Garcia","orcid":"0000-0001-2345-6789"}
默认情况下,访问令牌是长期存在的,并在发行后 20 年到期。 令牌在到期前可以多次使用。
使用访问令牌
三足访问令牌链接到特定的 ORCID 记录。 要使用它们,您可以将它们包含在您为读取或更新该记录而发出的 API 请求中。
当请求与某个人交互的权限时 ORCID 用户的记录,您指定一个或多个“范围”。 每个范围都允许您执行某些操作,例如读取记录或更新特定部分。
3条腿 指获取用户许可所涉及的三个参与者; ORCID,您的系统和用户自己。
/认证
此范围用于收集 ORCID iD 并仅阅读记录中的公共信息。 所有其他 3-legged 范围都包含身份验证权限,因此如果要求任何其他访问权限,则可以省略此范围。 此范围在成员或公共 API 上可用。
/read-limited(仅限会员 API)
此范围用于访问读取公共和有限可见性项目上的 ORCID 记录。 此范围仅在成员 API 上可用。
/activities/update(仅限会员 API)
此范围用于编写、更新和删除某个机构的隶属关系、资助、作品和研究资源以及同行评审部分中的项目。 ORCID 记录。 此范围仅在成员 API 上可用。
/person/update(仅限会员 API)
此范围用于写入、更新和删除记录的其他名称、关键字、国家/地区、研究人员 URL、网站和个人外部标识符部分中的项目。 此范围仅在成员 API 上可用。
Openid
当需要 id_token 时,OpenID 集成商使用此范围。 当包含 openid 范围时,注册表将在令牌响应中返回一个 id_token 并授予客户端访问该用户的用户信息端点的权限。 此范围在公共和成员 API 上可用。
请注意,“openid”作用域不像其他作用域那样以“/”开头 ORCID API 范围。 这是因为“openid”范围不是由 ORCID,而是由 OpenID Connect 规范定义。 请看我们的 OpenID 文档 获取更多信息.
多个范围
通过在身份验证 URL 中列出范围并在每个范围之间使用编码空格,可以在单个交互中请求多个范围,例如 scope=/read-limited%20/activities/update%20/person/update
完全访问
如果您想要读取和编辑记录的完全访问权限,请在您的身份验证 URL 中包含三个范围:/read-limited、/activities/update 和 /person/update。 在 URL 中,它们将显示为 scope=/read-limited%20/activities/update%20/person/update
2-legged(客户端凭据)范围
对于某些活动,您不必征得用户许可。 直接从 ORCID API,不需要研究人员授予许可。 具有这些范围的令牌的有效期为 20 年并可重复使用
/读公开
此范围用于读取有关单个的公共信息 ORCID iD 或搜索 ORCID 记录。 此范围在成员或公共 API 上可用。
/ webhook
此范围允许客户端应用程序在 ORCID 记录,以便在记录更新时接收通知。 此范围适用于高级 ORCID 内部使用。 如果您不是高级会员,但希望在开发者沙盒中测试此功能,请 CONTACT ORCID 用户社区.
- 以往 ORCID 支持其他范围,现在已经 逐步淘汰.
- 你可以找出来 在此处添加或更新特定部分需要哪些范围.
如果您担心多个用户在同一台机器上并且不在会话之间退出,您可以强制他们在 OAuth 过程中重新进行身份验证。 只需包括 prompt=login
在 OAuth 请求中。 您还可以以秒为单位设置 max_age,以强制用户在会话超过一定长度时重新进行身份验证。 查看我们的 OpenID Connect 文档 以获得更多细节。
用户 可以随时自行更改显示语言. 以下语言设置可用:
语言 | 代码 |
عربى(阿拉伯语) | ar |
切什蒂纳(捷克语) | cs |
英语 | en |
西班牙语(西班牙) | es |
法语(法国) | fr |
德语(德国) | de |
意大利语(意大利语) | it |
日本语(日语) | ja |
한국어(韩文) | ko |
波兰语(波兰语) | pl |
Português(葡萄牙语) | pt |
Русский(俄语) | ru |
Türkçe(土耳其语) | tr |
简体中文(简体中文) | zh_CN的 |
繁体中文(繁体中文) | zh_TW的 |
可以使用任何或所有参数:
产品型号 | 领域 | |
姓 | 给定的名称 | 名字 字段将填写在 登记表格 如果指定的电子邮件地址或 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
隐式 OAuth 是 OAuth 的轻量级版本,旨在供没有或不想使用服务器端组件的系统使用。 隐式 OAuth 可以完全在浏览器中单独使用 javascript 实现。 它适用于会员和非会员,工作方式如下:
- 您创建了一个特殊链接
- 单击时,用户将被发送到 ORCID
- ORCID 要求用户签署我
- ORCID 要求用户授予您的应用程序权限
- ORCID 将用户发送回您的系统 ORCID iD、访问令牌和 id 令牌。
- 您的系统提取并存储经过身份验证的 ORCID iD 从响应。
出于安全原因,在使用隐式 OAuth 时, ORCID 不会返回具有更新权限的访问令牌。
隐式流
隐式流程的设计使得客户端不需要使用他们的秘密密钥来启动 ORCID 登录。通过将客户端限制到其注册的 redirect_url 来强制执行安全性。 这种较低的安全级别意味着 ORCID 使用隐式流时仅支持 /authenticate 和 openid 范围。 代币也是短暂的,只有 10 分钟的寿命。 建议将此流程用于无法访问后端服务器的客户端应用程序,例如电话应用程序或单页 javascript web 应用程序。
https://localhost/#access_token=24c11342-f5da-4cf9-94a4-f8a72a30da00&token_type=bearer&expires_in=599&tokenVersion=1&persistent=false&id_token=eyJraWQiOiJxYS1vcmNpZC1vcmctcjlhZmw3cWY2aG2c5bmdzenU1bnQ3Z3pmMGVhNmkiLCJhbGciOiJSUzI1NiJ9.eyJhdF9oYXNoIjoiMW52bXZBbVdwaVd0Z3ZKZW1DQmVYUSIsImF1ZCI6IkFQUC02TEtJSjNJNUIxQzRZSVFQIiwic3ViIjoiMDAwMC0wMDAyLTUwNjItMjIwOSIsImF1dGhfdGltZSI6MTUwNTk4Nzg2MiwiaXNzIjoiaHR0cHM6XC9cL29yY2lkLm9yZyIsIm5hbWUiOiJNciBDcmVkaXQgTmFtZSIsImV4cCI6MTUwNTk4ODQ2MywiZ2l2ZW5fbmFtZSI6IlRvbSIsImlhdCI6MTUwNTk4Nzg2Mywibm9uY2UiOiJ3aGF0ZXZlciIsImZhbWlseV9uYW1lIjoiRGVtIiwianRpIjoiY2U0YzlmNWUtNTBkNC00ZjhiLTliYzItMmViMTI0ZDVkNmNhIn0.hhhts2-4-ibjXPW6wEsFRaNqV_A-vTz2JFloYn7mS1jzQt3xuHiSaSIiXg3rpnt1RojF_yhcvE9Xe4SOtYimxxVycpjcm8yT_-7lUSrc46UCt9qW6gV7L7KQyKDjNl23wVwIifpRD2JSnx6WbuC0GhAxB5-2ynj6EbeEEcYjAy2tNwG-wcVlnfJLyddYDe8AI_RFhq7HrY4OByA91hiYvHzZ8VzoRW1s4CTCFurA7DoyQfCbeSxdfBuDQbjAzXuZB5-jD1k3WnjqVHrof1LHEPTFV4GQV-pDRmkUwspsPYxsJyKpKWSG_ONk57E_Ba--RqEcE1ZNNDUYHXAtiRnM3w
看看我们的 技术文档 获取更多信息.
什么是重定向 URI,它们是如何使用的?
我们的 OAuth 身份验证服务使用重定向 URI 作为安全措施。 ORCID 只会将身份验证用户发送到请求身份验证的客户端注册的 URI。 这可以防止服务相互模仿。
请注意: 仅 HTTPS URI 在生产中被接受。 您可以使用 HTTP URI 进行测试,但您需要注册 HTTPS URI 当您申请生产成员 API 凭证时。
我们如何匹配重定向 URI?
- 您必须将子域注册为单独的 URI. https://anythingelse.thirdparty.com 将不起作用。
- 鼓励完全注册所有重定向 URI,包括路径, 是大多数第三方所做的,也是最安全的选择。
- 如果客户端应用程序注册的重定向 uri 只是主机名,则可以使用该主机上的任何重定向 uri. 因此,例如,如果注册了以下重定向 uri: https://thirdparty.com 那么以下所有 redirect_uris 都将起作用:
- https://thirdparty.com/oauth/callback1
- https://thirdparty.com/callback2
- https://thirdparty.com/anything-else-as-long-as-the-host-is-the-same
但是,https://anythingelse.thirdparty.com 不管用。 完全 必须 将子域注册为单独的 URI。
如果我的重定向 URI 不正确会怎样?
发送到验证的用户 ORCID 使用不正确的重定向 URI 将看到类似于此的错误消息:
管理成员的重定向 URI
如果您使用会员 API 并需要对重定向 URI 进行任何更改,请联系我们的参与团队
管理公共客户端的重定向 URI
如果您使用公共 API,则需要按照以下步骤更新与您的关联的重定向 URI 列表 ORCID 公共 API 客户端 ID。 您可以按照以下步骤执行此操作:
- 登录到您的 ORCID 记录
- 点击右上角你的名字
- 选择开发者工具
- 点击客户名称旁边的编辑铅笔
- 编辑现有的重定向 URI 或单击“添加另一个重定向 URI”编辑现有的
- 完成更改后,您需要单击保存图标
仅 HTTPS URI 在生产中被接受。 您可以使用 http URI 进行测试,但在申请生产成员 API 凭证时需要注册 HTTPS URI。
OpenID Connect 1.0 是 OAuth 2.0 协议之上的一个简单的身份层。 它补充了现有的 OAuth 身份验证流程,并以良好描述的方式向客户端提供有关用户的信息。
OpenID 连接是实现 OAuth 和共享有关已验证用户的信息的标准化方法。 现在可以配置要使用的服务 ORCID “开箱即用”以及其他符合标准的 OpenID 连接提供商。 OpenID 连接还提供了可共享的 ID 令牌,它们是签名对象,可以证明用户使用 ORCID 在特定时间。 用户界面元素可以使用这些令牌来维护用户会话。
ORCID 支持 Basic OpenID Provider 一致性配置文件,它是 OAuth 授权代码流的扩展。 ORCID 还支持“/authenticate”和“openid”范围的隐式令牌流。
这意味着 ORCID:
- 嵌入签名 id 使用“openid”范围生成的授权代码的令牌响应中的令牌
- 使用“token”或“token id_token” response_types 和“openid”范围时支持隐式流。
- 支持包含“openid”范围的授权请求的“prompt”、“nonce”和“max_age”参数。
- 支持 Openid Connect 发现和 userinfo 端点
- 支持使用成员 API 的集成商的 'amr' 字段来处理包含“openid”范围的授权请求。 这可用于发现用户是否使用两因素身份验证进行身份验证。
启动 OpenID Connect 身份验证的工作方式与常规 OAuth 身份验证相同。 所需要的只是客户端请求“openid”范围如果您使用/authenticate 范围,请将其替换为openid,因为authenticate 和openid 具有相同的授权,只能使用一个或另一个。 如果您使用任何其他范围,请将 openid 添加到请求的范围列表中。 当包含 openid 范围时,注册表将在令牌响应中返回一个 id_token 并授予客户端访问该用户的用户信息端点的权限。
请注意,“openid”范围不像其他范围那样以“/”开头 ORCID API 范围。 这是因为“openid”范围不是由 ORCID,而是由 OpenID Connect 规范定义。
看看我们的 技术文档 获取更多信息.
符合 我们致力于研究人员控制他们的 ORCID 记录,记录持有者可以选择随时撤销任何访问令牌,方法是从权限中删除它 可信组织n 在他们的可信方页面下列出。
截至 2018 年,研究人员只能授予持续 20 年的长期访问令牌,除非用户撤销许可。
ORCID 提供了一个简单的 Java 脚本小部件 可用于获取经过身份验证的 ORCID 使用 OAuth 和 OpenID Connect 的 ID。
请注意,该小部件使用隐式 OAuth,因此不会收集任何写入权限。 这意味着它不适合希望更新记录的成员集成。 请参阅我们的教程 添加和更新数据 ORCID 纪录。
ORCID API
公共客户凭据授予个人而非组织。 凭证不能从一个人转移到另一个人,但如果收到各方的同意并且该组织是 API 的活跃成员,则它们可以转换为成员 API 凭证 ORCID.
移动客户端 ID 到会员 API 不会更改客户端 ID,只会更改客户端密码,并且您将使用只读权限保留已连接 iD 的数量。
将公共 API 客户端转换为成员 API 客户端时 公共客户服务条款 不再适用,并由会员协议的条款取代。
对于转移,我们需要:
- 公共 API 客户端的确认 ID 被转换。
- 该组织的主要联系人和当前公共 API 客户端的记录持有者 ID 同意服务条款的变更。 (记录持有人需要是成员组织的雇员、承包商或官员)我们将保留双方同意的记录。
- 迁移发生的日期/时间。 作为此迁移的一部分,我们将更新客户端 ID 并通过加密电子邮件向您发送新的客户端密码。 请注意,一旦我们更新了客户端,您的集成将无法工作,直到您更新客户端密码。 这就是为什么我们需要确定完成此操作的日期和时间,以防止给用户带来不便。
要完成转换,您需要更新:
- 旧客户端密码到新客户端密码。
- API主机来自 酒吧。orcid。ORG 至 蜜蜂。orcid。ORG.
使用转换后的成员 API 客户端 ID,您可以更新范围以添加 成员 API 范围. 这将需要用户授权,并且将生成新的访问令牌以包含新的范围/权限。
请注意,我们无法将成员 API 客户端凭据转换为公共 API 凭据。
此示例调用检索完整的摘要 ORCID 使用沙盒服务器上的成员 API 以 XML 格式记录。 您需要访问令牌才能向公共或成员 API 发出 API 请求。
Method: GET
Accept: application/vnd.orcid+xml
Authorization type and Access token: Bearer [Stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/record
API 将返回 200 OK 消息,表示请求已成功接收,以及完整的摘要信息 ORCID 记录,包括单个项目的摘要
<?xml version="1.0" encoding-"UTF-8" standalone="yes"?>
<record:record path="/0000-0001-2345-6789"
xmlns:internal="https://www.orcid.org/ns/internal" [...]>
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">
[...]
</record:record>
每个项目(工作、资金、就业等)都有一个 放代码. 如果需要,这可用于获取项目的完整详细信息。
ORCID 记录被分成单独的部分,使阅读记录更快、更一致。 您可以先调用一个部分以接收其摘要,然后使用单个项目的放置代码进行调用以接收有关该项目的可靠信息。
您可以使用 API 阅读的摘要部分的表格如下所示。
端点 | 产品描述 |
/记录 | 完整的摘要视图 ORCID 记录 |
/人 | 传记部分 ORCID 记录,包括通过下面的 /researcher-urls |
/地址 | 研究者所在国家或地区 |
/电子邮件 | 与记录关联的电子邮件地址 |
/外部标识符 | 其他系统中链接的外部标识符 |
/关键词 | 与研究人员及其工作相关的关键词 |
/其他名称 | 研究人员知道的其他名字 |
/个人资料 | 个人详细信息:研究人员姓名、信用(出版)姓名和传记 |
/研究人员网址 | 链接到研究人员的个人或个人资料页面 |
/活动 | 活动部分摘要 ORCID 记录,包括通过下面的 /works。 |
/教育 | 教育机构 |
/就业 | 就业关系 |
/资金 | 资助活动摘要 |
/同行评审 | 同行评审活动总结 |
/作品 | 研究工作总结 |
/研究资源 | 研究资源总结 |
/服务 | 服务摘要 |
/资格 | 资质概要 |
/会员 | 会员概要 |
/区别 | 区别总结 |
/邀请职位 | 受邀职位摘要 |
此示例调用检索完整的摘要 ORCID 使用沙盒服务器上的成员 API 以 XML 格式记录。 您需要访问令牌才能向公共或成员 API 发出 API 请求。
Method: GET Accept: application/vnd.orcid+xml
Authorization type and Access token:
Bearer [Stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/record
API 将返回 200 OK 消息,表示请求已成功接收,以及完整的摘要信息 ORCID 记录,包括个别项目的摘要。
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">
[...]
</record:record>
每个项目(工作、资金、就业等)都有一个 放代码. 如果需要,这可用于获取项目的完整详细信息。
在您可以将项目添加到 ORCID 记录您需要将数据格式化为 ORCID 架构。 格式化您的数据 ORCID XML 或 JSON 中的消息模式。
我们的 GitHub 存储库包含在创建新项目时有助于格式化的资源 ORCID 记录,并在阅读现有项目时 ORCID 记录:
请注意,不同版本的 API 具有不同的消息格式。 版本 2.0 和 2.1 模式和示例也可用.
通过阅读填充良好的记录的元数据,可以轻松找到更多示例。
较早的版本 ORCID API 有额外的范围。 这些范围在 2.0 API 中被淘汰。 我们鼓励所有集成仅使用推荐的范围。 作为参考,下面列出了较早的作用域以及应该使用的当前作用域
- /orcid-配置文件/读取限制 改用 /读限制
- /orcid-作品/阅读限制 改用 /读限制
- /orcid-生物/读取限制d 改用 /读限制
- /orcid-作品/创建 改用 /活动/更新
- /orcid-作品/更新 改用 /活动/更新
- /从属关系/创建 改用 /活动/更新
- /从属关系/更新 改用 /活动/更新
- /资助/创建 改用 /活动/更新
- /funding/update 改为使用 /activities/update
- /orcid-生物/更新 改用 /人/更新
- /orcid-生物/外部标识符/创建 改用 /人/更新
刷新令牌用于生成额外的访问令牌。 在交换授权代码作为访问令牌的一部分时,刷新令牌与访问令牌一起返回 三足OAuth流程,只要访问令牌保持活动状态就可以使用它。
新访问令牌可以与原始访问令牌具有相同的到期时间和范围,或者可以指定为具有更短的生命周期以及来自原始访问令牌的较小范围子集。 可以生成新的访问令牌以替换原始令牌或生成新的访问令牌以用作附加令牌。 您还可以使用刷新令牌调用使原始访问和刷新令牌以及用户授予的任何权限完全过期。
我们建议在以下情况下使用刷新令牌:
- 替换可能已被泄露的访问令牌(一定要在之后撤销原始访问令牌)
- 给予第三方也是您的一部分 ORCID 整合更有限的访问和/或在有限的时间内访问。
请参考我们的 技术文档 关于如何从刷新令牌创建新的访问令牌。
有两种不同的更新范围 - 一种用于传记详细信息,另一种用于活动。
范围 | 产品描述 | API端点 |
/人/更新 | 个人资料-左栏 ORCID 记录用户界面。 | /地址 /外部标识符 /关键词 /其他名称 /研究人员网址 |
/活动/更新 | 研究活动数据-右栏 ORCID 记录用户界面。 | /区别 /区别 /教育 /教育 /就业 /就业 /资金 /资金 /邀请位置 /邀请职位 /会员 /会员 /同行评审 /同行评审 /资格 /资格 /研究资源 /研究资源 /服务 /服务 /工作 /作品 |
使用您的客户端 ID、机密以及活动令牌或其关联的刷新令牌来撤销令牌对。 您可以撤销在两条腿和一条腿上创建的令牌对 三足OAuth流程. 如果您有多组令牌,例如针对不同的范围,则只会撤销指定的访问令牌和相应的刷新令牌。
我们建议在以下情况下撤销令牌:
- 在关系终止后撤销发给第三方供应商的代币;
- 在用户断开连接时撤销令牌 ORCID iD 来自您的系统;
- 允许用户从您的系统内撤销令牌。
我们建议使用 刷新令牌 限制现有访问令牌的范围或持续时间,或者在令牌已被泄露时更新令牌。
撤销 API 调用
https://sandbox.orcid.org/oauth/revoke (or https://orcid.org/oauth/revoke)
METHOD: POST
HEADER: accept:application/json
CONTENT-TYPE: application/x-www-form-urlencoded
DATA:
client_id=[Your client ID]
client_secret=[Your client secret]
token=[access token or refresh token for token pair to be revoked]
上的所有项目(除了传记文本) ORCID 记录有一个 放代码:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0"> [...]
</record:record>
此放置代码可用于调用 API 以检索项目的完整数据。 可以使用以下项目查询 放代码:
端点 | 产品描述 |
/地址/[放置代码] | 个别国家或地区 |
/传 | 传记字段:只有研究人员可以编辑的自由文本区域 |
/教育/[输入代码] | 个人教育隶属项目 |
/email/[输入代码] | 与记录关联的个人电子邮件地址 |
/就业/[放代码] | 个人雇佣关系项目 |
/外部标识符/[放置代码] | 另一个系统中的单独链接的外部标识符 |
/funding/[放置代码] | 个人资助活动 |
/keywords/[输入代码] | 与研究人员及其工作相关的单个关键字 |
/other-names/[输入代码] | 研究人员知道的个人附加名称 |
/peer-review/[放置代码] | 个人同行评审活动 |
/researcher-urls/[放置代码] | 指向研究人员个人或个人资料页面的个人外部链接 |
/work/[放置代码] | 个人研究工作 |
/works/[放代码1],[放代码2],[放代码3] | 批量个人研究作品(最多 100 个) |
使用部分端点和放置代码,您可以使用相同的访问令牌调用 API 以完整获取该特定项目。 此示例调用使用沙盒服务器上的成员 API 以 XML 格式检索全部资金项目 4413。
Method: GET Accept: application/vnd.orcid+xml Authorization type and Access token: Bearer [stored access token]URI: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/funding/4413
API 将返回 200 OK 消息以指示消息已成功接收并返回资助项目的完整 XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<funding:funding put-code="4413" path="/0000-0002-9227-8514/funding/4413" visibility="public" [...] >
[...]
</funding:funding>
您可以检查 物品来源 如果您想知道谁添加了它,请在阅读时。
ORCID 成员可以更新他们之前添加到 ORCID 记录。 一次只能更新一个项目,并且只能使用最初创建它的客户端凭据进行更新。
为方便更新,请确保您 存储放置代码和访问令牌 创建项目时。
格式化更新的项目 in ORCID 消息模式 包含更改的信息并包括存储的 放代码.
<?xml version="1.0" encoding="UTF-8"?> <employment:employment put-code="739288" [...]> [...] </employment:employment>
调用 API:
Method: PUT Content-type: application/vnd.orcid+xml or application/vnd.orcid+jsonnAuthorization type and Access token: Bearer [stored access token]Data: link to file or text of affiliation to update URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment/739288
API 将返回 200 OK 消息以指示该项目已正确更新。 如果返回不同的消息,请查看我们的故障排除页面。
可见性指示项目的隐私设置,基于用户设置的可见性首选项。 如果在通过 API 发布信息时包含可见性标记,它将被忽略。 相反,信息将根据用户在其帐户首选项中设置的默认可见性首选项发布。
任何人都可以通过 API 读取公共项目,并显示在研究人员的公共记录中,可信方项目仅通过 API 返回给具有读取限制访问权限的客户; 他们不在研究人员的公共记录中。 私有项目仅对研究人员和项目来源可见——通过 API 返回的唯一私有项目是那些通过您的集成添加到记录中的项目 有关可见性设置的更多信息 ORCID 注册表.
项目(作品、就业、资金、同行评审等)可以添加到 ORCID 记录使用 ORCID 会员 API。 为此,您必须首先 使用 OAuth 获得研究人员的许可 和 格式化项目元数据 使用 ORCID 消息架构。
一旦你格式化了数据并收集了 ORCID iD 和访问令牌,您使用 HTTP POST 发出 API 请求,指定 相关终点.
Method: POST
Content-type: application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]data: link to file or text of single employment item to add
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment
下面的调用添加了一个新的 雇用 与沙盒测试服务器上的记录的隶属关系:
<?xml version="1.0" encoding="UTF-8"?>
<employment:employment [...]>
[...]
</employment:employment>
API 将返回一条 201 消息以指示该项目已正确发布,以及该项目 放代码. 您的客户将被列为 物品来源.
查看我们的 故障排除 页面,如果返回不同的消息。 您将需要保存 存储放置代码和访问令牌 进行任何更新或删除项目。
ORCID 搜索 API 使用 SOLR 语法。 支持 SOLR 3.6 中可用的所有查询语法,包括带有 Solr 扩展的 Lucene (默认)、DisMax 和扩展的 Dismax。
您需要一个“/read-public”访问令牌才能使用它。 获得搜索令牌后,构建基本搜索 URL:
凭证类型: | 公共API | 会员API |
资源网址: | 沙盒:https://pub.sandbox。orcid。ORG 制作:https://pub.orcid。ORG | 沙盒:https://api.sandbox。orcid。ORG 制作:https://api.orcid。ORG |
API版本: | v3.0 | |
搜索端点 | /search/?=[查询] |
搜索“的示例调用orcid”与沙箱公共API上的token,结果以XML格式返回:
Method: GET Content-type: application/vnd.orcid+xmlnAuthorization type and Access token: Bearer [stored access token]URL: https://pub.sandbox.orcid.org/v3.0/search/?q=orcid
结果将指定找到的结果数(num-found)并默认显示前1000个结果:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<search:search num-found="385" xmlns:search="https://www.orcid.org/ns/search" xmlns:common="https://www.orcid.org/ns/common">
<search:result>
<common:orcid-identifier>
<common:uri>https://sandbox.orcid.org/0000-0001-2345-6789</common:uri>
<common:path>/0000-0001-2345-6789</common:path>
<common:host>sandbox.orcid.org</common:host>
</common:orcid-identifier>
</search:result>
[...]
</search:search>
沙盒公共 API 上的示例基本搜索,结果以 json 格式返回:
Method: GET
Content-type: application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.sandbox.orcid.org/v3.0/search/?q=newman
搜索只返回个人 ORCID 保存与搜索匹配的公共数据的记录的 ID。 要获得有关结果的更多信息,请致电阅读 ORCID 直接记录。
有关更多信息,请参阅我们的 搜索 API 教程.
如果您添加了需要删除的数据,例如,如果它已关联错误 ORCID iD,然后您可以发出 HTTP DELETE 请求,指定 相关终点, 随着 ORCID ID, 存储访问令牌和存储放置代码. 一次只能删除一项,您只能删除客户添加的项目。 即使用户已撤销权限,您也可以删除项目。
此示例调用从记录中删除带有放置代码“739288”的就业项目”
Method: DELETE
Content-type: application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment/739288
ORCID 搜索 API 使用 SOLR 语法。 支持 SOLR 3.6 中可用的所有查询语法,包括带有 Solr 扩展的 Lucene (默认)、DisMax 和扩展的 Dismax。
当您需要搜索特定部分时,您可以使用字段搜索 ORCID 记录。 API 搜索中识别的当前字段列表及其对应的记录结构元素如下:
搜索领域 | 产品描述 |
传记资料 | |
姓 | 用户的给定(名字)姓名。 |
姓 | 用户的家族 (sur) 名称。 |
信用名 | 上的“公开名称” ORCID 用户界面,通常出现在用户发布的名称上 |
其他名称 | 用户可能在出版物中出现的替代名称。 |
邮箱地址 | 用户的电子邮件地址。 |
关键词 | 与用户关联的任何关键字。 |
外部 ID 参考 | 来自其他系统的标识符添加到用户的 ORCID 使用 API 记录。 |
隶属关系数据 | |
隶属关系组织名称 | 用户记录中教育或就业项目中任何组织的名称。 |
网格组织 ID | 网格标识 用户记录活动部分中的任何组织。 通常,这将与教育或就业项目相关联。 |
组织编号 | 识别号 用户记录活动部分中的任何组织。 通常,这将与教育或就业项目相关联。 |
Ringgold-组织 ID | 金币ID* 用户记录的活动部分中的任何组织。 一般来说,这与教育或就业项目相关。 |
资金数据 | |
资金头衔 | 用户记录中任何资金项目的标题。 |
Fundref-org-id | 交叉引用资助者注册 ID 用户记录的活动部分中的任何组织。 通常这将与资助项目相关联,但也可能与从属关系相关联。 |
授权号 | 用户记录中任何资助项目的授权编号(标识符)。 |
研究活动数据 | |
职称 | 用户记录中任何作品的标题。 |
数字对象 ID | doi 类型的工作外部标识符 |
做自己 | 类型为 doi 且外部标识符关系设置为 self 的工作外部标识符 |
[外部标识符类型]* | 具有给定类型的工作外部标识符 |
[外部标识符类型]*-self | 具有给定类型且外部标识符关系设置为 self 的工作外部标识符 |
[外部标识符类型]*-part-of | 具有给定类型且外部标识符关系设置为部分的工作外部标识符 |
[外部标识符类型]*-version-of | 具有给定类型且外部标识符关系设置为 version-of 的工作外部标识符 * 有关外部标识符的完整列表,请参阅 标识符列表。 某些标识符可能需要“-self”、“-part-of”或“-version-of”才能返回结果 |
ORCID 记录数据 | |
orcid | 16位数字 ORCID 用户标识符,格式为 0000-0001-2345-6789。 |
个人资料提交日期 | 创建记录的日期和时间。 |
个人资料上次修改日期 | 上次修改记录的日期和时间。 |
所有数据 | |
文本 | 以上所有字段。 这也是 Lucene 语法查询的默认字段。 |
看看我们的 搜索 API 教程 获取更多信息.
*尽管 Ringgold 标识符仍然存在于 ORCID 截至 1 年 2023 月 XNUMX 日, ORCID 我们不再接收注册机构使用的 RINGGOLD 组织标识符数据库的更新,也无法处理或使用该日期之后创建的 RINGGOLD ID。 看看我们的 常见问题 更多信息
在实际情况下,API 交互由您的系统使用 PHP、Java 或 Ruby on Rails 等编程语言完成。 对于练习和测试,您可以与 ORCID 使用一系列能够发出和接收 HTTP 请求的工具的 API。 大多数桌面 HTTP 工具都在命令行中运行; 对于喜欢图形界面的人来说,基于网络的工具是一个有用的选择。
XML/XSD 验证
有许多工具可以为您验证 XML; 采用一个是个好主意。 对于许多 API 调用,您将使用 XML 格式的信息。 尤其是在与 ORCID API 消息,重要的是您使用的 XML 对 XSD 有效。 (见我们的 GitHub 上的文档 等加工。为 ORCID 消息模式 XSD。)
ORCID 沙盒测试服务器
沙盒测试服务器 是副本 ORCID 注册软件,只包含测试数据。 它旨在提供一个尝试事物的地方,而不会影响任何真实的 ORCID iD,尤其是当您使用 ORCID API 并且需要一个地方来测试你的工作。 您可以在沙盒上创建用户帐户并测试 API 调用,而无需担心影响生产数据或不小心向研究人员发送垃圾邮件。
你甚至不需要成为 ORCID 成员在沙箱中试用成员 API。 欢迎所有人申请沙盒成员 API 凭据并试用成员 API 可用的全部功能。
站点和 API 不会像生产服务器那样可靠。 我们对沙箱上的数据不做任何保证; 它们没有备份,可能会被删除。 沙箱还可能包含一些尚未出现在生产服务器上的实验性功能,因此您可以在它们出现在注册表中之前进行尝试。 了解更多 关于沙盒测试服务器或 请求客户端凭据.
HTTP 工具
有许多工具可用于运行 HTTP 请求。 我们使用的一些:
- 卷曲
- 邮递员
- wget的
- 投掷
- 谷歌 OAuth 2.0 游乐场
- 昂首阔步: 成员 API(沙盒), 公共 API(沙盒)
高级会员可以针对任何 ORCID 记录在注册表中。 步骤是:
对网址进行编码
URL 编码您想要的 URL ORCID 更新用户记录时调用。 例如以下网址:
https://nowhere2.com/0000-0002-7465-2162/updated
成为
https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
建立网址
构建完整的 URL ORCID 以 URL 开头的 API 调用 ORCID 记录然后添加“√∫/webhook”√π 和你想要调用的 URL。 所以它应该看起来像 https://api.sandbox。orcid.org/{ORCID}/webhook/{URL-ENCODED-WEBHOOK-URL}
例如,使用上面的 webhook URL 和 ORCID iD 0000-0002-7465-2162,完整网址为:
https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
注册网络钩子
使用您的 webhooks、访问令牌针对用户的注册您的 webhook ORCID 记录。 您需要使用 HTTP PUT 请求,但不应在请求正文中包含任何内容。
URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdatedn HEADER: Accept: application/json HEADER: Authorization: Bearer [Your access token]n HEADER: Content-Length: 0n METHOD: PUT
响应应该是 201,但如果回调已经存在,那么响应将是 204。
HTTP/1.1 201nServer: nginx/1.1.19nConnection: keep-alive Location: https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Frequestb.in%2Fz57lzcz5
取消注册 webhook 的 URL 与注册的 URL 相同。 但是,您需要使用 HTTP DELETE 方法。
URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
HEADER: Authorization: Bearer [Your access token]
HEADER: Content-Length: 0
METHOD: DELETE
回应应该是 204 No Content
.
HTTP/1.1 204 No Content
Server: Apache-Coyote/1.1
Date: Fri, 05 Apr 2013 12:49:17 GMT
ORCID 当记录更新时,Registry 将执行以下 HTTP 调用。 该请求使用 HTTP POST 方法,但请求正文为空。
curl -v -X POST https://nowhere2.com/0000-0002-7253-3645/updated
您的服务器应使用标准 HTTP 响应代码进行响应。 因此,如果调用成功,您应该返回 204 No Content。
HTTP/1.1 204 No Content
任何 2xx 响应代码都表示调用成功。 如果您返回的代码不是 2xx,我们将在五分钟后重试呼叫。
在实际情况下,API 交互由您的系统使用 PHP、Java 或 Ruby on Rails 等编程语言完成。 但是,对于练习和测试,您可以与 ORCID API 使用一系列能够发出和接收 HTTP 请求的工具。 大多数桌面 HTTP 工具(例如 卷曲) 在命令行中运行; 对于喜欢图形界面的人来说,基于网络的工具是一个有用的选择。
一种流行的工具是 Google 的 OAuth 2.0 Playground,一款由 Google 开发和维护的基于网络的免费工具。
请查看我们的 API 实践教程:https://info。orcid.org/动手实践-orcid-API/
请注意: ORCID 不维护 OAuth 2.0 Playground——这个工具是由谷歌创建的,谷歌专门维护其代码。 虽然我们会定期更新此文档,但有时可能会出现一些不准确之处,因为我们可能无法立即了解 OAuth 2.0 Playground 的更改。
对于我们的 API 2.0 及以上版本,限制是:
- 请求一秒钟 - 24
- 爆发 – 40
请求一秒钟 - 一秒钟可以发出的请求数。
突发 – 我们允许在拒绝之前排队的请求数。 队列中的请求被减慢到每秒请求的速度。 如果超过突发,您将收到 503 响应。
如果您遇到限制问题,请务必联系您的参与团队负责人寻求支持。
研究员控制是核心 ORCID 原理 所以电子邮件地址注册并添加到 ORCID 默认情况下,记录设置为仅对记录持有者可见。 未经验证的电子邮件不会显示在记录的公共视图中,只有经过验证的电子邮件地址才会出现在 API 结果中。
一旦研究人员验证了他们的电子邮件地址,他们必须选择使其对所有人(即公开)或受信任方(即有限访问)可见,以便第三方组织读取该电子邮件地址。
如果研究人员将他们的电子邮件地址设置为受信任方,如果研究人员已授予您,它将与记录一起返回 读限制访问。 有关更多信息,请参阅 ORCID 可见性设置.
API 3.0 是默认 API 版本,我们建议您在构建新集成时使用此版本。 在可预见的未来,我们将继续支持 API 2.0 和 2.1,并在关闭这些版本之前至少提前 12 个月通知。
在从 API 1.2 过渡到 API 2 的过程中,我们学到了很多东西。这次我们让升级变得更容易管理。 API 3.0 添加了新功能,同时仅在绝对必要时修改现有功能。 这意味着集成商应该能够毫不费力地切换到新的 API。 这也意味着,虽然我们建议您尽快开始计划升级,以便您的组织和研究人员可以从新功能中受益,但您在决定何时更新到 3.0 方面有很大的灵活性。
我们的 API 发行说明中列出了潜在的重大更改 点击此处 和 点击此处. 可选/必填字段有一些变化,JSON 枚举略有修改,我们还对 XML 模式进行了小幅重构,添加了一些新字段以包含新功能所需的元数据。
请参阅 ORCID 面向发布者的支持供应商的系统页面 获取最新信息
任何高级会员都可以获得“/webhook”访问令牌。 单个令牌可用于为多个记录注册 webhook。 要获得令牌,您可以调用 ORCID API 令牌端点。
此过程通常称为客户端凭据 OAuth 流程,或 2 步 OAuth。
下面是获取访问令牌的示例调用 - 用您的凭据替换占位符(确保删除括号。)
curl -i -L -H "Accept: application/json"
-d "client_id=(your client ID)"
-d "client_secret=(your client secret)"
-d "scope=/webhook"
-d "grant_type=client_credentials"
"https://sandbox.orcid.org/oauth/token"
然后,您将收到类似于以下内容的访问令牌。
{"access_token":"5eb23750-1e19-47a3-b6f6-26635c34e8ee",
"token_type":"bearer",
"refresh_token":"c7d3d5fd-e4c0-4825-89f2-7cfb4a1cf01e",
"expires_in":631138518,
"scope":"/webhook"}
随着我们继续开发我们的产品,有许多功能仅适用于 API 3.0,这是我们最新的默认 API 版本。
下表提供了每个功能的简短说明。 如果您对任何功能或升级到 3.0 有任何疑问,请联系您的参与主管或联盟主管。
能够读取和写入所有隶属关系类型(以前版本的 API 不提供会员、服务、受邀职位、荣誉和资格) |
能够阅读和编写研究资源。 |
能够读写关系类型为“资助者”的工作标识符。 这用于将 Grant 或 Proposal ID 链接到工作元数据。 |
能够读写关系类型为“版本”的工作标识符。 这用于将其他版本的作品链接在一起。 一个示例用例是链接预印本和已发表的文章。 |
能够在作品元数据中读取和写入 CRediT 角色。 |
能够读取额外的源字段 常见:断言来源客户端ID 和 常见:断言来源名称 对于添加的从属关系 ORCID 通过搜索和链接向导添加成员门户和作品。 |
能够读写以下工作类型的作品: 注解 数据管理计划 学位论文 预印本 物理对象 检讨 |
能够读取和写入附属机构的外部 ID。 |
必须提供组织 ID 才能将附属机构和资金添加到 ORCID 纪录。 |
形式化标识符——我们引入了一个新的系统生成字段,它以规范化的格式表示外部标识符(DOI、PMCID、PMID、ArXiv、Bibcode、ISSN 和 ISBN),以便进行匹配和分组。 规范化是根据标识符类型的规则完成的,可能包括将所有字母字符设置为小写,或转换空格、破折号、句点和其他可以视为等效的字符。 它还根据需要添加标准前缀和后缀。 例如, https://doi.org/10.1/123, 10.1/123及 https://dx.doi.org/10.1/123 都将出现在此字段中 https://doi.org/10.1/123. 现有标识符值未修改。 |
可以找到更详细的信息 点击此处.
其他名称
他们收到通知 ORCID 收件箱. 每当数据发生变化时 ORCID 记录,用户会收到通知,其中包含有关更改的基本信息,包括执行更新的客户端名称、更改日期以及更改的项目 ORCID 已更新的记录。 查看我们的 用户知识库,了解有关通知的更多信息.
ORCID 沙箱上的记录也有 功能收件箱. 我们建议您定期查看测试的收件箱 ORCID 在规划系统如何安排数据更新时记录。
API 用户的更新和其他公告通过 ORCID API用户组. 您还可以通过以下方式订阅一般消息和更新 ORCID 新闻于活动.
ORCID 会员还可获得 ORCID 包含此信息的会员通讯。 最后,任何技术联系人 ORCID 具有活动的定制集成的成员还将收到有关任何重要更新的电子邮件消息 ORCID 注册表。 如果您想被列为贵组织的技术联系人,请 立即联系我们.
ORCID 致力于公开和透明。 这意味着我们的 产品路线图 任何人都可以查看,就像 目前正在开发的工作.
产品路线图是 ORCID 产品开发过程。 需求从团队管理的 trello 板,通过产品路线图 trello 板,再到 Current Development trello 板,在那里它们被实施并转移到我们的生产系统。
该委员会包含计划实施的明确定义的要求 在某一点,以及计划在近期实施的优先需求列表。
需求从何而来?
需求是从许多来源收集的 ORCID 职员。 它们可能源自成员请求、联盟反馈、用户测试、战略项目和错误报告等。 此外,所有 ORCID 团队生成自己的内部需求,例如网站更改、基础设施升级和操作系统更新。 每张卡片都标有产生需求的团队——通讯、战略、技术、参与或运营。
路线图上的事情怎么做?
ORCID 旨在实现平衡的产品开发周期,并定期召开跨团队会议来讨论近期和长期的优先事项。 我们尽最大努力平等地解决错误、新功能、技术债务、网站更新和战略项目。
我如何为路线图做出贡献?
我们欢迎有关如何改进的建议 ORCID 注册表。 请将任何反馈发送至 我们的团队.
此外, ORCID 是一个开源项目,我们欢迎对我们的源代码以及所有 我们的存储库.
预印本是由作者上传到公共服务器的完整科学手稿。 预印本包含完整的数据和方法; 通常是将同一份手稿提交给期刊。 经过简短的质量控制检查以确保作品具有科学性,作者的手稿会在一天左右的时间内未经同行评审就张贴在网上,全世界任何人都可以免费查看。 根据反馈和/或新数据,可以提交预印本的新版本; 然而,先前的预印本也被保留。 预印本服务器允许科学家直接控制他们的工作向全世界科学界的传播。 在大多数情况下,作为预印本发布的相同作品也会提交给期刊进行同行评审。 因此,预印本(快速,但未通过同行评审验证)和期刊出版(缓慢,但使用同行评审提供验证)作为科学研究的交流系统并行工作。
注意:此内容和视频最初出现在 ASAPBio 网站 感谢 ASAPBio 在 CC-BY 许可下提供它!
会员通讯每月从 ORCID 之前包含一个指向 Google Drive 文件夹的链接,您的所有成员报告都存储在该文件夹中。 现在已被替换为可供所有成员使用的新报告 会员门户.
以前的报道:
- 具有活跃集成的高级会员 收到一个指向文件夹的唯一链接,该文件夹包含单独的自定义报告,其中包含上个月每次集成的数据。
- 尚未进行有效集成的高级会员 收到一个指向文件夹的唯一链接,该文件夹包含带有其机构电子邮件统计数据的自定义报告,以及指向包含所有活动成员集成汇总数据的一般报告的文件夹的链接。
- 基本成员 收到一个文件夹链接,该文件夹包含每年发布两次的一般报告,其中包含上半年所有活跃成员集成的汇总数据; 上半年报告发布于 七月 (XNUMX-XNUMX月数据),今年下半年发布 一月 (次年 XNUMX 月至 XNUMX 月)。
如果你是一个 ORCID 会员,目前没有收到每月的会员通讯,请联系支持@orcid。ORG
具有活跃集成的高级会员
Google Drive 文件夹包含发给您的每个生产客户端 ID 的成员报告。 文件名包括客户端的显示名称 iD 及报告日期; 请按修改日期排序以查找最新报告。 还有一个 raw_data 文件夹,其中包含用于生成报告的数据,如果需要,可用于其他分析。
尚未进行有效集成的高级会员
Google Drive 文件夹包含一个仅包含电子邮件统计数据的成员报告,以及一个指向 Google Drive 文件夹的链接,该文件夹包含当前和前几年所有活跃成员集成的汇总数据的常规月度报告。 这些报告没有原始数据。
电子邮件域计数
本节提供了计数 ORCID iDs 当前在所有时间段内注册了您所在机构的电子邮件域。 为了生成这些计数,我们会搜索与我们为您的组织存档的网站 URL 相匹配的域(例如:如果您的网站 URL 是 www.universitycollege.edu,我们会搜索以@universitycollege 结尾的电子邮件)。 如果我们没有存档的网站 URL,您会在本节中看到“√∫未提供电子邮件域”√π。 如果我们没有得到您的电子邮件域非常正确,或者如果您想添加其他域,请 立即联系我们.
- 注册到您的电子邮件域的记录¬¨‚独特的计数 ORCID 包含贵机构电子邮件域中的地址的 iD
- 注册到您的电子邮件域并与您的客户 ID 相关联的记录¬¨‚独特的计数 ORCID 包含您机构电子邮件域中的地址并将您的机构作为可信方的 ID(即:您的机构具有有效访问令牌的记录)
创建和声明记录
(注意:大多数客户的报告中不会包含此部分)
如果您的机构客户用于通过 API 代表研究人员创建记录,您将收到一个名为 Registry Statistics 的部分。 这包括有关您创建的记录数和已声明记录数的信息(raw_data 文件包含有关用于生成这些数字的特定记录的更多信息)。
用户
报告的这一部分包含使用您的集成连接他们的研究人员的总数 ORCID iD 在报告的一个月内发送到您的系统。 此外,它还提供了注册新研究的研究人员总数 ORCID iD 作为一部分 iD 连接过程。
标记为 Total Integration Events 的图表按天显示上个月使用您的集成的研究人员数量
展会活动
该报告还包含 事件 信息,研究人员在连接他们的信息时完成的操作 ORCID 在报告月份用您的系统记录。 每个事件代表用户授予的任何访问权限或他们对 ORCID 站点(例如登录或授予读取限制访问权限)。 大多数研究人员将有不止一个事件与之相关。
如果一个事件后面有一个‚√∫√π,这意味着研究人员授予了一个长寿的(P持久性)令牌,与一小时后过期的短期令牌相比。 自 2018 年 XNUMX 月以来,仅支持长寿命代币 ORCID 登记处; 您的集成系统或用户可以随时选择撤销令牌。
国家用户
报告的最后一部分包含有关使用您的集成的研究人员的信息,这些信息按他们访问您的集成的国家/地区分类。 此数据来自研究人员的 IP 地址或他们的地理信息 ID (谷歌根据研究人员的 IP 地址自行确定)。
打样
因为很多研究人员使用 ORCID Registry,对整组研究人员数据运行报告是不可行的。 相反,此处提供的数字是使用采样和非采样集的趋势生成的。 源自抽样数据的报告部分用星号表示,抽样大小和空间在分析数据选项卡上指定。 报告的 Google Analytics(分析)部分中的数字可能与您保留的任何本地统计数据不完全匹配,并且报告各部分之间的计数可能存在细微差异。
集成分析下方列出的采样参数适用于所有标有星号的部分。 分析数据捕获的会话百分比为(样本大小)/(样本空间)* 100%。 有关采样的更多信息,请访问 谷歌开发人员.
空报告
报告的用户和事件部分仅包含上个月的数据。 如果过去一个月内没有研究人员使用您的集成,则不会返回任何数据。
问题
如果您对会员报告有任何疑问,请 立即联系我们.
ORCID Registry 旨在让用户使用 OAuth 向组织提供他们的 ID,以确保正确的 iD 为每位研究人员收集。 我们不鼓励组织添加 ORCID 基于按姓名搜索研究人员的系统 ID。 但是,了解您组织中有多少研究人员可能会有所帮助 ORCID iD,可以通过 API 完成。 下面给出了按组织搜索的建议。
有关搜索的介绍、如何获取访问令牌、如何理解您的搜索结果以及其他可搜索字段的详细信息,请参阅我们的 搜索注册表 API 教程
按名称和 DOI 搜索
当检查一个人是否有 ORCID 记录,我们建议通过他们的姓名和他们最近的一部或多部作品的 DOI 进行搜索。 这应该只生成您正在寻找的研究人员的记录,而不是其他同名的记录。
搜索名称为“Laurel Haak”和 DOI 10.1087/20120404 或 DOI 10.6084/M9.FIGSHARE.1115124 的所有记录的示例调用:
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search?q=family-name:Haak+AND+given-names:Laurel+AND+digital-object-ids:%2210.1087/20120404%22+OR+digital-object-ids:%2210.6084/M9.FIGSHARE.1115124’%22
按隶属关系搜索
可以使用从属关系名称或组织的唯一 ROR 来搜索从属关系字段 ID 或网格 ID。 (您可以找到您组织的 GRID ID in 电网 或者你的 ROR ID ,在 ROR注册)
按组织名称搜索
Method: GET Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=affiliation-org-name:"University+of+Johannesburg"
或者完全匹配
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=affiliation-org-name:(%22Boston%20University%22)
按网格 ID 搜索
使用 GRID 搜索所有记录的示例调用 ID grid.5509.9(坦佩雷大学):
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=grid-org-id:grid.5509.9
按 ROR ID 搜索
使用 ROR ID 搜索所有记录的示例调用 04fa4r544 (ORCID):
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=ror-org-id:"https://ror.org/04fa4r544"
按电子邮件域搜索
您可以使用 API 通过电子邮件域搜索研究人员。 请记住,大约 97% 的电子邮件地址在 ORCID 是私有的,并且在此搜索中将不会返回具有私有或受信任访问电子邮件地址的任何记录。
使用@ 搜索所有记录的示例调用orcid.org 电子邮件地址:
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=email:*@orcid.org
以 CSV 格式返回的搜索结果
搜索结果也可以 CSV 格式返回。 作为调用的一部分,您可以从以下可用字段列表中指定输出列:
orcid
邮箱地址
给定的名称
姓
姓氏
信用名
其他名字
当前机构-隶属关系-名称
过去机构名称
使用您的凭据,您需要将标头指定为 '文本/csv'. 作为搜索调用的一部分,您还需要将输出中所需的字段添加到查询中。
仅使用浏览器进行搜索
您也可以使用浏览器完成搜索。 URL 的构造方式相同,但您不需要使用任何 API 凭据。 请注意,这只能使用公共 API 完成。
下面是一个使用公共 API 搜索的示例调用,按组织名称搜索 ORCID,名字,姓氏,当前机构隶属关系名称和过去机构隶属关系名称作为所需的输出。
https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:ORCID&fl=orcid,given-names,family-name,current-institution-affiliation-name,past-institution-affiliation-name
下面是使用公共 API 搜索组织名称的不同变体的另一个示例调用。
https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:("University of Plymouth" OR "Plymouth University")
eduPerson 架构添加了 教育人Orcid 在其属性 2016年2月更新.
按照 eduPerson 规范:
RFC4512 definition
( 1.3.6.1.4.1.5923.1.1.1.16
NAME 'eduPersonOrcid'
DESC 'ORCID researcher identifiers belonging to the principal'
EQUALITY caseIgnoreMatch
SYNTAX '1.3.6.1.4.1.1466.115.121.1.15' )
请注意,此字段的格式为 ORCID-iD 的首选 URI 表示,即 https://orcid.org/0000-0001-5727-2427.
有关格式的更多信息 ORCID iD 可以发现 结构 ORCID 识别码.
如果您的组织是 ORCID 会员,那么您需要联系 ORCID 您所在组织的联系人将能够为您提供访问 ORCID 会员门户。 如果您无法识别您的组织 ORCID 请联系您的联盟负责人或您的参与团队代表。
我们喜欢来自社区的反馈,因此如果您对会员报告有任何反馈,请通过以下方式与我们联系 https://support.orcid.org/hc/en-us/requests/new
用于生成成员和集成报告的数据每天更新。