A menudo me preguntan cómo ORCID se las arregla para actualizar continuamente el Registro para agregar nuevas funciones, pero aún así es compatible con los muchos sistemas de nivel empresarial propiedad y operados por ORCID Organizaciones miembro que utilizan nuestras API. La respuesta fundamental es la flexibilidad. Pero, por supuesto, es un poco más complicado que eso.
Una pequeña historia
Cuando lo lanzamos por primera vez en octubre de 2012, comenzamos con la versión 1.0.1 de API. (Nuestro prototipo anterior era la versión 1.0). Como puede imaginar, durante ese primer año hicimos muchas mejoras y agregamos nuevas funciones importantes, como la capacidad de conectar fondos y afiliaciones a un ORCID Registro. Para cada una de estas mejoras, mantuvimos la compatibilidad con versiones anteriores, lo que permitió a las organizaciones actualizarse cuando lo deseen. Un año (¡y 23 actualizaciones!) Después, descubrimos que estábamos apoyando activamente 23 versiones de nuestra API. Esto requirió recursos de personal sustanciales para administrar, y significó que tuviéramos menos tiempo para agregar más características y mejoras que nuestros miembros y usuarios buscaban. Peor aún, casi todos los usuarios de API usaban la versión 1.0.7 o anterior, lo que significa que no se estaban beneficiando de las nuevas funciones que estábamos implementando y respaldando. ¡Claramente este proceso no estaba funcionando bien para nadie!
Centrando nuestro enfoque
En noviembre de 2013 desarrollamos un enfoque con los siguientes objetivos:
- Mantenga la cantidad de API compatibles simultáneamente a un nivel manejable para nuestro pequeño equipo.
- Proporcione mejor información a los usuarios de la API sobre cuáles son las actualizaciones principales y secundarias de la API.
- Sirva a los usuarios de API que deseen tener acceso a las últimas actualizaciones y funcionalidades, y a aquellos que requieran API estables para empresas y con un horizonte más largo.
- Habilite la flexibilidad para los usuarios de API que están migrando activamente a versiones más nuevas, aunque necesitan soporte adicional o tiempo para la transición.
La API empresarial estable
Ahora lanzamos una nueva versión de API estable para empresas una vez al año, generalmente en enero. Esta versión incluye todas las nuevas funciones, actualizaciones y mejoras del año anterior.
- Si bien la versión empresarial estable anterior sigue siendo funcional, se considera "obsoleta".
- A los usuarios de la API se les informa de 3 a 6 meses antes de la fecha de finalización de las diferencias entre las dos versiones, y se les proporciona documentación y soporte para actualizar su sistema. También proporcionamos un aviso a nuestros contactos técnicos que han construido una integración con la API miembro.
- Después de un período de tiempo, la versión anterior se “caduca”, después del cual ya no se admite activamente. Eventualmente, la versión anterior dejará de funcionar.
- La cantidad de tiempo durante el cual ambas versiones reciben soporte activo varía según el alcance de los cambios y el esfuerzo requerido para realizar una actualización.
- Estamos comprometidos con nuestros miembros. SIEMPRE nos aseguramos de que hayan migrado correctamente a la nueva versión antes de interrumpir el soporte para una versión de API obsoleta.
La API de innovación
Para nuestros miembros que deseen acceder antes a nuevas funciones y mejoras, proporcionamos API candidatas a versiones más frecuentes que incluyen las últimas innovaciones.
- Estas versiones brindan una vista preliminar de las actualizaciones que probablemente se realizarán en la próxima versión estable para empresas.
- Incluyen funciones que estamos probando y permiten a los usuarios de API probar nuevas funciones antes.
- Los candidatos a la liberación generalmente no cuentan con respaldo y tienen documentación limitada. los ORCID El equipo de desarrollo está muy interesado en trabajar en colaboración con los miembros que utilizan candidatos de lanzamiento para mejorar la funcionalidad provisional.
Proporcionamos detalles sobre las versiones actuales, las fechas en las que se están produciendo cambios y más en nuestro documentación de la versión. También recomendamos que cualquier persona que utilice la API se convierta en miembro de la Grupo de usuarios de API donde compartimos la información más reciente sobre las API.