Spesso mi chiedono come ORCID riesce ad aggiornare continuamente il Registro per aggiungere nuove funzionalità, ma continua a supportare i numerosi sistemi di livello aziendale di proprietà e gestiti da ORCID Organizzazioni membri che utilizzano le nostre API. La risposta di fondo è la flessibilità. Ma, ovviamente, è un po' più complicato di così.
Un po 'di storia
Quando siamo stati lanciati per la prima volta nell'ottobre 2012 abbiamo iniziato con la versione API 1.0.1. (Il nostro prototipo precedente era la versione 1.0.) Come puoi immaginare, durante quel primo anno abbiamo apportato molti miglioramenti e aggiunto nuove importanti funzionalità, come la possibilità di collegare finanziamenti e affiliazioni a un ORCID Disco. Per ciascuno di questi miglioramenti abbiamo mantenuto la compatibilità con le versioni precedenti, consentendo alle organizzazioni di aggiornare a loro piacimento. Un anno (e 23 aggiornamenti!) dopo, abbiamo scoperto che stavamo supportando attivamente 23 versioni della nostra API. Ciò ha richiesto notevoli risorse di personale da gestire e ha significato meno tempo per aggiungere più funzionalità e miglioramenti che i nostri membri e utenti cercavano. Peggio ancora, quasi tutti gli utenti API utilizzavano la versione 1.0.7 o precedente, il che significa che non stavano beneficiando delle nuove funzionalità che stavamo implementando e supportando. Chiaramente questo processo non funzionava bene per nessuno!
Focalizzare il nostro approccio
A novembre 2013 abbiamo sviluppato un approccio con i seguenti obiettivi:
- Mantieni il numero di API supportate contemporaneamente a un livello gestibile per il nostro piccolo team.
- Fornisci migliori informazioni agli utenti API su quali sono gli aggiornamenti API principali e secondari.
- Servi gli utenti API che desiderano avere accesso agli aggiornamenti e alle funzionalità più recenti e coloro che richiedono API stabili per l'azienda con orizzonte più lungo.
- Consenti flessibilità per gli utenti API che stanno migrando attivamente a versioni più recenti, anche se necessitano di ulteriore supporto o tempo per la transizione.
L'API Enterprise-Stable
Ora rilasciamo una nuova versione dell'API aziendale stabile una volta all'anno, generalmente a gennaio. Questa versione include tutte le nuove funzionalità, aggiornamenti e miglioramenti rispetto all'anno precedente.
- Sebbene la precedente versione stabile per le aziende sia ancora funzionante, è considerata "deprecata".
- Gli utenti API vengono informati 3-6 mesi prima della data di scadenza delle differenze tra le due versioni e ricevono documentazione e supporto per aggiornare il proprio sistema. Forniamo anche un avviso ai nostri contatti tecnici che hanno creato un'integrazione con l'API membro.
- Dopo un periodo di tempo, la vecchia versione è "tramonto", dopo di che non è più supportata attivamente. Alla fine la vecchia versione non funzionerà più.
- La quantità di tempo in cui entrambe le versioni sono attivamente supportate varia a seconda dell'entità delle modifiche e dello sforzo richiesto per effettuare un aggiornamento.
- Ci impegniamo per i nostri membri. Ci assicuriamo SEMPRE che siano migrati correttamente alla nuova versione prima di interrompere il supporto per una versione API deprecata.
L'API dell'innovazione
Per i nostri membri che desiderano un accesso anticipato a nuove funzionalità e miglioramenti, forniamo API candidate al rilascio più frequenti che includono le ultime innovazioni.
- Queste versioni forniscono una visione anticipata degli aggiornamenti probabilmente nella prossima versione stabile per le aziende.
- Includono funzionalità che stiamo testando e consentono agli utenti API di provare nuove funzionalità in precedenza.
- Le release candidate sono generalmente non supportate e hanno una documentazione limitata. Il ORCID il team di sviluppo è molto interessato a lavorare in modo collaborativo con i membri utilizzando i candidati al rilascio per migliorare la funzionalità provvisoria.
Forniamo dettagli sulle versioni correnti, le date in cui si verificano i cambiamenti e altro ancora nel nostro documentazione della versione. Raccomandiamo inoltre che chiunque utilizzi l'API diventi membro del Gruppo utenti API dove condividiamo le informazioni più recenti sulle API.