Lipiec wyznacza piąty miesiąc odkąd wypuściliśmy ORCID API wersja 2.0i z przyjemnością informujemy, że wielu użytkowników publicznego i członkowskiego interfejsu API już dokonało aktualizacji lub jest w trakcie jej przeprowadzania. Aby zachęcić tych z Was, którzy jeszcze nie rozpoczęli aktualizacji, chcielibyśmy podkreślić niektóre funkcje wersji 2.0 które uprości przepływy pracy, zmniejszy rozmiary przesyłanych plików i sprawi, że Twoje ORCID integracja działa lepiej zarówno dla Ciebie, jak i dla Twoich użytkowników.
Mniej zakresów, mniej zamieszania
Nasz stary interfejs API umożliwiał wiele żądań uprawnienia od użytkowników: uprawnienie do tworzenia elementów w sekcji, czytania tej samej sekcji i aktualizowania jej. Żądanie oddzielnych uprawnień dla każdej sekcji zaowocowało listą próśb, które dezorientowały użytkowników.
W API v2.0 mamy skonsolidowaliśmy nasze zakresy na trzy, które umożliwiają żądanie odczytu (ograniczonego) i aktualizacji dostępu do wszystkich sekcji ORCID rekord.
Nadal masz te tokeny na starszych uprawnieniach? Nie martw się – będą nadal działać na poziomach dostępu, dla których zostały pierwotnie wydane. Ale możesz chcieć zbudować przepływ pracy, aby zażądać od użytkowników odświeżenia swoich uprawnień, jeśli zaktualizowany system ma nowe funkcje obejmujące dostęp do innych sekcji ich rekordu.
Czytaj i aktualizuj według pozycji
Używając poprzednich wersji API, jeśli twój system musiał dodać nową pojedynczą pracę do rekordu, do którego dodałeś wiele prac, musiał zaktualizować całą sekcję prac, w tym nową pracę i wszystkie wcześniej dodane prace. W rezultacie aktualizacja pojedynczej pozycji w rekordzie wiązała się z wysłaniem potencjalnie dużego pliku innych pozycji, które nie miały żadnych zmian, lub utratą wszystkich pozycji w tej sekcji, a nawet całego rekordu.
Wersja 2.0 uprościła ten proces poprzez zarządzanie artykułami na zasadzie indywidualnej. Twój system może dodać pojedynczą pracę do ORCID rekord, a następnie edytuj lub usuń tę pojedynczą pracę. Odbywa się to poprzez wdrożenie wstaw kody dla poszczególnych pozycji na ORCID Rejestr. Na przykład, jeśli twój system doda nowe przynależność pracowniczą do pliku ORCID zapis, ew ORCID Interfejs API zwraca komunikat potwierdzający wraz z kodem, którego system może użyć do aktualizacji lub usunięcia tylko tego elementu. Ogólnie rzecz biorąc, tylko jeden element można dodawać, edytować lub usuwać naraz ORCID rekord. Jedynym wyjątkiem są prace, które dla wielu badaczy stanowią większość ich badań ORCID nagrywać. API v2.0 umożliwia Twoim systemom przeczytaj do 50 prac na raz i do dodać do 100 prac na czas. Edycja lub usuwanie prac nadal musi odbywać się na podstawie pozycji.
Kody put działają wstecz: wszystkim elementom dodanym w wersji 1.2 i wcześniejszych zostały przypisane kody put. Pracując nad uaktualnieniem systemu do wersji 2.0, pamiętaj o dodaniu pola na odpowiadający mu kod put. Możesz zapytać o ORCID record, aby uzyskać kody wprowadzania wszelkich elementów dodanych przez system do Rejestru i odpowiednio zaktualizować bazę danych, aby móc je aktualizować w przyszłości w razie potrzeby.
Czytaj rekordy szybciej
API v2.0, podobnie jak poprzednie API, umożliwia systemowi przeczytać pojedynczą sekcję lub cały zapis w jednym wywołaniu. To, co zwróci, to nie wszystkie dane w rekordzie, ale raczej widok podsumowania trzech sekcji, które są zwykle największe ORCID rekordy: prace, finansowanie i wzajemne recenzje.
Niezależnie od tego, czy system odczytuje cały rekord, czy pojedynczą sekcję, plik widok podsumowania tych czynności jest wyświetlany. Podsumowanie zawiera ograniczone informacje: na przykład podsumowanie prac zwraca tylko tytuł pracy, rodzaj, datę, jej unikalne identyfikatory i ich związek z pracą, indeks wyświetlania dla każdej wersji pozycji (jeśli istnieje wiele wersji), źródło (użytkownik lub klient API) i odpowiedni kod put dla każdej wersji elementu.
Widoki podsumowujące zmniejszają rozmiary plików i skracają czas przesyłania, zmniejszając potencjalne obciążenie naszego i Twojego systemu oraz przyspieszając aktualizacje.
I o wiele więcej!
W wersji 2.0 jest o wiele więcej powodów do radości: elastyczna obsługa zewnętrznych identyfikatorów, dodawanie działań związanych z recenzowaniem, bardziej przejrzyste grupowanie wielu wersji działań, domyślnie lepsze wyniki wyszukiwania i nie tylko.
Chcesz dowiedzieć się więcej? Dołącz do nas! Co miesiąc organizujemy seminaria internetowe w wielu strefach czasowych i językach, a przez resztę roku będziemy omawiać aktualizację do API v2.0. Sprawdź nasze aukcje dla następnegolub skontaktuj się z nami uczyć się więcej.
Czy zaktualizowałeś już API do wersji 2.0? Daj nam znać o swoich doświadczeniach!