En esta entrevista Rob Peters, ORCIDDirector de Tecnología, presenta ORCIDnueva API - lanzada el 14 de febrero de 2017
Antes de empezar a hablar sobre la nueva API, ¿puede contarnos un poco sobre ORCIDEquipo Técnico y su rol como Director?
A primera vista, la ORCID equipo se parece mucho a cualquier otro equipo técnico. Tenemos cinco desarrolladores, un administrador de servidor, un analista de control de calidad y, por supuesto, un gerente (yo). Sin embargo, lo que se vuelve interesante son nuestros diferentes antecedentes geográficos, culturales y laborales. Tres de nosotros estamos basados en los Estados Unidos, tres en Costa Rica y dos en el Reino Unido, por lo que geográficamente tenemos mucha perspectiva. Además, algunos de nosotros somos de consultoría de software tradicional, otros venimos de la industria editorial, empresas emergentes de “Silicon Valley” y bibliotecas.
Mi función personal como Director de Tecnología es gestionar el desarrollo de software del día a día. Eso se reduce a ayudar a mi equipo a comunicarse entre sí y con el resto de la organización, así como a administrar qué tareas asume el equipo (y cuáles se posponen). También tengo la oportunidad de participar mucho en decisiones estratégicas de alto nivel. ORCID hace.
Pasando a la versión 2.0 de API, ¿por qué? ORCID, Así como la ORCID comunidad - ¿necesita esta actualización?
El Primer ORCID API, que se lanzó en octubre de 2012, se basó inevitablemente en muchas suposiciones que luego resultaron incorrectas y / o requirieron refinamiento. Para servir mejor a la comunidad de investigadores, tenemos que examinar continuamente esos supuestos. Usar comentarios, hacer preguntas y observar evidencia que no estaba disponible antes de nuestro lanzamiento nos ha brindado nuevos conocimientos sobre lo que ORCID La API debería y no debería serlo. Como verá en mi respuesta a la siguiente pregunta, la versión 2.0 representa una ruptura importante con las suposiciones sobre las que se construyó 1.0, sin dejar de ser lo suficientemente pragmático como para proporcionar continuidad entre las dos API.
¿Cuáles son las principales diferencias entre 1.2 y 2.0 y cómo beneficiarán a los miembros?
Al desarrollar 2.0, queríamos abordar los obstáculos que los miembros han estado encontrando con 1.2 y también presentar una nueva funcionalidad que sabemos que la comunidad quiere.
Por lo tanto, además de abordar problemas conocidos como la escalabilidad en la gestión de publicaciones con hiperautoría y desafíos con comportamiento implícito que estaban causando confusión a los miembros, también hemos agregado una nueva funcionalidad para admitir el reconocimiento de revisión por pares, notificaciones mejoradas para los usuarios y la capacidad de soporta casi cualquier identificador persistente.
Para explicar por qué se necesitaban algunos de estos cambios, me voy a poner un poco técnico. Antes de comenzar a codificar una sola línea nueva, hicimos una lista de cosas que queríamos ver mejoradas, con el siguiente "manifiesto":
- Deja de pensar en el ORCID grabar como un documento monolítico (único grande). Varias instituciones escriben a un ORCID registro significa reconocer que el registro es multiinquilino. Además, los investigadores a menudo producen cantidades tan grandes de investigación que ni siquiera los resúmenes de ellos caben en un documento monolítico.
- Ámbitos simplificados. La granularidad de los alcances de permisos en la API 1.0 es abrumadora para todas las partes involucradas; simplificarlos facilitará la vida tanto a los desarrolladores como a los usuarios.
- Explícito Sosegado comportamiento. Los comportamientos implícitos son malos para los implementadores, ya que conducen a comportamientos inesperados que, a su vez, confunden a los usuarios finales. Al utilizar el comportamiento RESTful, nuestra nueva API evita estos problemas.
- URL razonables más cortas. Un buen ejemplo sería / works / 1234 es mejor que /orcid-obras / 1234.
- Llamadas para listar solo resúmenes de devolución. Para que la llamada a un registro sea más rápida, API 2.0 solo devuelve resúmenes de listas. Hacer una llamada para cada pieza de información sobre un investigador no funciona para artículos con hiperautoría, donde hay decenas, cientos o incluso miles de autores.
- Nombres y estructuras comunes para elementos comunes. 2.0 nos permite asegurarnos de que los elementos comunes en XML / JSON tengan los mismos nombres.
- códigos de error. Ahora incluimos códigos de error en el cuerpo de la respuesta cuando el error no está completamente descrito por un código HTTP estándar.
¿Y cuáles son los beneficios para los usuarios?
Al final del día, una API debería ser perfecta para los usuarios. El comportamiento inesperado de 1.0 surge y afecta la experiencia del usuario y, al mismo tiempo, frustra a los desarrolladores que están implementando la API. En un nivel práctico, la nueva API permite simplificar cada sección en el ORCID registro para proporcionar de forma coherente la aplicación de la configuración de visibilidad, la fuente y la fecha de creación de los elementos de cada sección.
¿Afectará esto también a la API pública? ¿Cómo?
Si. Los cambios en la API de miembros y la API pública siempre están sincronizados. Aunque apreciamos y confiamos en el apoyo de los miembros, también estamos comprometidos con nuestra visión más amplia "de un mundo donde todos los que participan en la investigación, la erudición y la innovación estén identificados y conectados de manera única a sus contribuciones a través de disciplinas, fronteras y tiempo". Vemos la API pública como un medio para ayudar a lograr ese objetivo.
¿Cuáles cree que serán los principales desafíos en el lanzamiento de la nueva versión y qué soporte ORCID estar proporcionando?
El problema más difícil es reservar recursos para hacer el trabajo de actualizar. Para algunas organizaciones, puede ser tan solo un par de días y otras pueden requerir un mes completo. Independientemente del período de tiempo, no tenga miedo de acercarse y pedir ayuda, incluso para un pequeño detalle que está deteniendo su progreso. Documentación completa ya está disponible para miembros.orcid.org y ORCID las organizaciones miembros también pueden contáctenos. Publicando en el Foro de usuarios de API puede ser útil, trayendo comentarios de todos los ORCID comunidad. También creo firmemente en estar directamente disponible, así que siéntete envíeme un correo electrónico directamente.
¿Quién usa actualmente API 2.0 y qué tipo de comentarios han proporcionado?
Ponemos un gran esfuerzo en hacer que los candidatos de lanzamiento estén disponibles para recibir comentarios. CrossRef, Datacite, CERN y PTCRIS son solo algunos de los ORCID miembros que han implementado una versión candidata y han proporcionado comentarios. Además, varias organizaciones han implementado la funcionalidad de revisión por pares utilizando 2.0, incluidos los primeros en adoptar, la American Geophysical Union, F1000 y Publons. La retroalimentación ha incluido las sugerencias habituales de los "técnicos", como los nombres utilizados en el esquema, la nomenclatura de los puntos finales o los debates sobre la eficiencia. Ese tipo de detalles pueden tener grandes implicaciones para los miembros. Sin embargo, los implementadores de los candidatos a la liberación también brindan retroalimentación desde la perspectiva del investigador, lo cual consideramos invaluable.
Cuánto tiempo ORCID ¿Continuar apoyando la antigua API?
Nuestro objetivo es finalizar la versión 1.2 a finales de 2017. Independientemente de la fecha de finalización, si está de acuerdo con ORCIDmisión de y se preocupan por los investigadores interactúan con ORCID querrá pasar a 2.0 ahora.
¿Algo más que debamos saber sobre este cambio?
Esperamos que 2.0 demuestre ser duradero y podamos centrarnos en otras partes del ORCID pila de tecnología por un buen tiempo!
Para obtener un resumen divertido y útil de las características de API 2.0, consulte este conjunto de diapositivas!