七月标志着 我们发布后的第五个月 ORCID API v2.0,我们很高兴地报告,公共和会员 API 的许多用户已经或正在升级。 为了鼓励那些尚未开始升级的人,我们想强调 v2.0 的一些特性 这将简化您的工作流程,减少传输文件的大小,并使您的 ORCID 集成更适合您和您的用户。
更少的范围,更少的混乱
我们的旧 API 使您能够请求大量 来自用户的权限:在一个部分中创建项目、阅读同一部分并更新它的权限。 为每个部分请求单独的权限会导致一系列让用户感到困惑的请求。
在 API v2.0 中,我们已经 巩固我们的范围 一分为三,它允许您请求读取(有限)和更新对所有部分的访问 ORCID 记录。
仍然拥有那些处于旧权限的令牌? 别担心 - 他们将继续在最初授予的访问级别上工作。 但是,如果升级后的系统具有涉及访问其记录其他部分的新功能,您可能希望构建工作流以请求用户刷新其权限。
按项目读取和更新
使用以前版本的 API,如果您的系统需要在您添加了多个作品的记录上添加新的单个作品,那么它必须更新整个作品部分,包括新作品和所有以前添加的作品。 因此,更新记录上的单个项目涉及发送一个潜在的大文件,其中包含没有更改的其他项目,或者丢失该部分中的所有项目,甚至整个记录。
v2.0 通过以下方式简化了此过程 单独管理项目. 你的系统可以 将单个作品添加到 ORCID 记录,然后编辑或删除该单个作品。 这是通过实现 把代码 对于个别项目 ORCID 注册表。 例如,如果您的系统将新的雇佣关系添加到 ORCID 记录, ORCID API 会返回一条确认消息以及您的系统仅可用于更新或删除该项目的放置代码。 通常,一次只能添加、编辑或删除一个项目。 ORCID 记录。 唯一的例外是作品,对于许多研究人员来说,这构成了他们的大部分 ORCID 记录。 API v2.0 允许您的系统 阅读多达 50 部作品 一次,并 最多可添加 100 个作品 一次。 编辑或删除作品仍然必须以项目为基础进行。
放置代码具有追溯力:在 1.2 及更早版本中添加的项目都已分配放置代码。 当您为 v2.0 升级系统时,请记住为其相应的放置代码添加一个字段。 您可以查询一个 ORCID 记录以获取您的系统添加到注册表中的任何项目的放置代码,并相应地更新您的数据库,以便您将来能够根据需要更新它们。
更快地读取记录
API v2.0 与之前的 API 一样,允许您的系统 在一次调用中读取单个部分或整个记录. 返回的不会是记录上的所有数据,而是三个部分的摘要视图,这三个部分往往是最大的 ORCID 记录:作品、资金和同行评审。
无论您的系统读取完整记录还是单个部分, 摘要视图 显示这些活动。 摘要包含的信息有限:例如,作品摘要仅返回作品名称、类型、日期、其唯一标识符及其与作品的关系、项目每个版本的显示索引(如果有多个版本)、项目的每个版本的源(用户或 API 客户端)和相应的放置代码。
摘要视图减少了文件大小和传输时间,减少了我们系统和您的系统的潜在压力,并使更新速度更快。
这么多!
v2.0 中还有很多值得高兴的地方:灵活支持外部标识符,添加同行评审活动,更清晰地对多个版本的活动进行分组,默认搜索结果更大,等等。
想了解更多? 加入我们! 每个月我们都会举办多个时区和语言的网络研讨会,而在今年余下的时间里,我们将讨论升级到 API v2.0。 检查我们的下一个列表或 立即联系我们 了解更多信息。
您是否已经升级到 API v2.0? 让我们知道您的经验!