Crossref REST API已更新为使用Elasticsearch而不是Solr——阅读有关该项目的更多信息在这里.

本文档是已弃用。新API的文档仍可以在https://api.crossref.org/，并且应将问题提交给交叉引用问题存储库在Gitlab。

• Crossref REST API
  • 序言
  • 元
  • API概述
  • 结果类型
  • 资源组件
  • 参数
  • 查询
  • 字段查询
  • 排序
  • 方面计数
  • 过滤器名称
  • 结果控制
  • API版本控制
  • 文档历史记录

Crossref REST API是各种工具和API允许任何人以复杂的方式搜索和重用我们成员的元数据。

如果你什么都没读，请至少看一下API提示文档和“礼仪”部分本文档的。这将为您（和我们）节省很多心痛。

记录通常在成功存放到Crossref后20分钟内出现在REST API中。

摘要信息（例如计数等）每24小时成批处理一次。

我们记录并报告服务问题状态页.

在您报告问题之前，您可能想检查一下，看看我们是否已经意识到了问题。

我们还将我们的服务出现任何持续性能问题的通知发布在我们的twitter提要上，网址为交叉引用组织和交叉引用支持.

报告我们的性能/可用性支持站点.

请报告API或我们的文档中的错误问题跟踪器.

本作品根据Creative Commons Attribution 4.0国际许可.

Crossref不主张对通过使用Crossref-Free服务获得的书目元数据和相关数字对象标识符（DOI）的个别项目拥有所有权。书目元数据和相关DOI的单个项目可以缓存并合并到用户的内容和系统中。

我们还有一个隐私政策.

如果您使用为CrossrefRESTAPI编写的几个优秀库中的一个，那么您可能可以避免阅读所有这些文档。例如：

• 交叉参考通用（Python，由Crossref开发）
• 哈巴内罗（Python）
• 塞拉诺（红宝石）
• rcrossref（交叉引用）（R）
• 交叉参考API（Python）
• 交叉参考-rs（生锈）
• 火龙果（朱莉娅）

如果您知道这里列出的另一个库，请通过问题跟踪器.

我们希望为所有人提供一个公开、开放和免费的API。而且，我们不想为了使用公共REST API而让开发人员（或我们自己）承担不必要的繁琐API令牌或注册过程负担。为了做到这一点，我们要求您保持礼貌，不要做任何会破坏公共REST API或使其对其他人不可用的事情。具体而言，我们鼓励以下礼貌行为：

• 缓存数据，这样就不会反复请求相同的数据。
• 积极监控API响应时间。如果价格开始上涨，就退后一段时间。例如，在请求之间添加暂停和/或减少并行请求的数量。
• 指定一个用户代理标头可以正确识别您的脚本或工具，并使用“mailto:”通过电子邮件与您联系。例如：GroovyBib/1.1版(https://example.org/GroovyBib/; 邮寄地址：GroovyBib@example.org)基于FunkyLib/1.4.

如果我们发现问题，可以通过这种方式与您联系。

• 报告问题和/或就我们的问题跟踪器.

唉，并不是所有人都有礼貌。因此，我们保留实施利率限制和/或阻止扰乱公共服务的客户的权利。

但我们更喜欢胡萝卜而不是大棒。截至2017年9月18日，任何API查询使用HTTPS并提供适当的联系信息将被定向到专门为礼貌用户保留的API机器池。

我们为什么要这样做？嗯，我们不想强迫用户向我们注册。但这意味着，如果公共服务器的某些用户编写了错误脚本或忽略了超时和错误，他们真的可以让API服务屈服。此外，我们很难识别这些问题用户，因为他们往往使用多台并行机器，并使用通用的User-Agent头。他们实际上是匿名的。我们开始不得不花费大量时间来处理这些问题，而公共API性能的下降也影响到了所有礼貌的用户。

所以……我们保持公共服务不变。它的表现可能会继续大幅波动。但是现在，如果客户端使用HTTPS连接到API，并在其User-Agent头中或作为查询的参数提供联系信息，那么我们将把它们发送到单独的计算机池。我们希望能够更好地控制这些机器的性能，因为如果脚本开始导致问题，我们可以联系负责脚本的人员，要求他们修复它。或者，在极端情况下，我们可以阻止它。

它是如何工作的？很简单。你可以做两件事之一，直接进入“礼貌池”：

1. 在查询中包含“mailto”参数。例如：

https://api.crossref.org/works？filter=has-全文：true&mailto=GroovyBib@example.org

2. 在User-Agent标题中包含“mailto:”。例如：

GroovyBib/1.1版(https://example.org/GroovyBib/; 邮寄地址：GroovyBib@example.org)基于FunkyLib/1.4.

请注意，只有当您使用HTTPS查询API时，这才有效。无论如何，你真的应该这么做（摇手指）。

问：你会给我发营销垃圾邮件吗流浪汉一旦你有了我们的联系信息？

答：不。我们将仅使用它与您联系，以了解您的脚本问题。

问：这是一个秘密阴谋，旨在阻止公众访问您的API吗？

答：不。这是为了保持公共API的可靠性。

问：如果我提供虚假或错误的联系信息怎么办？

答：这不太礼貌。如果有问题而你不回应，我们会阻止你。

问：联系信息必须是真实姓名吗？

答：不可以。只要有人确实收到并注意到该地址的电子邮件，它就可以是假名，或者其他任何形式。

Crossref不时需要施加速率限制，以确保所有人都可以使用免费API。任何有效的费率限制都将在X-Rate-Limit-Limit极限和X比率限制间隔HTTP标头。

为了方便传递X比率限制间隔将始终以秒为单位。例如，下面告诉您，您应该能够每秒执行50个请求：

X-Rate-Limit-Limit极限：50X-速率限制-间隔：1s

请注意，如果我们想调整测量窗口，可以指定：

X-Rate-Limit-Limit极限：3000X-Rate-Limit-Interval:60秒

这始终是我们的最后手段，如果您在用户代理收割台或电子邮件上述参数。

但说真的。。。这真是令人失望。我们真的希望您使用API。如果你有礼貌的话，你应该不会有任何问题。

如果您想将我们的API用于生产服务，而生产服务不能依赖于自由开放公共API的性能不确定性，该怎么办？如果你不想被不遵守规则的不礼貌的人影响怎么办API礼仪指导方针？如果您有兴趣将这些工具或API用于生产服务，我们具有服务级别产品称为“Plus”。此服务为您提供了对所有受支持API和元数据的访问，但提供了额外的服务和支持保证。

当您注册Plus服务时，将向您颁发API令牌，您应该将其放入授权所有rest API请求的头。此令牌将确保所述请求被定向到为“Plus”SLA用户保留的计算机池。例如，使用卷曲:

卷发-X GET\https://api.crossref.org/works网站 \-H’交叉引用-Plus-API-Token：承载人yJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vY3Jvc3NyZWYub3JnLyIsImF1ZYZimVuaGFuY2VkY21zIiwianRpIjoiN0M5ODlFNTItMTFEQS00QkY3LUJCRUUtoDFCMUM3QzE0OTZEIn0.NYe3-O066sce9R1fjMzNEvP88VqaYdBYdB 622FDiG8Uq'\-H’用户代理：GroovyBib/1.1(https://example.org/GroovyBib/; 邮寄地址：GroovyBib@example.org)基于FunkyLib/1.4'

请注意，你仍然可以“礼貌”，并表明自己的身份。当然，用真正的令牌替换上面的假令牌。

该API通常是RESTFUL，并以JSON格式返回结果。记录API返回的JSON格式在这里.

API支持HTTP和HTTPS。这里的示例是使用HTTPS提供的。

使用API时，应该始终对DOI和参数值进行url编码。DOI因包含破坏URL的字符而臭名昭著（例如分号、散列、斜杠、与号、问号等）。

注意url编码也适用于游标，因为它们也可能包含会破坏url的字符（例如。+符号）

请注意，为了清楚起见，本文件中的示例不url编码DOI或参数值。

API仅适用于Crossref DOI。您可以通过以下途径测试注册机构的DOI：

https://api.crossref.org/works网站/{doi}/代理

测试以下交叉参考DOI：

10.1037/0003-066X.59.1.29

使用URL：

https://api.crossref.org/works/10.1037/0003-066X59.1.29/机构

将返回以下结果：

{状态：“正常”，消息类型：“工作机构”，消息版本：“1.0.0”，消息：{DOI：“10.1037/0003-066x.59.1.29”，代理：{id：“交叉引用”，标签：“Crossref”}}}

如果将下面列出的任何API调用与非Crossref DOI一起使用，您将获得404HTTP状态响应。典型的机构ID包括交叉参考,数据引用,梅德拉还有公众的用于测试DOI。

所有结果都以JSON格式返回。有三种常见的结果类型：

• 单体
• 仅标题
• 列表

API结果的mime类型为application/vnd.crossref-api-message+json

单项是单项结果。检索特定标识符的元数据（例如DOI、ISSN、funder_identifier）通常会返回单个结果。

您可以使用HTTP HEAD请求快速确定单例的“存在”。这种技术的优点是速度非常快，因为它不返回任何元数据——它只返回标头和HTTP状态代码（200=存在，404=不存在）。

确定成员ID98存在：

卷发--头部“https://api.crossref.org/members/98"

确定带有ISSN的日记账1549-7712存在：

卷发--头部“https://api.crossref.org/journals/1549-7712"

列表结果可以包含多个条目。搜索或筛选通常会返回列表结果。列表由两部分组成：

• 摘要，包括以下信息：

  • 状态（例如“正常”、错误）
  • 消息类型（例如“工作列表”）
  • 消息版本（例如1.0.0）

• 项，它将包含与查询或筛选器匹配的项。

请注意，返回的“messagetype”与mime-type不同：

• 资助者（单身）
• 前缀（singleton）
• 成员（单件）
• 工作（单件）
• 工作列表（列表）
• 投资者名单
• 前缀列表（list）
• 成员列表（列表）

通常，API列表结果将返回摘要和项目。如果只想检索摘要，可以通过指定返回的行数为零来实现。

如果API调用包含查询，则排序顺序将根据相关性得分。如果不包括查询，则排序顺序将按DOI更新日期。

Crossref元数据记录可能非常大。有时您只需要模式中的几个元素。您可以使用选择参数。这可以使您的API调用更加高效。例如：

https://api.crossref.org/works？示例=10&select=DOI，标题

Crossref API支持的主要资源组件包括：

• 作品
• 资助者
• 成员
• 前缀
• 类型
• 期刊

这些可以像这样单独使用

资源组件可以与标识符一起使用，以检索该标识符的元数据。

works组件可以附加到其他资源中。

参数可用于查询、筛选和控制Crossref API返回的结果。它们可以作为普通URI参数或JSON在请求体中传递。

可以通过用逗号分隔名称：值对来指定多个筛选器：

https://api.crossref.org/works？filter=有-orcid：true，起始日期：2004-04-04

https://api.crossref.org/funders/100000015/works？query=global+state&filter=has-ocid:true&rows=1

可以进行自由形式的搜索查询，例如，包括叛徒和本体:

https://api.crossref.org/works？query=renear+本体论

字段查询可在/工程路由并允许只匹配特定字段的查询元数据。例如，此查询匹配包含标记的记录理查德或费曼（或两者）在任何作者字段中：

https://api.crossref.org/works？query.author=richard+费曼

字段查询可以与常规查询参数和其他参数。每个查询参数与其他人AND：

https://api.crossref.org/works？query.lochebioric=room+at+the+bottom&query.author=richard+feynman

这些字段查询可在/工程路线：

请注意查询.title已弃用，不再可用。请使用查询参考书目而不是。

可以通过应用分类和秩序参数。订单设置结果顺序asc公司或描述.Sort设置结果所依据的字段排序。可能的值为：

按发布顺序对结果进行排序的示例，从最近的开始：

https://api.crossref.org/works？查询=josiah+carberry&sort=published&order=asc

Facet计数可以通过启用faceting来检索。通过提供facet字段名以及最大数量的返回项值来启用facet。返回值的数量越大，查询所用的时间越长。一些方面字段可以接受*作为其最大值，这表示应返回所有值。

面用指定方面参数：

https://api.crossref.org/works？rows=0&facet=type-姓名：*

过滤器允许您缩小查询范围。所有筛选结果都是列表。

支持以下筛选器/工程路线：

支持以下筛选器/成员路线：

支持以下筛选器/资助者路线：

可以在单个查询中指定多个筛选器。在这种情况下，不同的过滤器将与AND语义一起应用，而多次指定相同的过滤器将产生OR语义，即指定过滤器：

• is-update:true
• 自提交日期：2014-03-03
• 出资人：10.13039/100000001
• 出资人：10.13039/100000050

将查找2014年3月3日或之后发布的更新文件，这些文件由国家科学基金会资助(10.13039/100000001)或国家心脏、肺和血液研究所(10.13039/100000050). 通过用逗号将每个过滤器连接在一起，可以指定这些过滤器：

/有效吗？filter=is-update:true，from-pub-date:2014-03-03，资助者：10.13039/100000001，资助者:10.13039/10000050

名称中带有点的过滤器是特殊的。点表示过滤器将应用于与主资源记录类型相关的其他记录类型。例如，通过工作查询，可以筛选有奖项的作品，其中同一奖项具有特定的奖项编号和奖励资助机构：

/有效吗？filter=奖项编号：CBET-0756451，奖项资助人：10.13039/100000001

在这里，我们筛选出由国家科学基金会颁发奖项的作品，该基金会也有奖项编号CBET-0756451号.

交叉引用DOI的前缀不是指出DOI的当前所有者。它只反映了最初注册内政部的人。Crossref元数据具有所有者_前缀记录有问题的Crossref DOI的当前所有者的元素。

Crossref还具有存款组织的成员ID。一个成员可以控制多个所有者前缀，而所有者前缀又可以控制许多DOI。当查看某个组织发布的作品时，应使用成员ID和成员路线。

请注意，筛选器中的日期应始终为以下形式年-月-日,年月日或YYYY年。另请注意，Crossref元数据中的日期信息通常可能不完整。因此，例如，出版商可能只包括期刊文章的出版年份和月份。对于专著，可能只包括年份。在这些情况下，API会根据提供的信息选择最早的日期。因此，例如，如果出版商仅提供2013-02作为出版日期，则该日期将被视为2013-02-01。同样，如果出版商仅提供2013年作为日期，则将在2013年1月1日处理。

使用时间过滤器检索定期增量元数据更新时，这个自诱导日期过滤器应用于自更新日期起,自存款日期,自创建日期和自提交日期. The时间戳自诱导日期上的筛选器保证更新每次元数据发生更改时都需要重新索引。

您可以使用排,抵消和样品参数。

如果您期望的结果超过10K，则使用光标深入浏览结果。请注意，并非所有路由都支持光标。

通常，每次返回20个结果。您可以使用排参数。例如，要将结果限制为5，可以执行以下操作：

https://api.crossref.org/works？query=allen+重新排列（&R）=5

如果你只想得到总结在结果中，可以将行设置为0（零）。

https://api.crossref.org/works？query=allen+renear&rows=0

在一个查询中可以请求的最大行数为1000.

退回的项目数量由排参数，但您可以使用抵消参数。因此，例如，要选择第二组5个结果（即结果6到10），您需要执行以下操作：

https://api.crossref.org/works？query=allen+renear&rows=5&offset=5

的偏移/工程限制为10K。使用光标（见下文）/工程结果集。

使用大型抵消值可能会导致非常长的响应时间。100000秒及以上的偏移可能会在API能够响应之前导致超时。除了在非常大的结果集（如用于文本和数据挖掘的语料库）中分页之外，另一种选择是使用API对Solr深度分页游标的公开。深度分页游标可以使用查询、过滤器和facet的任何组合。While期间排可以与一起指定光标,抵消和样品无法使用。要使用深度分页，请正常进行查询，但要包括光标参数的值为*。在本例中，我们将翻阅所有新闻文章成员的作品311:

https://api.crossref.org/members/311/works？filter=type:journal-文章和光标=*

A类下一电流字段将在JSON响应中提供。要获得下一页结果，请传递下一电流作为光标参数。例如：

https://api.crossref.org/members/311/works？filter=type:journal-文章和光标=AoE/CGh0dHA6Ly9keC5kb2kub3JnLzEwLjEwMDIvdGRtX2xpY2Vuc2VfMQ==

请注意，实际光标值将与本图不同。

客户应检查退货数量。如果返回的项目数小于预期的行数，则已到达结果集的末尾。使用下一电流超过这一点将导致响应中出现一个空的项目列表。

这个光标参数可用于所有/工程资源。

能够选择随机结果对测试和采样都很有用。您可以使用样品参数检索随机结果。因此，例如，以下选择了10个随机作品：

https://api.crossref.org/works？示例=10

请注意，当您使用样品参数排和抵消参数被忽略。

所有由所有者前缀发布的作品10.10162010年1月

https://api.crossref.org/prefixes/10.1016/works？filter=来自-发布日期：2010-01，直到发布日期：2010年01月

所有工程由10.13039/10000001有CC-BY许可证的

https://api.crossref.org/funders/10.13039/100000001/works？filter=license.url:http://creativecommons.org/licenses/by/3.0/

2010年2月至2013年2月由所有者前缀10.6064发布的所有具有CC-by许可证的作品

https://api.crossref.org/prefixes/10.6064/works？filter=license.url:http://creativecommons.org/licenses/by/3.0/，从提交日期：2010-02，直到发布日期：2013-02

所有工程由10.13039/100000015其中，许可证=CC-BY和禁运<=365天

https://api.crossref.org/funders/10.13039/1000000015/works？filter=license.url:http://creativecommons.org/licenses/by/3.0/，许可证。延迟：365

请注意，许可证URL和最长许可证禁运期（license.URL和license.delay）的过滤器结合使用，可以使用这两个属性过滤每个文档的许可证元数据。

所有在归档合作伙伴列出=“时钟”时工作

https://api.crossref.org/works？filter=archive:CLOCKSS（时钟）

所有成员后面的以他们的名义（例如Hindawi）

https://api.crossref.org/members？query=hind

与爱思唯尔出版的作品相关的所有许可

https://api.crossref.org/v1/works？facet=许可证：*&过滤器=成员：78行=0

所有许可证均适用于期刊上发表的作品国际病理学研究

https://api.crossref.org/works？facet=许可证：*&过滤器=issn:2090-8091

所有获奖作品大致编号1楼31号MH11745也由ID出资人授予10.13039/100000025

https://api.crossref.org/works？filter=奖励。编号：1F31MH11745，奖项。出资人：10.13039/100000025

具有引用的DOI数量以及引用的位置打开按出版商名称刻面

https://api.crossref.org/v1.0/works？filter=has-引用：true，reference-visibility:open&facet=publisher-name:*&rows=0

理论上，API的语法可以独立于结果表示而变化。实际上，两者中的主要版本更改都需要更改API客户端，因此API的版本控制将应用于API语法和结果表示。

API使用语义版本控制方案，将版本号分为三部分，由句点分隔。第一个数字表示“主要”版本号。第二个表示“次要”版本号。

版本1.20^  ^|  |主要|少数的

专业版本增量被定义为可能破坏向后兼容性的版本。Crossref将只承诺同时支持最新的两个主要版本，旧版主要版本的支持时间将不超过九个月。当需要进行重大发布以确保系统的安全性或稳定性时，可以对这些规则进行例外。

次要版本增量定义为向后兼容。Crossref可以推出的次要版本数量没有限制。请注意，客户端应用程序不应依赖次要版本，Crossref将只为两个最新的主要版本维护最新的次要版本。

向表示中添加语法选项或元数据通常是向后兼容的，因此通常只会触发较小的版本更改。重命名或重组元数据的语法选项往往不向后兼容，因此通常会触发主要版本更改

如果需要将实现与API的特定主版本绑定，可以使用特定于版本的路由来实现。默认路由重定向到API的最新版本。一些较旧的主要版本可能使用版本前缀。例如，要访问版本第1版API标准：

https://api.crossref.org/v1/works网站

每个主要版本在其公共接口中都没有向后不兼容的更改。

• V1:2013-09-08，初稿。
• V2:2013-09-24，部署参考平台
• v3:2013-09-25，返工过滤器。添加API版本文档
• v4:2013-09-25，更多过滤器更改。
• v5:2013-09-27，文档mime类型和消息类型关系
• v6:2013-10-01，更新样品&添加了带过滤器的示例
• v6:2013-10-01，更正的警告日期
• v7:2013-10-02，修复了打字错误
• v8:2013-10-17，更新了警告。添加了电子邮件地址
• v9:2013-12-13，更新示例url
• v10:2013-12-13，/类型路由，类型筛选器，issn筛选器
• v11:2013-12-14，索引时间戳，实现了归档和归档
• v12:2014-01-06，目录过滤器
• v13:2014-02-10，新/成员,/出版商成为/前缀，新的成员过滤器，出版商过滤器变为前缀
• v14:2014-02-14，新增哈斯-费恩过滤器。
• v15:2014-02-27，新增/许可证路线
• v16:2014-05-19，新增/期刊路由，新CrossMark（更新和更新策略）筛选器，新分类和秩序参数
• v17:2014-05-19，新增方面查询参数
• v18:2014-05-29，新增/工作/{doi}/agency路线
• v19:2014-06-23，新文本过滤器-集装箱装载机,类别名称.
• v20:2014-06-24，OR过滤器查询，类型名称过滤器。
• v21:2014-07-01，新增授予编号和奖助人关系过滤器。
• v22:2014-07-16，更改标题以更准确地反映API范围。
• v232014-09-01，多点过滤器、点过滤器的语义
• 2014年10月15日第24版，增加了Crossref元数据本身的许可信息。Doh公司。
• v25，2015-05-06，添加了问题跟踪器的链接。删除了“警告”部分。
• v26，2015-10-20，新增过滤器-自创建日期,直到创建日期,附属,has-关联,断言组,断言,物品编号,替代id
• 第27版，2015年10月30日，新增光标参数到/工程资源
• v28，2016-05-09，添加了类别标签源的链接
• v29，2016-05-24，添加了字段查询
• v30，2016-09-26，突出显示问题跟踪
• v31，2016-10-05，文档has-临床试验数和has-摘要过滤器
• v32，2016-10-27，文件费率限制标题
• v33，2016-11-07，何时使用指南抵消与光标
• v34，2017-04-26，HTTPS文档支持。更新示例以使用HTTPS。
• v35，2017-04-26，记录使用头需求来确定存在
• v36，2017-04-27，修复了许可证路由示例以使用facet/filter
• 2017年4月27日第37版，查询参考书目
• v38，2017-04-27，添加v1.1过滤器和排序字段
• v39，2017-04-27，删除demox
• v40，2017-04-27，澄清刻面特征
• v412017-04-28，文件样品max=100，澄清光标仅适用于某些路线
• v42，2017-04-28，生命、宇宙和一切
• v43，2017-04-28，关于url编码智慧的提醒
• v44，2017-04-28，澄清了字段查询适用于/作品路线
• v45，2017-04-28，文件位置过滤器/资助者路线
• v46，2017-06-14，微小的文本更改和新的资助者注册链接
• v47，2017-07-04，澄清查询从属关系
• v48，2017-07-13，将“名和名”改为“名和姓”
• v49，2017-07-20，移动文档版本历史，添加库部分
• v50201707-20，添加TOC，移动文档历史记录，添加etiquet部分，添加生产使用部分，常规格式化+清理
• v51，2017-07-24，澄清了文档的许可（与元数据相反）
• v52，2017-07-27，删除了服务通知和新增部分。
• v53，2017-08-11，提及全文应用程序滤波器
• v54，2017-09-18，添加有关新“礼貌池”的信息
• v55，2017-09-21，文档/成员和/资助者过滤器。文件出版商名称方面。文件选择参数。
• v56，2018-01-26，添加索引频率信息
• v57，2018-02-01，文件ISBN过滤器
• v58，2018-02-13，文档参考可视性过滤器/工程和/成员路线
• v59，2018-02-13，添加了有关Mtedata Plus服务的信息。更正拼写。添加了使用示例参考可视性过滤器。
• v60，2018-02-22，添加了“Plus”用户在中使用令牌的信息授权收割台。
• v61，2018-02-26，添加curl示例以使用令牌。
• v62018-06-18，阐明如何解析X-Rate-Limit-Limit间隔
• v63，2018-08-16，删除错误列出的年方面。已发布是正确的方面名称。
• v64，2018-09-04，添加文本并链接到状态页。
• v652019-07-17，将Plus代币名称更新为新推荐
• v66，2019-10-16，已弃用query.title for query.lochebiographic
• v67，2020-04-28，明确了url编码应该应用于包括游标在内的所有参数。
• v68，2021-02-22，添加了Pitaya Julia库的链接
• v69，2021-04-30，用阅读建议更新前言