Często jestem pytany jak ORCID udaje się stale aktualizować Rejestr w celu dodania nowych funkcji, ale nadal obsługuje wiele systemów na poziomie przedsiębiorstwa, których właścicielem i operatorem jest ORCID Organizacje członkowskie korzystające z naszych interfejsów API. Podstawową odpowiedzią jest elastyczność. Ale, oczywiście, to trochę bardziej zaangażowane niż to.
Trochę historii
Kiedy po raz pierwszy uruchomiliśmy w październiku 2012 r., zaczęliśmy od interfejsu API w wersji 1.0.1. (Naszym wcześniejszym prototypem była wersja 1.0.) Jak możesz sobie wyobrazić, w ciągu pierwszego roku wprowadziliśmy wiele ulepszeń i dodaliśmy ważne nowe funkcje, takie jak możliwość łączenia funduszy i powiązań z ORCID Nagrywać. Dla każdego z tych ulepszeń zachowaliśmy kompatybilność wsteczną, umożliwiając organizacjom aktualizację w czasie wolnym. Rok (i 23 aktualizacje!) później odkryliśmy, że aktywnie wspieramy 23 wersje naszego API. Wymagało to znacznych zasobów personelu do zarządzania i oznaczało, że mieliśmy mniej czasu na dodanie większej liczby funkcji i ulepszeń, których poszukiwali nasi członkowie i użytkownicy. Co gorsza, prawie wszyscy użytkownicy API korzystali z wersji 1.0.7 lub wcześniejszej, co oznaczało, że nie korzystali z nowych funkcji, które wdrażaliśmy i wspieraliśmy. Najwyraźniej ten proces nie działał dobrze dla nikogo!
Skupienie naszego podejścia
W listopadzie 2013 roku opracowaliśmy podejście, które ma następujące cele:
- Utrzymuj liczbę jednocześnie obsługiwanych interfejsów API na poziomie możliwym do zarządzania przez nasz mały zespół.
- Zapewnij użytkownikom API lepsze informacje o głównych i mniejszych aktualizacjach API.
- Obsługuj użytkowników API, którzy chcieliby mieć dostęp do najnowszych aktualizacji i funkcjonalności, oraz tych, którzy potrzebują długoterminowych, stabilnych API w przedsiębiorstwie.
- Zapewnij elastyczność użytkownikom API, którzy aktywnie migrują do nowszych wersji, ale potrzebują dodatkowego wsparcia lub czasu na przejście.
Interfejs API stabilny w przedsiębiorstwie
Teraz wydajemy nową, stabilną dla przedsiębiorstw wersję interfejsu API raz w roku, zazwyczaj w styczniu. Ta wersja zawiera wszystkie nowe funkcje, aktualizacje i ulepszenia z poprzedniego roku.
- Chociaż poprzednia wersja stabilna dla przedsiębiorstw nadal działa, jest uważana za „przestarzałą”.
- Użytkownicy interfejsu API są informowani na 3–6 miesięcy przed datą ostateczną o różnicach między dwiema wersjami oraz otrzymują dokumentację i wsparcie w zakresie aktualizacji systemu. Wysyłamy również powiadomienie do naszych kontaktów technicznych, które zbudowały integrację z interfejsem API członka.
- Po pewnym czasie stara wersja „zachodzi”, po czym nie jest już aktywnie obsługiwana. W końcu stara wersja przestanie działać.
- Czas, przez jaki obie wersje są aktywnie obsługiwane, różni się w zależności od zakresu zmian i nakładu pracy wymaganego do przeprowadzenia aktualizacji.
- Jesteśmy oddani naszym członkom. ZAWSZE zapewniamy pomyślną migrację do nowej wersji, zanim zaprzestaniemy obsługi wycofanej wersji API.
API innowacji
Dla naszych członków, którzy chcą mieć wcześniejszy dostęp do nowych funkcji i ulepszeń, zapewniamy częstsze udostępnianie kandydujących interfejsów API, które obejmują najnowsze innowacje.
- Wersje te zapewniają wczesny widok aktualizacji, które prawdopodobnie pojawią się w następnej wersji stabilnej dla przedsiębiorstw.
- Obejmują one testowane przez nas funkcjonalności i umożliwiają użytkownikom API wcześniejsze wypróbowanie nowych funkcjonalności.
- Kandydaci do wydania są na ogół nieobsługiwani i mają ograniczoną dokumentację. The ORCID zespół programistów jest bardzo zainteresowany współpracą z członkami przy użyciu kandydatów do wydania w celu ulepszenia tymczasowej funkcjonalności.
Podajemy szczegółowe informacje o aktualnych wersjach, datach wprowadzenia zmian i więcej w naszym dokumentacja wersji. Zalecamy również, aby każda osoba korzystająca z API została członkiem Grupa użytkowników API gdzie udostępniamy najnowsze informacje o interfejsach API.