OpenCitations索引的REST API

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

描述返回顶部

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

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

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

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

参数返回顶部

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

1. require=<field_name>：中具有空值的所有行<字段名称>从结果集中删除指定的-例如。require=给定名称删除中未指定任何字符串的所有行给定名称字段。

2. filter=＜field_name＞：＜operator＞＜value＞：仅符合的行<值>保存在结果集中。参数<操作>不是强制性的。如果<操作>未指定，<值>被解释为正则表达式，否则通过指定的操作进行比较。可能的运算符为“=”、“<”和“>”。例如，filter=title:语义？返回字段中包含字符串“语义”或“语义”的所有行标题，同时过滤器=日期：>2016-05返回具有日期2016年5月之前。

3. 排序=<顺序>（<field_name>）：按升序排序(<订单>设置为“asc”）或降序(<订单>设置为“desc”）根据中的值对结果集中的行进行排序<字段名称>例如，sort=描述（日期）根据字段中指定的值对所有行进行排序日期按降序排列。

4. format=格式类型：以中指定的格式返回最终表<格式_类型>可以是“csv”或“json”-例如。格式=csv以CSV格式返回最终表格。此参数具有通过请求的“Accept”标头指定的类型的更高优先级。因此，如果API请求的头指定接受：text.csv该请求的URL包括格式=json，最后一个表以JSON格式返回。

5. 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). 此外，这些过滤操作按上述顺序应用-首先所有要求操作，然后所有滤波器所有分类操作，最后是格式和杰森操作（如适用）。值得一提的是，前面提到的每一条规则都是按顺序应用的，它适用于执行前面的规则后返回的结构。

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