ORCID tiene como objetivo admitir 2 versiones principales de API a la vez. Cuando se lanza una nueva versión principal de la API, ORCID garantiza soporte durante al menos tres años a partir de la fecha de lanzamiento. Además, notificamos con 12 meses de anticipación antes de retirar la versión principal más antigua y enviamos correos electrónicos de recordatorio periódicos a los miembros que aún la usan durante el período de notificación. Se requieren nuevas versiones principales cada vez que realizamos cambios importantes en nuestro esquema de metadatos y se indican mediante un incremento en el número de versión principal. ORCID lanza una nueva versión principal de API cada 2 a 4 años.
En circunstancias excepcionales, ORCID puede considerar extender el período de retiro de 12 meses cuando se lance una nueva versión principal de API, pero esto requiere ORCID invertir recursos adicionales en trabajos de mantenimiento, con un impacto consecuente en otras actividades como nuevos desarrollos y soporte. ORCID se reserva el derecho de cobrar tarifas adicionales por el uso continuo de una versión de API retirada más allá de la fecha de retiro para ayudar a compensar los costos adicionales incurridos.
ORCID tiene una política de desaprobación de API incremental que nos permite evolucionar nuestras ofertas de API y responder a las necesidades de la comunidad entre lanzamientos importantes. Esto significa que ORCID puede realizar cambios constantes en los campos de metadatos y vocabularios controlados de la versión actual de la API.
- Los usuarios de la versión más reciente de la API pueden ignorar estos cambios, pero deben tener en cuenta que podrían realizarse
- Los usuarios de la versión anterior de la API no recibirán datos que no se puedan modelar en su versión.
Un ejemplo en el momento de escribir este artículo es la introducción de la taxonomía de roles de contribuyente CREDIT en la API v3.0. Una vez en vivo, las integraciones v2.x perderán lentamente la visibilidad de los roles de los contribuyentes a medida que más y más investigadores e integraciones adopten CREDIT. Los usuarios de V2.x no se romperán, pero recibirán metadatos menos ricos a medida que pase el tiempo.
Al desarrollar una nueva versión principal de la API, es normal que ORCID para producir versiones 'candidatas a lanzamiento'. Estos están dirigidos a integradores que pueden actualizar de manera oportuna una vez que se lanza la versión completa de la API. La vida útil esperada de un candidato de lanzamiento es como máximo de 12 meses a partir del lanzamiento de la versión principal para la que fue desarrollado.
Aconsejamos a los integradores que sigan las Principio de robustez (también conocida como la ley de Postel) al hacer uso de la ORCID API.
Antecedentes
ORCID ha evolucionado lentamente su API desde sus humildes comienzos.
API v1.x (Lanzamiento ~ 2012 junto con el registro) intentó devolver todos los metadatos sobre los investigadores y sus actividades en una única respuesta de API. Los integradores debían modificar estos metadatos y devolverlos en su totalidad para agregar nuevos elementos o actualizar los existentes. Este fue un primer intento razonable, pero no se amplió y hacer adiciones y actualizaciones fue una tarea dolorosa. (Retirado en marzo de 2018)
API 2.x (lanzada en febrero de 2017) divide nuestra API en secciones; trabajos, afiliaciones, financiación, biografía, etc. Fue un gran paso adelante y nos permitió tanto a nosotros como a nuestros clientes gestionar grandes registros mucho más fácilmente. Sin embargo, gran parte de nuestra validación y vocabularios controlados estaban codificados en el esquema, lo que dificulta la respuesta al cambio.
API 3.x (publicada en mayo de 2019) agregó nuevas secciones al registro, como recursos de investigación, simplificó la estructura del esquema y proporcionó ORCID con flexibilidad adicional. Movió gran parte de la validación del esquema a nuestros servidores, lo que nos ha permitido solucionar problemas y agregar nuevos tipos de identificadores sin lanzar más versiones de la API.
Lanzar una nueva API importante es una empresa enorme: se requieren años de esfuerzo de los desarrolladores para crearla, y nuestros miembros necesitan años más para actualizar sus integraciones. Por eso intentamos limitar los cambios que realizamos. Sin embargo, hay algunos cambios que nos gustaría hacer para servir mejor a la comunidad.
Nuestro trabajo es determinar cuándo tenemos una masa crítica para lanzar una nueva versión de la API, o encontrar formas de actualizar nuestras API existentes sin romper las integraciones existentes.