所有OpenCitations索引的统一REST API

版本：版本1.2.0（2023-11-06）
API URL： https://opencitations.net/index/api/v1
联系人： contact@opencitations.net
许可证：本文档授权使用Creative Commons Attribution 4.0国际许可，而REST API本身是使用创建的拉莫斯，的SPARQL端点上的Restful API管理器由创建西尔维奥·佩罗尼，该许可证由ISC许可证.

描述返回顶部

本文档描述了用于访问存储在所有OpenCitations索引主办开放式引文该API实现了检索特定书目实体中出现的所有其他作品引用的引文数据的操作，或者在给定书目实体的DOI的情况下，检索其他作品中出现的特定书目主体的所有引用的引用数据，或检索通过其识别的特定引文的引文数据开放引文标识符（OCI）.

所有当前操作都会根据中指定的mimetype返回JSON文档（默认）或CSV文档接受请求的标头。如果您想建议在此API中包含其他操作，请使用问题跟踪器GitHub上提供的OpenCitations API。

如果您要在应用程序/代码中使用REST API，我们鼓励您获得OpenCitations访问令牌并在REST API调用的“authorization”头中指定它。以下是Python中的用法示例：

从请求导入获取API_CALL=“https://opencitations.net/index/api/v1/references/10.1186/1756-8722-6-59"HTTP_HEADERS={“授权”：“YOUR-OPENCITATIONS-ACCESS-TOKEN”}获取（API_CALL，headers=HTTP_headers）

注：出于历史和兼容性原因，我们使用某些遗留API。我们鼓励使用最新和更高效的V2 API，我们了解到一些应用程序可能仍然依赖于这些较旧的端点。请注意，遗留API可能不会得到更新或支持，它们的使用可能会在未来逐步取消。我们建议过渡到当前V2 API以提高性能、安全性和可靠性。

参数返回顶部

参数可用于筛选和控制API返回的结果。它们在调用的URL中作为普通HTTP参数传递。他们是：

require=<field_name>：中具有空值的所有行<字段名称>从结果集中删除指定的-例如。require=给定名称删除中未指定任何字符串的所有行给定名称字段。
过滤器=<field_name>：<operator><value>：仅符合的行<值>保存在结果集中。参数<操作>不是强制性的。如果<操作>未指定，<值>被解释为正则表达式，否则通过指定的操作进行比较。可能的运算符为“=”、“<”和“>”。例如，filter=title:语义？返回字段中包含字符串“语义”或“语义”的所有行标题，同时过滤器=日期：>2016-05返回具有日期2016年5月之前。
排序=<顺序>（<field_name>）：按升序排序(<订单>设置为“asc”）或降序(<订单>设置为“desc”）根据中的值对结果集中的行进行排序<字段名称>例如，sort=desc（日期）根据字段中指定的值对所有行进行排序日期按降序排列。
format=格式类型：以中指定的格式返回最终表<格式_类型>可以是“csv”或“json”，例如。格式=csv以CSV格式返回最终表格。此参数具有通过请求的“Accept”标头指定的类型的更高优先级。因此，如果API请求的头指定接受：text/csv该请求的URL包括format=json格式，最后一个表以JSON格式返回。
json=<操作类型>（“<分隔符>”，<字段>，<新字段_1>，<新建字段_2>，…）：如果请求返回JSON格式，请根据指定的规则转换最终JSON表的每一行。如果<操作类型>设置为“array”，即与字段名关联的字符串值<字段>通过以下方式拆分各个文本部分，将其转换为数组<分隔符>例如，考虑JSON表[{“名字”：“Doe，John；Doe，Jane”}，…]，执行数组（“；”，名称）收益[{“名字”：[“Doe，John”，“Doe、Jane”]，…]相反，如果<操作类型>设置为“dict”，即与字段名关联的字符串值<字段>通过以下方式拆分各种文本部分，将其转换为字典<分隔符>并通过关联新字段<新字段_1>,<新字段_2>等。例如，考虑JSON表[{“name”：“Doe，John”}，…]，执行dict（“，”，name，fname，gname）收益[{“name”：{“fname”：“Doe”，“gname”：“John”}，…].

可以指定一个或多个同类过滤操作（例如。require=给定名称&require=family_name). 此外，这些过滤操作是按照上面给出的顺序应用的——首先是要求操作，然后所有滤波器所有分类操作，最后是格式和json语言操作（如适用）。值得一提的是，前面提到的每一条规则都是按顺序应用的，它适用于执行前面的规则后返回的结构。

例子：<api_operation_url>？require=doi&pilter=date:>2015&sort=desc（日期）.

操作返回顶部

此API实现的操作包括：

/引文/{oci}：此操作检索由输入Open citation Identifier（OCI）标识的引文的引文元数据。

/引用计数/{doi}：此操作检索输入DOI标识的书目实体的传入引用数。

/reference-count/{doi}：此操作从输入DOI标识的书目实体检索传出引用的数量。

/元数据/{dois}：此操作检索由一个或多个输入DOI标识的每个书目实体的书目元数据。

/引文/{doi}：此操作将其他引用作品参考列表中出现的所有参考文献的引用数据检索到由输入DOI标识的书目实体，这些书目实体构成该标识书目实体的传入引用。

/引用/{doi}：此操作检索输入DOI标识的书目实体参考列表中出现的其他引用作品的所有传出引用的引用数据。

/引文/{oci}返回操作

此操作检索由输入Open citation Identifier（OCI）标识的引文的引文元数据。

Open Citation Identifier是书目引文的全球唯一持久标识符，其结构简单：小写字母“oci”后跟冒号，后跟两个由破折号分隔的数字。例如，oci:1-18是有效的OCI。

值得一提的是，在这个REST操作中，前缀“oci:”不应该则只应提供OCI的以破折号分隔的数字，如下例所示。

此操作返回的字段为：

oci公司：考虑中引文的公开引文标识符（OCI）；
引用：引用实体的内政部；
引用：被引用实体的DOI；
创造：根据国际标准化组织日期格式 年-月-日与引用实体的发布日期相对应；
时间跨度：被引用实体的发布日期与被引用实体发布日期之间的间隔，使用XSD持续时间格式 PnYnMnD公司;
日记_抄送：记录引文是否为期刊自引（即引文和被引实体在同一期刊上发表）；
作者_抄送：它记录了引文是否是作者自引（即引文和被引用实体至少有一个共同作者）。

所有字段的值都以[索引名称]=>，以便清楚地识别相关数据的来源，并且可以包含一个或多个信息，由;。当引文实际包含在两个或多个OpenCitations索引中时，这尤其有用。在这种情况下，只会返回一行，并且各种数据中使用的前缀允许人们了解此类数据的源索引。

接受的HTTP方法 得到

参数 oci公司：类型字符串，正则表达式形状[0-9]+-[0-9]+

结果字段类型oci公司（字符串），引用（字符串），引用（字符串）

例子/引文/06101801781-06180334099

示例输出（JSON格式）

[{“oci”：“06101801781-06180334099”，“引用”：“10.7717/peerj-cs.421”，“引用”：“10.1108/jd-12-2013-0166”，“创建”：“2021-03-10”，“时间跨度”：“P6Y0M1D”，“journal_sc”：“否”，“author_sc”：“否”}]

/引文计数/｛doi｝返回操作

此操作检索输入DOI标识的书目实体的传入引用数。

此操作返回的字段为：

计数：输入书目实体的传入引用数。

接受的HTTP方法 得到

参数 国防部：类型字符串，正则表达式形状10\..+

结果字段类型计数（整数）

例子/引文计数/10.1142/9789812701527_0009

示例输出（JSON格式）

[{“计数”：“32”}]

/reference-count/{doi}返回操作

此操作从输入DOI标识的书目实体中检索传出引用的数量。

此操作返回的字段为：

计数：输入书目实体的传出引用数。

接受的HTTP方法 得到

参数 国防部：类型字符串，正则表达式形状10\..+

结果字段类型计数（整数）

例子/参考号/10.1186/1756-8722-6-59

示例输出（JSON格式）

[{“计数”：“75”}]

/元数据/{dois}返回操作

此操作检索由一个或多个输入DOI标识的每个书目实体的书目元数据。

可以指定一个或多个DOI作为此操作的输入。在这种情况下，DOI应该用双下划线（“__”）隔开，例如“10.1108/jd-12-2013-0166__10.1016/j.websem.2012.08.001__…”。此操作返回的字段为：

作者：书目实体作者的分号分隔列表；
年：书目实体的出版年份；
标题：书目实体的标题；
源标题（_T）：书目实体出版地点的名称；
源id：以分号分隔的标识符列表，表示书目实体已发布的来源；
体积：书目实体出版的卷号；
问题：书目实体出版的期刊号；
第页：书目实体在出版地点的起始页和结束页；
国防部：书目实体的DOI；
参考：根据所有OpenCitations Indexes中可用的引用数据，书目实体引用的所有实体的分号分隔的DOI；
引用：根据所有OpenCitations Indexes中可用的引用数据，引用书目实体的所有实体的分号分隔的DOI；
引用_计数：书目实体收到的引文数量；
oa_链接：指向书目实体的开放获取版本的链接（如果可用）。

注意：此操作根据OpenCitations Meta的请求动态收集所有元数据。

接受的HTTP方法 得到

参数 国防部：类型字符串，正则表达式形状\"?10\..+[^_\"]((__|\" \")10\..+[^_])*\"?

结果字段类型作者（字符串），年（日期时间），标题（字符串），源标题（_T）（字符串），源id（字符串），卷（字符串），问题（字符串），第页（字符串）、doi（字符串），参考（字符串），引用（字符串），引用_计数（整数），oa_link（_O）（字符串）

例子/元数据/10.1007/s11192-019-03217-6

示例输出（JSON格式）

[{“doi”：“10.1007/s11192-019-03217-6”，“引文计数”：“43”，“引文”：“10.1371/journal.pone.0270872；10.1007/s11192-022-04581-6；；；10.1007/978-3-030-96957-8_9；10.2964/jsik_2020_003；10.1093/reseval/rvac037；10.1007/978-3-030-62466-8_28；10.3897/rio.7.e66264；10.1186/s12916-022-02644-2；10.1093/4igascience/giab003；10.3989/arbor.20799007；10.1145/3540250.3549172；10.1162/qss_a0112；10.1162/qss_a_00023；10.1007/s11192-019-03311-9；10.1007/978-3-031-06981-9_18; ; ; 10.1145/3383583.3398584; 10.1162/qss_a_00203；10.1111/箱13067；10.5712/rbmfc15（42）2671；10.1145/3529372.3530953; ; 10.7717/peerj-cs.421；10.1016/b978-0-12-823723-6.00001-x；10.3233/sw-210439；10.3145/thinkepi.2021.e15e04；10.1093/llc/fqac016；10.1007/s11192-022-04367-w；10.1007/s11192-021-04191-8；10.1007/s11192-021-04097-5；10.1007/s11192-020-03690-4；10.7717/peerj.13712“，“参考文献”：“10.6084/m9.图7873559；10.3233/sw-150197；10.4103/0976-500x.85940；；10.1007/978-3-319-17966-7_10；10.1007/s11192-009-0146-3；10.1007/77-3-030-00668-6_8；10.1007/978-3-319-53637-8_6；10.6084/图7127816；10.1016/j.websem.2012.08.01；10.1007/978-3-3169-1955-742；10.1007/R78-319-11964-9_4；10.6084/m9.图3443876； 10.1007/978-3-319-68204-4_19; 10.1007/978-3-319-46547-0_16; 10.7717/peerj.4201；10.3233/ds-190016；10.1038/自然2017.21800；10.1038/数据2016.18；10.6084/m9.无花果.6683855“，“作者”：“Heibi，Ivan，0000-0001-5366-5194；Peroni，Silvio，0000-0003-0530-4305；Shotton，D M，0000-0001-5506-523”，“年份”：“2019-09-14”，“title”：“软件评论：COCI，Crossref开放DOI-to-DOI引文的开放引文索引”，“source_title”：“科学计量学”，“卷”：“121”，“问题”：“2”，“页码”：“1213-1228”，“源id”：“issn:1588-2861”，“oa_link”：“”}]

/引文/{doi}返回操作

此操作将其他引用作品参考列表中出现的所有参考文献的引用数据检索到由输入DOI标识的书目实体，这些实体构成了该标识书目实体的传入引用。

此操作返回的字段为：

oci公司：考虑中引文的公开引文标识符（OCI）；
引用：引用实体的内政部；
引用：被引用实体的内政部；
创造：根据国际标准化组织日期格式 年-月-日与引用实体的发布日期相对应；
时间跨度：被引用实体的发布日期与被引用实体发布日期之间的间隔，使用XSD持续时间格式 PnYnMnD公司;
日记_抄送：记录引文是否为期刊自引（即引文和被引实体在同一期刊上发表）；
作者_抄送：它记录了引文是否是作者自引（即引文和被引用实体至少有一个共同作者）。

接受的HTTP方法 得到

参数 国防部：类型字符串，正则表达式形状10\..+

结果字段类型国际奥委会（字符串），引用（字符串），引用（字符串），创建（日期时间），时间跨度（持续时间）, ?日记_抄送（字符串）, ?作者_抄送（字符串）

例子/引文/10.1186/1756-8722-6-59

示例输出（JSON格式）

[{“oci”：“06101440095-06190834283”，“引用”：“10.3390/molecules25092135”，“引用”：“10.1186/1756-8722-6-59”，“创建”：“2020-05-02”，“时间跨度”：“P6Y8M13D”，“journal_sc”：“否”，“author_sc”：“否”},{“oci”：“06101524605-06190834283”，“引用”：“10.1016/j.clim.2016.01.012”，“引用”：“10.1186/1756-8722-6-59”，“创建”：“2016-03”，“时间跨度”：“P2Y6M”，“journal_sc”：“否”，“author_sc”：“否”},{“oci”：“06101763144-06190834283”，“引用”：“10.3390/药剂学13081222”，“引用”：“10.1186/1756-8722-6-59”，“创建”：“2021-08-07”，“时间跨度”：“P7Y11M19D”，“journal_sc”：“否”，“author_sc”：“否”},。。。]

/引用/{doi}返回操作

此操作检索输入DOI标识的书目实体参考列表中出现的其他引用作品的所有传出引用的引用数据。

此操作返回的字段为：

国际奥委会：考虑中引文的公开引文标识符（OCI）；
引用：引用实体的内政部；
引用：被引用实体的内政部；
创造：根据国际标准化组织日期格式 年-月-日与引用实体的发布日期相对应；
时间跨度：引用实体的发布日期与引用实体的发布日期之间的间隔，使用XSD持续时间格式 PnYnMnD公司;
日记_抄送：记录引文是否为期刊自引（即引文和被引实体在同一期刊上发表）；
作者_抄送：它记录了引文是否是作者自引（即引文和被引用实体至少有一个共同作者）。

接受的HTTP方法 得到

参数 国防部：类型字符串，正则表达式形状10\..+

结果字段类型oci公司（字符串），引用（字符串），引用（字符串），创建（日期时间），时间跨度（持续时间）, ?日记_抄送（字符串）？作者_抄送（字符串）

例子/参考文献/10.1186/1756-8722-6-59

示例输出（JSON格式）

[{“oci”：“06190834283-06101389277”，“引用”：“10.1186/1756-8722-6-59”，“引用”：“10.1124/dmd.11.040840”，“创建”：“2013-08-19”，“时间跨度”：“P2Y1M11D”，“journal_sc”：“否”，“author_sc”：“否”},{“oci”：“06190834283-06102258727”，“引用”：“10.1186/1756-8722-6-59”，“引用”：“10.1093/hmg/3.10.1743”，“创建”：“2013-08-19”，“时间跨度”：“P19Y”，“journal_sc”：“否”，“author_sc”：“否”},{“oci”：“06190834283-06103522789”，“引用”：“10.1186/1756-8722-6-59”，“引用”：“10.3109/08830185.2012.664797”，“创建”：“2013-08-19”，“时间跨度”：“P1Y4M29D”，“journal_sc”：“否”，“author_sc”：“否”},。。。]