API 教程：搜索 ORCID 注册处

本教程介绍了如何搜索 ORCID 注册表使用 ORCID 公共和成员 API。 这两种方法都需要使用您的客户端凭据检索访问令牌。

此 ORCID API 支持搜索 ORCID 元数据使用流行的 Solr 查询语法。 请注意，只有 ORCID iDis 在搜索结果中返回。 有关从特定位置检索数据的信息 ORCID iD 可以发现 从一个读取数据 ORCID 记录.

API 搜索可能不适合您使用。 您可能希望考虑以下替代方案：

• 寻找研究人员 ORCID ID？ 我们不建议手动输入任何 ORCID iD 进入您的系统或流程。 我们建议您收集经过认证的 ORCID 来自您的研究人员的 ID。
• ORCID 发布一个 年度公共数据文件 — 中所有公共数据的快照 ORCID 那个时间点的注册表——也可用于对注册表中的大型公共数据进行搜索。 优质的 ORCID 成员还可以使用 公共数据同步.
• 有关查找大量贵机构研究人员的具体说明，请参阅我们的 寻找技巧 ORCID 您所在机构的记录保持者

a

如何收集经过身份验证的 ID？

整合 ORCID 进入您的系统允许您的组织收集经过身份验证的 ORCID iD 并将它们添加到您自己的数据中。同时，研究人员向组织提供读写其数据的权限。 ORCID 记录。 

为了使这项工作发挥作用，组织 必须 获得 认证 ORCID 身份证 使用 ORCID OAuth API。这意味着它们包括一个 ORCID 系统内的品牌按钮或链接，点击后会要求用户登录 ORCID 记录。

登录后，系统将要求用户授权访问系统，并询问他们的信息 ORCID iD

用户的 ORCID iD 并在上面写上名字 ORCID 记录（取决于可见性设置）将作为此过程的一部分返回给组织。然后系统可以向系统请求附加数据 ORCID API。

上述用于收集经过身份验证的 API 的工作流程在以下两个版本中均可用 ORCID的公共和成员 API。前者可供非商业服务免费使用。

永久链接

获取搜索令牌

任何拥有 API 凭证的人都可以搜索 ORCID 注册表。 成员 API 需要一个 /读公开 访问令牌以进行 API 调用。 要获取令牌，请调用 ORCID API 使用两条腿的 OAuth 授权（即直接调用 API）。 公共和成员 API 凭证的调用是相同的。

URL=https://sandbox.orcid.org/oauth/token
  HEADER: Accept: application/json
  METHOD: POST
  DATA: 
    client_id=[Your public or member API client ID]
    client_secret=[Your public or member API secret]
    grant_type=client_credentials
    scope=/read-public

	"access_token":"43914fb8-7f34-417d-9d4e-eaa820c92c0d",
	"token_type":"bearer",
	"expires_in":631138518,
	"scope":"/read-public",
	"orcid":null

基于关键字的基本搜索

可以在沙盒测试注册表或实时生产注册表上执行搜索。 搜索 API 端点接受 HTTP 请求的 GET。 唯一需要的输入是传递给 Solr 搜索引擎的查询字符串。 

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

 <?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> 

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、given-names、family-names、credit-names、other-names、email 和 Institution。结果可以以 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 格式返回。 作为调用的一部分，您可以从以下可用字段列表中指定输出列：

•  奥西德
•  电子邮件
•  给定的名称
•  姓
•  姓氏
•  信用名
•  其他名字
•  当前机构-隶属关系-名称
•  过去机构名称 

使用您的凭据，您需要将标头指定为 '文本/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。

搜索结果分页

默认情况下，API 在公共 API 和成员 API 上返回 1000 个结果（或行）。 要一次显示一定数量的结果，或检索过去的前 1000 个结果，请为起点和结果数量添加参数。 一次可以返回的最大结果数也是 1000。

在沙盒公共 API 上搜索与关键字“orcid”匹配的后 1000 个结果的示例：

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 的示例查询

例子1

搜索所有姓氏 ORCID “桑切斯”这个名字的记录

例子2

搜索所有的所有可搜索字段 ORCID “英语”一词的记录

例子3

在 PubMed ID 2485-7732 中搜索与该作品相关的贡献者

例子4

搜索姓氏“Einstein”和关键字“Relativity”的记录。 只返回同时包含姓氏和关键字的记录。

例子5

搜索姓氏 Taylor 和名字 Michael 的记录。

例子6

搜索所有人的名字和姓氏 ORCID “雷蒙德”的记录，但提升了姓氏。 名字包含“Raymond”的记录和姓包含“Raymond”的记录将被返回，但那些具有姓氏的记录将出现在列表的顶部，并具有更高的相关性分数。

例子7

搜索所有人的名字和姓氏 ORCID “雷蒙德”的记录，但提升了姓氏。 名字中包含“Raymond”的记录和姓包含“Raymond”的记录将被返回，但那些有姓氏的记录会出现在列表的顶部，并且具有更高的相关性得分。 ORCID ID https://sandbox.orcid.org/0000-0002-0879-455X 和 https://sandbox.orcid.org/0000-0001-6238-4490 将被排除在结果之外。

例子8

搜索将 DOI 10.1087/20120404 设置为 self 的记录

例子9

搜索包含 10.1087 设置为 self 或 part-of 的 DOI 的记录

例子10

搜索将 PubMed 标识符 27281629 设置为 self 的记录

例子11

搜索带有 ISBN 标识符的记录，包括设置为 self 或 part-of 的 1234

例子12

搜索带有 @orcid.org 域名的电子邮件地址的所有记录

例子13

搜索在 1 年 2017 月 XNUMX 日和今天之间修改的记录

例子14

搜索与具有确切名称“Boston University”或“BU”的组织有关的记录

例子15

搜索与 Ringgold ID* 1438（加州大学伯克利分校）相关的 CSV 格式的记录

例子16

使用扩展搜索搜索与 GRID ID grid.5509.9（坦佩雷大学）相关的记录

* 尽管 Ringgold 标识符仍然存在于 ORCID 截至 1 年 2023 月 XNUMX 日， ORCID 我们不再接收注册机构使用的 RINGGOLD 组织标识符数据库的更新，也无法处理或使用该日期之后创建的 RINGGOLD ID。 看看我们的 常见问题 更多信息