在这次采访中,罗伯·彼得斯, ORCID技术总监介绍 ORCID的新 API – 于 14 年 2017 月 XNUMX 日推出
在我们开始谈论新的 API 之前,你能告诉我们一些关于 ORCID的技术团队和您作为总监的角色?
乍一看, ORCID 团队看起来很像任何其他技术团队。 我们有五个开发人员,一个服务器管理员,一个质量保证分析师,当然还有一个经理(我)。 然而,有趣的是我们不同的地理、文化和工作背景。 我们三个在美国,三个在哥斯达黎加,两个在英国,所以在地理上我们有很多观点。 此外,我们中的一些人来自传统的软件咨询,其他人来自出版业、“硅谷”初创公司和图书馆学。
我作为技术总监的个人角色是管理日常软件开发。 这归结为帮助我的团队相互沟通以及与组织的其他成员沟通,以及管理团队承担哪些任务(以及哪些任务被推迟)。 我也有机会对更高级别的战略决策有很多投入 ORCID 制造。
转向 API 2.0 版——我们为什么要—— ORCID,以及 ORCID 社区 – 需要升级吗?
最快的 ORCID API 于 2012 年 XNUMX 月推出,不可避免地基于许多后来被证明是错误的和/或需要改进的假设。 为了更好地为研究界服务,我们必须不断检查这些假设。 使用反馈、提出问题并查看我们发布之前无法获得的证据,让我们对 ORCID API 应该也不应该。 正如您将在我对下一个问题的回答中看到的那样,2.0 版代表了对构建 1.0 的假设的重大突破,同时仍然足够实用以提供两个 API 之间的连续性。
1.2 和 2.0 之间的主要区别是什么?它们将如何使会员受益?
在开发 2.0 时,我们既要解决成员在 1.2 中遇到的障碍,又要引入我们知道社区需要的新功能。
因此,除了解决已知问题,例如管理超编写出版物的可扩展性,以及导致成员混淆的隐性行为挑战,我们还添加了新功能以支持同行评审识别、改进用户通知以及支持几乎任何 持久标识符。
为了解释为什么需要这些更改中的一些,我将获得一些技术性的知识。 在开始编写新的一行代码之前,我们列出了我们希望改进的地方,并附有以下“宣言”:
- 停止思考 ORCID 记录为整体(大单)文档。 多个机构写信给一个 ORCID 记录意味着识别记录是 多租户. 此外,研究人员经常进行大量的研究,以至于即使是对它的总结也不适合放在一个单一的文档中。
- 简化的范围. 1.0 API 中权限范围的粒度对于所有相关方来说都是压倒性的; 简化它们将使开发人员和用户的生活更轻松。
- 明确的 REST风格 行为. 隐性行为对实施者不利,因为它们会导致意外行为,进而使最终用户感到困惑。 通过使用 RESTful 行为,我们的新 API 避免了这些问题。
- 最短的合理网址. 一个很好的例子是 /works/1234 比 /orcid-作品/1234。
- 调用列表仅返回摘要. 为了更快地调用记录,API 2.0 只返回列表的摘要。 对研究人员的每一条信息都进行一次调用并不适用于超级作者的文章,因为那里有数十、数百甚至数千名作者。
- 通用元素的通用名称和结构. 2.0 使我们能够确保 XML/JSON 中的公共元素具有相同的名称。
- 错误代码. 当标准 HTTP 代码未完全描述错误时,我们现在在响应正文中包含错误代码。
对用户有什么好处?
归根结底,API 应该对用户是无缝的。 意外的 1.0 行为冒泡并影响用户体验,同时让正在实施 API 的开发人员感到沮丧。 在实用层面上,新的 API 可以简化每个部分 ORCID 记录以一致地为每个部分中的项目提供可见性设置、来源和创建日期的应用。
这也会影响公共 API 吗? 如何?
是的。 对成员 API 和公共 API 的更改始终保持同步。 尽管我们感谢并依赖成员的支持,但我们也致力于实现我们更大的愿景,“在这个世界里,所有参与研究、奖学金和创新的人都被独特地识别出来,并与他们跨越学科、国界和时间的贡献相关联。 我们将公共 API 视为帮助实现该目标的一种手段。
您认为推出新版本的主要挑战是什么,以及将提供哪些支持? ORCID 提供?
最困难的问题是留出资源来完成工作 升级. 对于某些组织,它可能只需几天,而其他组织可能需要整整一个月。 无论时间安排如何,都不要害怕伸出手寻求帮助,即使是一些阻碍您进步的细节。 完整文件 现在可以在会员上使用。orcid.org和 ORCID 会员组织也可以 立即联系我们. 发布到 API 用户论坛 可能很有用,带来来自各地的评论 ORCID 社区。 我也坚信直接可用,所以觉得 直接给我发电子邮件.
目前谁在使用 API 2.0,他们提供了什么样的反馈?
为了获得反馈,我们付出了很多努力来提供候选版本。 CrossRef、Datacite、CERN 和 PTCRIS 只是其中的一小部分 ORCID 已实施候选版本并提供反馈的成员。 此外,一些组织已经使用 2.0 实现了同行评审功能,包括早期采用者、美国地球物理联盟、F1000 和 Publons。 反馈包括通常的“技术人员”建议,例如模式中使用的名称、端点命名或关于效率的辩论。 这些细节可能对会员产生重大影响。 然而,候选版本的实施者也从研究人员的角度提供反馈,我们认为这是非常宝贵的。
要多久 ORCID 继续支持旧 API?
我们的目标是在 1.2 年末推出 2017。无论日落日期如何,如果您同意 ORCID的使命 并关心研究人员与之互动 ORCID 你现在想要迁移到 2.0。
关于这个变化,我们还应该知道什么?
我们希望 2.0 被证明是持久的,我们可以专注于其他部分 ORCID 技术栈好一阵子了!
有关 API 2.0 功能的有趣且方便的摘要,请参阅此 滑动甲板!