本教程介绍了如何搜索 ORCID 注册表使用 ORCID 公共和成员 API。 这两种方法都需要使用您的客户端凭据检索访问令牌。
ORCID API 支持搜索 ORCID 元数据使用流行的 Solr 查询语法。 请注意,只有 ORCID iDis 在搜索结果中返回。 有关从特定位置检索数据的信息 ORCID iD 可以发现 从一个读取数据 ORCID 记录.
API 搜索可能不适合您使用。 您可能希望考虑以下替代方案:
- 寻找研究人员 ORCID ID? 我们不建议手动输入任何 ORCID iD 进入您的系统或流程。 我们建议您收集经过认证的 ORCID 来自您的研究人员的 ID。
- ORCID 发布一个 年度公共数据文件 — 中所有公共数据的快照 ORCID 那个时间点的注册表——也可用于对注册表中的大型公共数据进行搜索。 优质的 ORCID 成员还可以使用 公共数据同步.
- 有关查找大量贵机构研究人员的具体说明,请参阅我们的 寻找技巧 ORCID 您所在机构的记录保持者
公共 API 搜索限制
请注意,公共 API 仅限于 10,000 个结果。 使用会员 API(使用会员 API 令牌)不会限制结果数量。
您可以通过将经过验证的信息连接到他们的 ORCID 记录。 您还将帮助建立对学术交流的信任,并且通过使数据保持最新,您可以减轻用户的报告负担并提高数据质量。
ORCID 研究机构
除了用作研究人员的持久标识符之外, ORCID 可以帮助您控制您的机构名称在研究系统中的使用方式。 结合其他持久标识符 ORCID 使您能够权威地声明您的教职员工和学生与您所在机构的关系。 你也可以使用 ORCID 用于接收有关研究活动的实时通知、自动更新表格以及关注校友职业的 API。
ORCID 资助机构
通过嵌入 ORCID 在您的资助工作流程中使用 iD,您可以可靠地连接您的受助人和资助计划 - 并节省每个人的时间并减少因手动键入信息而导致的错误。 使用 ORCID 在您的系统中,您可以通过断言个人与您授予他们的资助之间的联系,在构建可信的研究信息基础设施方面发挥自己的作用。
ORCID 对于出版商
研究人员是学术和研究出版商所做一切的核心。 准确的作者和审稿人信息对于索引、搜索和发现、出版物跟踪、资金和资源使用归属以及支持同行评审至关重要。
ORCID 充当信息中心,使您的作者和审稿人能够可靠地连接到他们的贡献,并共享来自他们的信息 ORCID 在他们与您的发布系统交互时进行记录。 在出版过程中为所有作者和审稿人收集 iD——无论是书籍、期刊、数据集、作文、演示文稿、代码还是各种其他作品——允许轻松共享信息,确保研究人员可以同意共享,节省了研究人员的时间和麻烦,降低了出错的风险,而且至关重要的是,使研究人员能够获得他们所做的重要工作应得的荣誉。
当您要求研究人员使用他们的身份登录时,您会收集经过身份验证的 ID ORCID ID。 此过程使用称为“OAuth”或“SSO”的技术,应内置到您的工作流程中。
请参阅 API 教程 '获得认证 ORCID iD' 更多细节。
获取搜索令牌
任何拥有 API 凭证的人都可以搜索 ORCID 注册表。 成员 API 需要一个 /读公开 访问令牌以进行 API 调用。 要获取令牌,请调用 ORCID API 使用两条腿的 OAuth 授权(即直接调用 API)。 公共和成员 API 凭证的调用是相同的。
任何拥有公共或成员 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 范围,则可以使用存储的访问令牌读取公共数据,而无需再次获取访问令牌。
使用会员 API 的集成商可以使用 /读公开 阅读范围 ORCID 记录总结。
基于关键字的基本搜索
可以在沙盒测试注册表或实时生产注册表上执行搜索。 搜索 API 端点接受 HTTP 请求的 GET。 唯一需要的输入是传递给 Solr 搜索引擎的查询字符串。
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、名字、姓氏、信用姓名、其他姓名、电子邮件和机构(使用标准搜索语法时)。 结果可以以 XML 或 JSON 格式返回。
在沙箱公共 API 上搜索术语“jones”的示例
URL: https://pub.sandbox.orcid.org/v3.0/expanded-search/?q=spaceman
结果是这样的:
<expanded-search:expanded-result>
<expanded-search:orcid-id>0000-0002-2436-0000</expanded-search:orcid-id>
<expanded-search:given-names>Dave Theodore</expanded-search:given-names>
<expanded-search:family-names>Spaceman</expanded-search:family-names>
<expanded-search:other-name>D Spaceman</expanded-search:other-name>
<expanded-search:other-name>D T Spaceman</expanded-search:other-name>
<expanded-search:institution-name>The University of The Moon</expanded-search:institution-name>
<expanded-search:institution-name>Saturn Institute</expanded-search:institution-name>
</expanded-search:expanded-result>
以 CSV 格式返回的搜索结果
搜索结果也可以 CSV 格式返回。 作为调用的一部分,您可以从以下可用字段列表中指定输出列:
- orcid
- 邮箱地址
- 给定的名称
- 姓
- 姓氏
- 信用名
- 其他名字
- 当前机构-隶属关系-名称
- 过去机构名称
使用您的凭据,您需要将标头指定为 '文本/csv'. 作为搜索调用的一部分,您还需要将输出中所需的字段添加到查询中。
调用会员搜索 Ringgold ID* 的示例,其所需的输出包括 ORCID,姓名和隶属关系。
Method: GET
Content-type: text/csv
Authorization type: Bearer
Access token: [Stored access token]
URL: https://api.orcid.org/v3.0/csv-search/?q=ringgold-org-id:385488&fl=orcid,given-names,family-name,current-institution-affiliation-name,'
您也可以使用浏览器完成搜索。 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”)
格式化搜索查询
默认行为是对所有可用索引字段进行自由格式、不受限制的搜索。 因此,对“newman”的基本搜索将找到发布名称为 Newman、给定名称 Newman 或与标题中带有“newman”的作品相关联的研究人员等。可以根据指定的内容以 json 或 xml 形式返回搜索在内容类型中。
API 还支持使用多个关键字、精确短语和其他布尔搜索功能的布尔搜索。 必须使用方括号和大写的“AND”或“OR”组合关键字——小写的“and”和“or”被视为搜索的一部分。
在沙箱公共 API 上搜索匹配三个关键字(johnson、cardiology 和 houston)的记录的示例布尔搜索:
URL: https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+AND+cardiology+AND+houston
在沙箱公共 API 上搜索匹配关键字“johnson”和关键字“caltech”或短语“California Institute of Technology”的记录的布尔搜索示例,结果以 XML 格式返回:
URL: https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+AND+(caltech+OR+"California+Institute+of+Technology")
按字段搜索特定元素
当您需要搜索特定部分时,您可以使用字段搜索 ORCID 记录。
字段搜索的基本语法是field:value,所以查询字符串family-name:james 会找到姓为“James”的记录,例如“Roland James”,但不会找到名字为“James”的记录,例如作为“詹姆斯约翰逊”。
可以提供多个字段:值对。 匹配基于子字符串标记而不是原始字符串,因此查询字符串 other-names:carberry 将匹配 J. Carberry 和 JS Carberry。
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 在公共 API 和成员 API 上返回 1000 个结果(或行)。 要一次显示一定数量的结果,或检索过去的前 1000 个结果,请为起点和结果数量添加参数。 一次可以返回的最大结果数也是 1000。
在沙箱公共 API 上搜索与关键字“匹配”的后 1000 个结果的示例orcid“
URL: https://pub.sandbox.orcid.org/v3.0/search/?q=orcid&start=1000&rows=1000
在沙盒公共 API 上搜索第 2 项到第 4 项的示例,搜索条件为“johnson”、“cardiology”和“houston”:
URL: https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+cardiology+houston&start=2&rows=3
使用公共 API 的示例查询
公共 API 搜索限制
请注意,公共 API 仅限于 10,000 个结果。 使用会员 API(使用会员 API 令牌)不会限制结果数量。
例子1
搜索所有姓氏 ORCID “桑切斯”这个名字的记录
语法: | Lucene |
分页: | 仅第 5-10 行 |
网址: | https://pub.sandbox.orcid.org/v3.0/search/?q=family-name:Sanchez&start=4&rows=6 |
例子2
搜索所有的所有可搜索字段 ORCID “英语”一词的记录
语法: | Lucene |
分页: | 仅前 10 行 |
网址: | https://pub.sandbox.orcid.org/v3.0/search/?q=text:English&start=0&rows=10 |
例子3
搜索与 PubMed 工作相关的贡献者 ID 2485-7732
语法: | Lucene |
分页: | 所有记录 |
网址: | https://pub.sandbox.orcid.org/v3.0/search/?q=pmid:24857732 |
例子4
搜索姓氏“Einstein”和关键字“Relativity”的记录。 只返回同时包含姓氏和关键字的记录。
语法: | Lucene |
分页: | 仅前 10 行 |
网址: | https://pub.sandbox.orcid.org/v3.0/search/?q=family-name:Einstein+AND+keyword:Relativity&start=0&rows=10 |
例子5
搜索姓氏 Taylor 和名字 Michael 的记录。
语法: | Lucene |
分页: | 全部结果 |
网址: | https://pub.sandbox.orcid.org/v3.0/search/?q=family-name:Taylor+AND+given-names:Michael |
例子6
搜索所有人的名字和姓氏 ORCID “雷蒙德”的记录,但提升了姓氏。 名字包含“Raymond”的记录和姓包含“Raymond”的记录将被返回,但那些具有姓氏的记录将出现在列表的顶部,并具有更高的相关性分数。
语法: | 扩展 DisMax |
分页: | 仅前 10 行 |
网址: | https://pub.sandbox.orcid.org/v3.0/search/?defType=edismax&q=Raymond&qf=given-names^1.0%20family-name^3.0&start=0&rows=10 |
例子7
搜索所有人的名字和姓氏 ORCID “雷蒙德”的记录,但提升了姓氏。 名字中包含“Raymond”的记录和姓包含“Raymond”的记录将被返回,但那些有姓氏的记录会出现在列表的顶部,并且具有更高的相关性得分。 ORCID ID https://sandbox.orcid.org/0000-0002-0879-455X 和 https://sandbox。orcid.org/0000-0001-6238-4490 将被排除在结果之外。
语法: | 扩展 DisMax |
分页: | 仅前 10 行 |
网址: | https://pub.sandbox.orcid.org/v3.0/search/?defType=edismax&q=Raymond+-orcid:(0000-0002-0879-455X+0000-0001-6238-4490)&qf=given-names^1.0+family-name^3.0&start=0&rows=10 |
例子8
搜索将 DOI 10.1087/20120404 设置为 self 的记录
分页: | 默认 |
网址: | https://pub.sandbox.orcid.org/v3.0/search/?q=doi-self:%2210.1087/20120404%22 |
例子9
搜索包含 10.1087 设置为 self 或 part-of 的 DOI 的记录
分页: | 默认 |
网址: | https://pub.sandbox.orcid.org/v3.0/search/?q=digital-object-ids:10.1087 |
例子10
搜索将 PubMed 标识符 27281629 设置为 self 的记录
分页: | 默认 |
网址: | https://pub.sandbox.orcid.org/v3.0/search/?q=pmid-self:27281629 |
例子11
搜索带有 ISBN 标识符的记录,包括设置为 self 或 part-of 的 1234
分页: | 默认 |
网址: | https://pub.sandbox.orcid.org/v3.0/search/?q=isbn:1234 |
例子12
搜索带有@ 的电子邮件地址的所有记录orcid.org 域名
分页: | 默认 注意:大多数 ORCID 记录将电子邮件地址标记为私人,私人信息将不会在搜索结果中返回。 |
网址: | https://pub.sandbox.orcid.org/v3.0/search/?q=email:*@orcid.org |
例子13
搜索在 1 年 2017 月 XNUMX 日和今天之间修改的记录
分页: | 前 10 个结果 |
网址: | https://pub.sandbox.orcid.org/v3.0/search/?q=profile-last-modified-date:%5B2017-01-01T00:00:00Z%20TO%20NOW%5D&start=1&rows=10 |
例子14
搜索与具有确切名称“Boston University”或“BU”的组织有关的记录
分页: | 默认 |
网址: | https://pub.sandbox.orcid.org/v3.0/search/?q=affiliation-org-name:(%22Boston%20University%22+OR+BU) |
例子15
搜索与 Ringgold ID* 1438(加州大学伯克利分校)相关的 CSV 格式的记录
分页: | 默认 |
网址: | https://pub.sandbox.orcid.org/v3.0/csv-search/?q=ringgold-org-id:1438 |
例子16
搜索与 GRID 相关的记录 ID grid.5509.9(坦佩雷大学)使用扩展搜索
分页: | 默认 |
网址: | https://pub.sandbox.orcid.org/v3.0/expanded-search/?q=grid-org-id:grid.5509.9 |
* 尽管 Ringgold 标识符仍然存在于 ORCID 截至 1 年 2023 月 XNUMX 日, ORCID 我们不再接收注册机构使用的 RINGGOLD 组织标识符数据库的更新,也无法处理或使用该日期之后创建的 RINGGOLD ID。 看看我们的 常见问题 更多信息