ORCID mira a supportare 2 principali versioni API alla volta. Quando viene rilasciata una nuova versione principale dell'API, ORCID garantisce il supporto per almeno tre anni dalla data di rilascio. Inoltre, diamo un preavviso di 12 mesi prima di ritirare la versione principale più vecchia e inviamo e-mail di promemoria periodiche ai membri che la utilizzano ancora durante il periodo di preavviso. Sono necessarie nuove versioni principali ogni volta che apportiamo modifiche sostanziali al nostro schema di metadati e sono indicate da un incremento nel numero della versione principale. ORCID rilascia una nuova versione principale dell'API ogni 2-4 anni.
In circostanze eccezionali, ORCID potrebbe prendere in considerazione l'estensione del periodo di ritiro di 12 mesi quando viene rilasciata una nuova versione principale dell'API, ma ciò richiede ORCID di investire risorse aggiuntive in lavori di manutenzione, con un conseguente impatto su altre attività come nuovo sviluppo e supporto. ORCID si riserva il diritto di addebitare costi aggiuntivi per l'uso continuato di una versione API ritirata oltre la data di ritiro al fine di contribuire a compensare i costi aggiuntivi sostenuti.
ORCID ha una politica di deprecazione dell'API incrementale che ci consente di evolvere le nostre offerte di API e rispondere alle esigenze della comunità tra le versioni principali. Ciò significa che ORCID può apportare modifiche continue ai vocabolari controllati della versione API corrente e ai campi di metadati.
- Gli utenti della versione API più recente sono liberi di ignorare queste modifiche, ma devono essere consapevoli che potrebbero essere apportate
- Gli utenti della versione precedente dell'API non riceveranno dati che non possono essere modellati nella loro versione
Un esempio al momento in cui scriviamo è l'introduzione della tassonomia del ruolo di contributore CREDIT nell'API v3.0. Una volta attive, le integrazioni v2.x perderanno lentamente la visibilità dei ruoli dei contributori man mano che sempre più ricercatori e integrazioni adottano CREDIT. Gli utenti V2.x non si interrompono, ma riceveranno metadati meno ricchi con il passare del tempo.
Quando si sviluppa una nuova versione principale dell'API è normale che ORCID per produrre versioni 'release candidate'. Questi sono rivolti agli integratori che sono in grado di eseguire l'aggiornamento in modo tempestivo una volta rilasciata la versione completa dell'API. La durata prevista di un candidato al rilascio è al massimo 12 mesi dal rilascio della versione principale per cui è stato sviluppato.
Consigliamo agli integratori di seguire il Principio di robustezza (nota anche come legge di Postel) quando si fa uso del ORCID API.
sfondo
ORCID ha lentamente evoluto la sua API dai suoi umili inizi.
L'API v1.x (Launch ~2012 insieme al registro) ha tentato di restituire tutti i metadati sui ricercatori e le loro attività in un'unica risposta API. Agli integratori è stato richiesto di modificare questi metadati e di rispedirli nella loro interezza per aggiungere nuovi elementi o aggiornare quelli esistenti. Questo è stato un primo tentativo ragionevole, ma non è stato scalato e fare aggiunte e aggiornamenti è stato un compito doloroso. (ritirato a marzo 2018)
L'API 2.x (rilasciata a febbraio 2017) divide la nostra API in sezioni; lavori, affiliazioni, finanziamenti, biografia ecc. È stato un grande passo avanti e ha permesso a noi stessi e ai nostri clienti di gestire in modo molto più semplice record di grandi dimensioni. Tuttavia, gran parte dei nostri vocabolari di convalida e controllati erano codificati nello schema, rendendo difficile rispondere al cambiamento
API 3.x (rilasciato a maggio 2019) ha aggiunto nuove sezioni al record come risorse di ricerca, semplificato la struttura dello schema e fornito ORCID con ulteriore flessibilità. Ha spostato gran parte della convalida dallo schema ai nostri server, il che ci ha permesso di risolvere i problemi e aggiungere nuovi tipi di identificatori senza rilasciare ulteriori versioni dell'API.
Il rilascio di una nuova importante API è un'impresa enorme: sono necessari anni di sforzi da parte degli sviluppatori per crearla e altri anni sono richiesti dai nostri membri per aggiornare le loro integrazioni. Per questo motivo cerchiamo di limitare le modifiche che apportiamo. Tuttavia, ci sono alcune modifiche che vorremmo apportare per servire al meglio la comunità.
Il nostro compito è capire quando abbiamo una massa critica per rilasciare una nuova versione dell'API o trovare modi per aggiornare le nostre API esistenti senza interrompere le integrazioni esistenti.