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 i najlepsze praktyki integracyjne. Jeśli jesteś ORCID organizacji członkowskiej, możesz skontaktować się z nami lub liderem konsorcjum w celu uzyskania pomocy! .
- 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. Sprawdź nasze ORCID lista certyfikowanych usługodawców aby sprawdzić, czy Twój system jest uwzględniony
- 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ę zawierającą pomysły na zbudowanie kampanii komunikacyjnej wokół nowej integracji. Polecamy również obejrzenie naszego webinaru 'Jestem teraz członkiem i co?! Jak rozmawiać ORCID"
Zarejestruj się, aby uzyskać poświadczenia piaskownicy i utwórz test ORCID iD
Jeśli tworzysz niestandardową integrację lub korzystasz z aplikacji niecertyfikowanego dostawcy usług, wymagamy, abyś najpierw skorzystał z naszego środowiska Sandbox w celu zbudowania i przetestowania integracji.
Możesz zażądać poświadczeń interfejsu użytkownika piaskownicy do zbudowania i przetestowania aplikacji. Te poświadczenia umożliwiają wykonywanie wywołań do interfejsu API członka premium 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 używasz pliku ORCID certyfikowany system dostawcy usług, który już obsługuje ORCID, nie musisz rejestrować się, aby uzyskać poświadczenia API piaskownicy, chyba że chcesz wypróbować ORCID funkcjonalność integracji w środowisku Sandbox.
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 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.
4
6
Określ uprawnienia użytkownika, których będziesz potrzebować
Opona ORCID Interfejs API członka może służyć do odczytywania, dodawania lub aktualizowania informacji o użytkowniku ORCID rekord — wystarczy poprosić badaczy o pozwolenie.
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) 
W tym zakresie można pisać, aktualizować i usuwać pozycje w sekcjach: afiliacja, finansowanie, prace, działalność zawodowa, zasoby badawcze i recenzje recenzentów 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, wyszukaj ORCID rekordów lub do odczytania informacji podsumowujących (tylko interfejs API członków). Ten zakres jest dostępny w interfejsie API członka lub publicznego.
/ 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.
0
5
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, aby wyświetlić iD i dokonać prawidłowej aktualizacji. Przechowuj je razem z informacjami badacza zwracanymi w odpowiedzi na wymianę tokenów. Naszym zaleceniem jest 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ło uwierzytelnione. Tokeny dostępowe są ważne przez około 20 lat lub do momentu ich odwołania przez użytkownika. Zalecamy również przechowywanie zakres tokena, wygaśnięcie tokena i odśwież tokeny. W razie potrzeby tokenów odświeżania można używać do tworzenia nowych tokenów dostępu o tym samym lub ograniczonym zakresie. Przechowuj dane tokena tokena dostępu razem z informacjami badacza.
- Akceptuj i przechowuj wstaw kody : Każdy element dodany do ORCID Rejestr zostanie zwrócony z wprowadzonym kodem przez ORCID API. Zapisz ten 6-cyfrowy kod wraz z pozycją w swoim systemie – w ten sposób zidentyfikujesz, który element należy przeczytać, zaktualizować lub usunąć.
- Podaj komunikaty o błędach i skontaktuj się z pomocą techniczną, gdy interakcja nie przebiega zgodnie z oczekiwaniami.
0
0
Zamelduj się z ORCID zespołu lub Lidera Konsorcjum, 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 lub lider konsorcjum dokładnie sprawdzą, czy wszystko, co zbudowałeś w piaskownicy, będzie również działać na produkcji. Jeśli używasz ORCID Certyfikowany system dostawcy usług ten krok można pominąć. Mamy listę minimalne wymagania które muszą zostać spełnione, zanim będziemy mogli wystawić poświadczenia Member API Production.
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ół realizujący zlecenie/Lider konsorcjum przejrzy wersję demonstracyjną Twojej integracji w pliku ORCID piaskownica. Daje nam to szansę zobaczenia świetnych integracji, które zbudowałeś i zaoferowania ulepszeń przepływu pracy, a także sprawdzenia, czy wszystkie integracje spełniają nasze najlepsze praktyki i minimalne wymagania dotyczące uruchomienia.
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. Udostępnimy oprogramowanie do obsługi spotkań, które umożliwi udostępnienie ekranu w celu zademonstrowania integracji.
- 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:Wyślij nagranie lub zestaw zrzutów ekranu z opisami jasno wyjaśniającymi i pokazują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 identyfikator. Pamiętaj o udostępnieniu dodatkowej dokumentacji, aby zweryfikować wszystko, czego nie moglibyśmy zobaczyć po stronie użytkownika, na przykład używaną wersję interfejsu API i sposób przechowywania danych
1
0
Poproś o poświadczenia interfejsu API członka
Możesz ubiegać się o poświadczenia interfejsu API członka, gdy Twoja integracja zostanie sprawdzona przez ORCID zespół lub jeśli używasz ORCID certyfikowany system dostawców usług.
Będziesz musiał wypełnić tzw formularz do rejestracji aplikacji klienckiej. Poniżej znajduje się krótki przegląd wymaganych pól:
Nazwa organizacji: Twój ORCID nazwa organizacji członkowskiej
Główny kontaktowy adres e-mail w celu uzyskania danych uwierzytelniających: Wykorzystamy ten adres e-mail, aby wysłać Ci dane uwierzytelniające w zaszyfrowanej wiadomości e-mail i skontaktować się z Tobą, jeśli pojawią się jakiekolwiek pytania lub błędy związane z integracją
Dodatkowy adres e-mail dla hasła: Adres e-mail, na który możemy wysłać Twoje zaszyfrowane hasło e-mail.
Imię i nazwisko Twojego klienta: To będzie twoje ORCID nazwa organizacji członkowskiej. Jeżeli posiadasz więcej niż 1 integrację to do nazwy dołączymy aplikację.
Adres URL strony głównej Twojej aplikacji: Wyświetlany jako link 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.
Krótki opis Twojej aplikacji klienckiej: Ten tekst będzie wyświetlany użytkownikom integracji na ekranie autoryzacji z ikoną znaku zapytania. Wymagany jest krótki opis integracji
Identyfikatory URI przekierowania: Gdy użytkownik zatwierdzi Twoją aplikację, zostanie zwrócony do określonego przez Ciebie identyfikatora URI. Musisz podać te identyfikatory URI z wyprzedzeniem, w przeciwnym razie użytkownicy integracji napotkają błąd.
- Akceptowane są tylko identyfikatory URI HTTPS.
- Zarejestrowane domeny muszą dokładnie odpowiadać używanym domenom, łącznie z subdomenami.
- Jeśli to możliwe, należy w pełni zarejestrować wszystkie identyfikatory URI przekierowań.
- Wymaganych jest więcej niż 5 identyfikatorów URI przekierowania? Proszę to zaznaczyć w uwagach dot ORCID personel.
Uwagi dla ORCID personel: Użyj tego pola, aby wydzierżawić ORCID pracownicy wiedzą coś więcej na temat Twojej prośby lub integracji
4
3
Przenieś swoją aplikację do ORCID Rejestr produkcji
Gdy już zdobędziesz dane uwierzytelniające, możesz przystąpić do integracji na żywo. Jeśli chcesz przetestować swoją integrację przed jej publicznym udostępnieniem, skorzystaj z 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.
Jeśli potrzebujesz pomocy, skontaktuj się ze swoim Liderem ds. zaangażowania lub Liderem konsorcjum
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.
3
0