Ich werde oft gefragt, wie ORCID schafft es, die Registry kontinuierlich zu aktualisieren, um neue Funktionen hinzuzufügen, unterstützt aber dennoch die vielen Systeme auf Unternehmensebene, die sich im Besitz und unter der Leitung von Microsoft befinden ORCID Mitgliedsorganisationen, die unsere APIs nutzen. Die entscheidende Antwort lautet: Flexibilität. Aber natürlich ist es etwas komplizierter.
Ein wenig Geschichte
Bei unserem ersten Start im Oktober 2012 begannen wir mit der API-Version 1.0.1. (Unser vorheriger Prototyp war Version 1.0.) Wie Sie sich vorstellen können, haben wir in diesem ersten Jahr viele Verbesserungen vorgenommen und wichtige neue Funktionen hinzugefügt, beispielsweise die Möglichkeit, Finanzierung und Zugehörigkeiten mit einem zu verbinden ORCID Aufzeichnen. Bei jeder dieser Verbesserungen haben wir die Abwärtskompatibilität gewahrt, sodass Unternehmen nach Belieben Aktualisierungen durchführen können. Ein Jahr (und 23 Updates!) später stellten wir fest, dass wir 23 Versionen unserer API aktiv unterstützen. Dies erforderte erhebliche Personalressourcen für die Verwaltung und bedeutete, dass wir weniger Zeit hatten, weitere Funktionen und Verbesserungen hinzuzufügen, die unsere Mitglieder und Benutzer wünschten. Schlimmer noch: Fast alle API-Benutzer verwendeten Version 1.0.7 oder früher, was bedeutete, dass sie nicht von den neuen Funktionen profitierten, die wir implementierten und unterstützten. Offensichtlich hat dieser Prozess für niemanden gut funktioniert!
Fokussierung unseres Ansatzes
Im November 2013 haben wir einen Ansatz mit folgenden Zielen entwickelt:
- Halten Sie die Anzahl der gleichzeitig unterstützten APIs für unser kleines Team auf einem überschaubaren Niveau.
- Bieten Sie API-Benutzern bessere Informationen darüber, welche größeren und kleineren API-Updates es gibt.
- Bedienen Sie API-Benutzer, die Zugriff auf die neuesten Updates und Funktionen haben möchten, und diejenigen, die langfristige, unternehmensstabile APIs benötigen.
- Ermöglichen Sie Flexibilität für API-Benutzer, die aktiv auf neuere Versionen migrieren, jedoch zusätzliche Unterstützung oder Zeit für die Umstellung benötigen.
Die Enterprise-Stable-API
Wir veröffentlichen jetzt einmal im Jahr, in der Regel im Januar, eine neue, unternehmensstabile API-Version. Diese Version enthält alle neuen Funktionen, Updates und Verbesserungen des Vorjahres.
- Obwohl die vorherige unternehmensstabile Version noch funktionsfähig ist, gilt sie als „veraltet“.
- API-Benutzer werden drei bis sechs Monate vor dem Ablaufdatum über die Unterschiede zwischen den beiden Versionen informiert und erhalten Dokumentation und Unterstützung für die Aktualisierung ihres Systems. Wir informieren auch unsere technischen Ansprechpartner, die eine Integration mit der Mitglieder-API erstellt haben.
- Nach einer gewissen Zeit wird die alte Version nicht mehr aktiv unterstützt. Irgendwann wird die alte Version nicht mehr funktionieren.
- Die Zeitspanne, in der beide Versionen aktiv unterstützt werden, hängt vom Umfang der Änderungen und dem Aufwand für ein Update ab.
- Wir fühlen uns unseren Mitgliedern verpflichtet. Wir stellen IMMER sicher, dass die Migration auf die neue Version erfolgreich war, bevor wir den Support für eine veraltete API-Version einstellen.
Die Innovation API
Für unsere Mitglieder, die früher auf neue Funktionen und Verbesserungen zugreifen möchten, stellen wir häufiger Release Candidate-APIs bereit, die die neuesten Innovationen enthalten.
- Diese Versionen bieten einen frühen Überblick über die Updates, die voraussichtlich in der nächsten unternehmensstabilen Version enthalten sein werden.
- Sie umfassen Funktionen, die wir testen, und ermöglichen API-Benutzern, neue Funktionen früher auszuprobieren.
- Release-Kandidaten werden im Allgemeinen nicht unterstützt und verfügen nur über eine begrenzte Dokumentation. Der ORCID Das Entwicklungsteam ist sehr daran interessiert, mit Mitgliedern zusammenzuarbeiten, die Release-Kandidaten verwenden, um die vorläufige Funktionalität zu verbessern.
Einzelheiten zu aktuellen Versionen, Änderungsterminen und mehr finden Sie in unserem Versionsdokumentation. Wir empfehlen außerdem, dass jeder, der die API nutzt, Mitglied der wird API-Benutzergruppe Hier teilen wir die neuesten Informationen zu den APIs.