ORCID oferuje kilka interfejsów API, które umożliwiają systemom łączenie się z ORCID rejestru, w tym odczyt i zapis do ORCID dokumentacja. Niektóre funkcje API są swobodnie dostępne dla każdego (Publiczny interfejs API); inne są dostępne tylko dla ORCID organizacje członkowskie (Interfejs API członka i członka Premium). Każdy może przetestować dowolne z naszych interfejsów API na naszym serwerze testowym piaskownicy.
Zanim zaczniesz
Rozpoczynając planowanie integracji, należy wziąć pod uwagę:
- Co chcesz zrobić z ORCID API — odwiedź naszą przepływów pracy.
- Niezależnie od tego, czy Twoja organizacja jest już ORCID członek lub jest planuje zostać jednym. Tylko ORCID członkowie mogą dodawać elementy do ORCID Records.
- Niezależnie od tego, czy używasz systemu, który już obsługuje ORCID. Jeśli tak, może to być tak proste, jak skonfigurowanie systemu do pracy ORCID.
- W jaki sposób będziesz komunikować się ze swoimi badaczami na temat wprowadzanych zmian, czego będziesz od nich potrzebować, korzyści dla nich i tego, co będą musieli zrobić. Odwiedź nasze Zasoby informacyjne stronę z pomysłami, jak zbudować kampanię komunikacyjną wokół nowej integracji.
Zarejestruj się, aby uzyskać poświadczenia piaskownicy i utwórz test ORCID iD
Wymagamy, abyś najpierw zbudował narzędzia, które wchodzą w interakcję z dotychczasowy ORCID piaskownica aby zapobiec wpływowi na jakiekolwiek dane w rejestrze produkcyjnym podczas testowania — lub na własne systemy.
Możesz zażądać poświadczeń interfejsu użytkownika piaskownicy zbudować i przetestować swoją aplikację. Te poświadczenia umożliwiają wykonywanie wywołań do interfejsu API członka piaskownicy w celu odczytu, zapisu i aktualizacji ORCID dokumentacja. Dostęp do środowiska testowego piaskownicy jest bezpłatny dla każdego, nawet jeśli nie jesteś ekspertem ORCID organizacja członkowska.
Note: Jeśli korzystasz z systemu innej firmy, który już obsługuje ORCID, rejestracja w celu uzyskania poświadczeń interfejsu API piaskownicy może nie być konieczna.
Piaskownica umożliwia tworzenie testowych kont użytkowników i rozwijanie integracji bez martwienia się o wpływ na dane na żywo (produkcyjne) ORCID Rejestr. Piaskownica zachowuje się tak samo jak produkcja ORCID Rejestr z kilka wyjątków.
Tworzenie konta testowego
W celu przetestowania ORCID Wywołania API i API, takie jak odczytywanie i dodawanie informacji do pliku ORCID rekordu, konieczne będzie również utworzenie testu ORCID nagrywać w piaskownicy. Można to zrobić za pomocą interfejsu użytkownika, podobnie jak na produkcji ORCID Rejestr. Iść do https://sandbox.orcid.org/register i załóż konto.
Adresy e-mail Mailinatora
Serwer piaskownicy wysyła wiadomości e-mail z powiadomieniami tylko do Mailinator (@mailinator.com) adresy e-mail, aby nieumyślnie nie spamować serwerów pocztowych. Nie otrzymasz e-maila weryfikacyjnego ani powiadomienia o zresetowaniu hasła, chyba że użyjesz adresu @mailinator.com, a weryfikacja jest wymagana w celu ręcznego edytowania rekordów piaskownicy. Dowiedz się więcej o ich bezpłatnych publicznych skrzynkach odbiorczych tutaj. Jeśli nie chcesz używać A Mailinator adres, a następnie zanotuj swoją nazwę użytkownika i hasło (ponieważ będziesz ich używać do autoryzacji aplikacji podczas testowania) i skontaktuj się z nami, aby poprosić o pomoc w weryfikacji.
Mailinator to usługa e-mail, która ma publiczną bezpłatną usługę i prywatną płatną usługę. Do testowania możesz skorzystać z całkowicie bezpłatnej usługi publicznej. Dowiedz się więcej o ich progach tutaj.
Mailinator to usługa strony trzeciej, która nie jest zarządzana ani utrzymywana przez firmę ORCID. Zalecamy zapoznanie się z działaniem tej usługi i jej ograniczeniami przed użyciem tych adresów.
Określ uprawnienia użytkownika, których będziesz potrzebować
Połączenia ORCID Interfejs API członka może służyć do odczytywania, dodawania lub aktualizowania informacji o użytkowniku ORCID rekord — wystarczy poprosić o pozwolenie swoich badaczy. Zakresy, których potrzebujesz, będą miały duży wpływ na to, który interfejs API najlepiej pasuje do Twojego systemu.
Prosząc o pozwolenie na interakcję z ORCID rekordu użytkownika, określasz jeden lub więcej „zakresów”. Każdy zakres umożliwia wykonywanie określonych czynności, takich jak odczytywanie rekordu lub aktualizowanie określonej sekcji.
3 nogi odnosi się do trzech podmiotów zaangażowanych w uzyskiwanie pozwolenia od użytkownika; ORCID, Twój system i samego użytkownika.
/uwierzytelniać
Ten zakres służy do zbierania ORCID iD i czytać informacje publiczne tylko z protokołu. Wszystkie pozostałe trójetapowe zakresy obejmują uprawnienie do uwierzytelniania, więc ten zakres można pominąć, jeśli poprosimy o inny dostęp. Ten zakres jest dostępny w członkowskim lub publicznym interfejsie API.
/read-limited (tylko Member API)
Ten zakres służy do uzyskiwania dostępu do odczytu elementów publicznych i elementów o ograniczonej widoczności w pliku ORCID nagrywać. Ten zakres jest dostępny tylko w interfejsie Member API.
/activities/update (tylko Member API)
Ten zakres jest używany do zapisywania, aktualizowania i usuwania pozycji w sekcjach afiliacji, finansowania, prac i zasobów badawczych oraz sekcji recenzowania ORCID nagrywać. Ten zakres jest dostępny tylko w interfejsie Member API.
/person/update (tylko Member API)
Ten zakres służy do zapisywania, aktualizowania i usuwania elementów w sekcjach rekordu: inne nazwy, słowa kluczowe, kraje, adresy URL badaczy, strony internetowe i osobiste identyfikatory zewnętrzne. Ten zakres jest dostępny tylko w interfejsie Member API.
otwórzid
Ten zakres jest używany przez integratorów OpenID, gdy wymagany jest id_token. Gdy uwzględniony jest zakres openid, Rejestr zwróci id_token w odpowiedzi tokena i udzieli klientowi pozwolenia na dostęp do punktu końcowego informacji o użytkowniku dla tego użytkownika. Ten zakres jest dostępny w interfejsie API publicznym i członkowskim.
Należy pamiętać, że zakres „openid” nie zaczyna się od „/”, jak inne ORCID zakresy API. Dzieje się tak, ponieważ zakres „openid” nie jest zdefiniowany przez ORCID, ale zamiast tego zdefiniowane przez specyfikację OpenID Connect. Proszę zobaczyć nasze Dokumentacja OpenID po więcej informacji.
Wiele zakresów
W jednej interakcji można zażądać wielu zakresów, wymieniając zakresy w adresie URL uwierzytelniania z zakodowaną spacją między nimi, na przykład scope=/read-limited%20/activities/update%20/person/update
Pełny dostęp
Jeśli chcesz mieć pełny dostęp do odczytu i edytowania rekordu, uwzględnij trzy zakresy w adresie URL uwierzytelniania: /read-limited, /activities/update i /person/update. W adresie URL pojawią się one jako scope=/read-limited%20/activities/update%20/person/update
Zakresy dwuetapowe (poświadczenia klienta).
W przypadku niektórych czynności nie trzeba pytać użytkownika o zgodę. Dwuetapowe zakresy uwierzytelniania OAuth są wymagane bezpośrednio z usługi ORCID API i nie wymagają od badacza udzielenia pozwolenia. Tokeny z tymi zakresami są ważne przez 20 lat i mogą być ponownie wykorzystane
/odczyt-publiczny
Zakres ten służy do odczytywania informacji publicznych na temat pojedynczego ORCID iD lub szukaj ORCID dokumentacja. Ten zakres jest dostępny w członkowskim lub publicznym interfejsie API.
/ webhook
Ten zakres umożliwia aplikacji klienckiej zarejestrowanie elementu webhook na ORCID rekord, aby otrzymywać powiadomienia o aktualizacji rekordu. Ten zakres jest dostępny w wersji premium ORCID tylko członkowie. Jeśli nie jesteś członkiem premium, ale chcesz przetestować tę funkcję w Developer's Sandbox, proszę skontaktuj się ORCID Społeczność.
- W przeszłości ORCID obsługiwane inne zakresy, które były teraz wycofano.
- Możesz się dowiedzieć które zakresy są wymagane, aby dodać lub zaktualizować określone sekcje tutaj.
Upewnij się, że możesz bezpiecznie przechowywać dane
Ważne jest, aby system mógł przechowywać informacje w bezpieczny sposób.
Integracje muszą przechowywać więcej niż tylko ORCID dokumentacja. Twój system będzie musiał być w stanie:
- Akceptuj i przechowuj ORCID identyfikatory: Twój system będzie musiał znać iD ukończenia ORCID rekord do aktualizacji. Przechowuj je razem z danymi badacza. Zalecamy przechowywanie pełnego identyfikatora URI https: https://orcid.org/0000-0001-5727-2427.
- Zaakceptuj i przechowuj trwałe tokeny dostępu i odśwież tokeny: Tokeny dostępu mogą służyć do odczytywania i aktualizowania rekordów, a także wskazywać, że iD został uwierzytelniony. Trwałe tokeny są ważne przez około 20 lat lub do czasu ich odwołania przez użytkownika. Tokeny odświeżania mogą służyć do tworzenia nowych tokenów dostępu o takich samych lub ograniczonych zakresach. Przechowuj tokeny razem z informacjami naukowca. Zalecamy również przechowywanie zakres tokenai ‚wygaśnięcie tokena.
- Akceptuj i przechowuj wstaw kody (w przypadku aktualizacji ORCID rekordy): Każdy element dodany do pliku ORCID Rejestr zostanie zwrócony z wprowadzonym kodem przez ORCID API. Zapisz ten kod wraz z elementem w swoim systemie — w ten sposób zidentyfikujesz, który element należy przeczytać lub zaktualizować.
- Rejestruj interakcje: Twój system powinien rejestrować oba połączenia wykonane z ORCID Otrzymane API i odpowiedzi. Jest to konieczne ORCID może pomóc, jeśli problem pojawi się później.
- Podaj komunikaty o błędach i skontaktuj się z pomocą techniczną, gdy interakcja nie przebiega zgodnie z oczekiwaniami.
Zamelduj się z ORCID zespół, aby zademonstrować, jak działa Twoja aplikacja
Zanim Twoja integracja będzie mogła zostać opublikowana w ORCID rejestru produkcyjnego, nasz zespół ds. zaangażowania dokładnie sprawdzi, czy wszystko, co zbudowałeś w piaskownicy, będzie działać również w środowisku produkcyjnym. Jeśli używasz systemu z wbudowanym ORCID pomocy technicznej, ten krok może zostać pominięty.
Prośba organizacji członkowskich ORCID Poświadczenia interfejsu API członka na serwerze produkcyjnym (na żywo), wypełniając Formularz aplikacji klienta interfejsu Production Member API. Przed wydaniem poświadczeń produkcyjnego interfejsu API elementu członkowskiego plik ORCID Zespół wykonujący badanie przejrzy wersję demonstracyjną Twojej integracji w programie ORCID piaskownica. Daje nam to szansę zobaczenia wspaniałych integracji, które zbudowałeś i zaoferowania ulepszeń przepływu pracy, a także sprawdzenia, czy wszystkie integracje są zgodne z naszymi najlepszymi praktykami.
Aby udostępnić wersję demonstracyjną swojego systemu, musisz skonfigurować działającą integrację z ORCID piaskownica, która ORCID zespół może wyświetlić podgląd. Istnieje kilka sposobów udostępniania działającej integracji z piaskownicą:
- Polecamy: Demo na żywo: Skontaktuj się z nami, aby umówić się na prezentację na żywo. Dostarczymy oprogramowanie do obsługi spotkań, które umożliwia udostępnianie ekranu w celu zademonstrowania integracji. Daje nam to również możliwość dowiedzenia się więcej o tym, jak działa Twój system i jak wyjaśniasz korzyści z niego płynące ORCID integracji, dzięki czemu możemy zapewnić lepsze wsparcie dla Ciebie i Twoich użytkowników.
- Strona testowa: Jeśli Twoja witryna programistyczna jest publiczna, wyślij nam adres URL wraz z poświadczeniami testowymi (w razie potrzeby) umożliwiającymi dostęp do systemu oraz instrukcjami opisującymi sposób korzystania z systemu ORCID cechy. Dostarcz dodatkową dokumentację, aby zweryfikować, czego nie moglibyśmy zobaczyć od strony użytkownika, np. wersja używanego API, jakie dane są przechowywane przez Twój system itp.
- Screencast lub zrzuty ekranu (zalecane dla ORCID-włączone systemy, które wymagają demonstracji): Wyślij nagranie lub zestaw zrzutów ekranu z opisami jasno wyjaśniającymi i demonstrującymi, jak działa integracja na każdym etapie, w tym co się stanie, jeśli użytkownik odmówi dostępu lub odłączy swój iD. Pamiętaj o dostarczeniu dodatkowej dokumentacji, aby zweryfikować wszystko, czego nie moglibyśmy zobaczyć od strony użytkownika, na przykład wersję używanego interfejsu API i sposób przechowywania danych.¬¨‚
Jeśli używasz jednego z ORCID-włączone systemy, które nie wymagają demonstracji, możesz bezpośrednio zażądać poświadczeń API członka produkcji. Pamiętaj, aby określić, z jakiego systemu (i, jeśli dotyczy, wersji) korzystasz w uwagach.
Istnieje szereg wymagań, które powinny spełniać wszystkie integracje członków. The ORCID zespół upewni się, że wymagania te zostały spełnione w ramach procesu przeglądu integracji.
- Zastosowanie OAuth uwierzytelnić ORCID identyfikatory (nie zezwalaj użytkownikom na wyszukiwanie ani wpisywanie ORCID identyfikatory.)
- Uwzględnij ORCID markowy przycisk lub link w Twojej witrynie, aby zainicjować uwierzytelnianie identyfikatora.
- Przedstaw ekran autoryzacji OAuth zgodnie z naszymi wytyczne
- Użyj protokołu HTTPS dla identyfikatorów URI przekierowania witryny i nie tylko ORCID Wywołania API
- Zaakceptuj i przechowuj wszystkie dane zwrócone w wymianie tokenów wraz z danymi użytkownika w swoim systemie
- Użyj odpowiedniego zakresy i metody żądania (np. wywołania POST w celu dodania nowych informacji i wywołania PUT w celu aktualizacji istniejących informacji)
- Publicznie wyświetlaj uwierzytelnione ORCID identyfikatory. Identyfikatory powinny być wyświetlane po naszym znak towarowy i iD wytyczne wyświetlania.
Żądaj poświadczeń na serwerze produkcyjnym
Możesz ubiegać się o poświadczenia interfejsu API członka, gdy Twoja integracja zostanie sprawdzona przez ORCID zespołu lub jeśli korzystasz z systemu usługodawcy, który ma wbudowaną ORCID integracja.
Będziesz musiał wypełnić tzw formularz do rejestracji aplikacji klienckiej. Poniżej znajduje się krótki przegląd wymaganych pól:
Uwagi dla ORCID personel: Użyj tego pola, aby wydzierżawić ORCID wiedzieć, czy korzystasz z systemu dostawcy, czy integracje zostały sprawdzone itp.
Kontaktowy adres email: Wyślemy dane uwierzytelniające na ten adres. Powinien to być kontakt, z którym pracowaliśmy nad integracją, lub kontakt techniczny, który utrzymujemy dla Twojej organizacji.
Kontakt w sprawie otrzymania kodu PIN umożliwiającego dostęp do danych uwierzytelniających: Wysyłamy Ci pełne dane uwierzytelniające w bezpieczny sposób. Wyślemy do tego kontaktu kod dostępu umożliwiający dostęp do Twoich danych uwierzytelniających API. Musi to być inny kontakt niż poprzedni wymieniony kontakt.
Krótki opis Twojej aplikacji klienckiej: Ten tekst będzie wyświetlany na ekranie autoryzacji wraz z ikoną znaku zapytania dla użytkowników integracji. Wymagany jest krótki opis Twojej integracji.
Adres URL strony głównej Twojej aplikacji: Wyświetlane jako łącze na liście zaufanych organizacji wśród użytkowników ORCID strona zaufanych stron. Powinien to być link prowadzący do Twojej organizacji lub strony głównej Twojej aplikacji.
Identyfikatory URI przekierowania OAuth2 lub adresy URL wywołania zwrotnego dla klienta: Dozwolone adresy URL w Twojej aplikacji internetowej, do których użytkownicy będą odsyłani po autoryzacji dostępu do swoich ORCID nagrywać informacje. Wszystkie identyfikatory URI przekierowania muszą być HTTPS dla klientów serwera produkcyjnego (na żywo).
Po złożeniu wniosku następuje ręczny proces wydawania poświadczeń i otrzymasz wiadomość e-mail ze swoim klientem iD i tajemnica klienta. Zazwyczaj te żądania są przetwarzane w mniej niż 48 godzin.
Przenieś swoją aplikację do ORCID Rejestr produkcji
Po uzyskaniu poświadczeń możesz przystąpić do ich realizacji. Jeśli chcesz przetestować swoją integrację przed jej publicznym udostępnieniem, skorzystaj z własnej wersji testera ORCID akta lub kolegi ORCID rekord.
Uruchom – i daj znać wszystkim
Uruchomienie aplikacji nie jest ostatnim krokiem — musisz nadal komunikować się ze swoimi użytkownikami, aby wiedzieli, jak połączyć swoje ORCID iD do Twojego systemu szybko i łatwo. Skuteczne integracje zawierają zarówno komponent techniczny (omówiony w tym przewodniku), jak i komponent społecznościowy. Badacze muszą być poinformowani o czym ORCID jest powód, dla którego prosisz o dostęp do nich ORCID rekord i co zrobisz z ich danymi.
- Utwórz oś czasu komunikacji: Upewnij się, że interesariusze są świadomi twoich ORCID projekt na długo przed uruchomieniem.
- Użyj kombinacji komunikacji odgórnej i oddolnej.
- Promuj swój ORCID często i dla różnych odbiorców.
- Twórz lokalne zasoby aby wspierać użytkowników, takie jak często zadawane pytania, libguides, strony internetowe, samouczki i filmy.
- Wyznacz lokalną osobę kontaktową ds ORCID-Powiązane pytania.
Aby wesprzeć komponent społeczny, oferujemy zestaw narzędzi Zasoby informacyjne aby pomóc Ci opracować kampanię wspierającą Twoją integrację i przekazać Twoim badaczom:
- Co ORCID jest.
- Dlaczego Twój system zbiera identyfikatory i jak Twój system będzie wykonywał zadania, takie jak aktualizowanie ich rekordów.
- Dlaczego twoi badacze odniosą korzyści, tworząc plik ORCID iD i podłączenie ich identyfikatorów do twojego systemu.
- W jaki sposób ORCID przynosi korzyści szerszej, globalnej społeczności badawczej.
Będziemy stale rozbudowywać tę „bibliotekę” zasobów w oparciu o opinie społeczności. Jeśli masz pomysł na coś, co chciałbyś zobaczyć, skontaktuj się z nami.