Ewolucja krok po kroku 2 (z 5)
2. Zbierz uwierzytelnione ORCID Identyfikatory i uprawnienia
W tym kroku dowiedz się, jak uzyskać uwierzytelnienie iD oraz pozwolenie niezbędne do odczytu i zapisu danych do iz an ORCID rekord.
ORCID integracje wykorzystują „3-etapowa autoryzacja OAuth”, aby uwierzytelniać użytkowników i prosić o pozwolenie na interakcję z ich rekordami. ORCID członkowie mogą korzystać z interfejsu API członków, aby prosić o uprawnienia do odczytu i zapisu.
W tej sekcji omówimy kroki, które Twoja własna integracja niestandardowa musiałaby wykonać, aby uzyskać uwierzytelnienie iD i pozwolenie na czytanie i pisanie do ORCID rekord
Uzyskanie uwierzytelnienia iD a pozwolenie na dostęp do rekordu od użytkownika obejmuje następujące czynności Uwierzytelnianie OA 2.0, branżowy standardowy protokół autoryzacji. OAuth umożliwia użytkownikowi udzielenie stronie internetowej lub aplikacji dostępu do informacji o koncie przechowywanych w innej witrynie bez podawania hasła do tej witryny.
Jeśli kiedykolwiek logowałeś się w witrynie przy użyciu Google lub Facebook zamiast poświadczeń dla tej konkretnej witryny, korzystałeś już z OAuth!
Proces OAuth obejmuje 3 kroki:
- Utwórz adres URL autoryzacji
- Uzyskaj kod autoryzacyjny
- Wymień kod autoryzacyjny na token dostępu
Aby rozpocząć proces OAuth, musimy utworzyć specjalny adres URL autoryzacji, który odsyła użytkowników do ORCID ekran logowania. Ten adres URL składa się z Punkt końcowy autoryzacji, Plus parametry które identyfikują Twoją organizację i uprawnienia, o które chcesz poprosić.
| Parametr | Opis | Przykład |
|---|---|---|
| typ_odpowiedzi | kod | |
| zakres | Działania interfejsu API, dla których chcesz poprosić o pozwolenie, z listy ORCID Scopes | /osoba/aktualizacja /działania/aktualizacja /ograniczony do odczytu /uwierzytelniać |
| ID_klienta | Twój identyfikator klienta członkowskiego (wydany przez ORCID) | [APLIKACJA-***] |
| przekierowanie ur | Strona, którą zobaczą użytkownicy po zakończeniu procesu autoryzacji. (W tym samouczku będzie to Google OAUth Playground) | https://developers.go ogle.com/oauthplayground |
Aby poprosić o pozwolenie na dodanie/aktualizację działań (afiliacje, finansowanie, prace, recenzowanie, zasoby badawcze) oraz na dodanie/aktualizację elementów osobistych (inne nazwy, słowa kluczowe, kraje, adresy URL badaczy, strony internetowe i osobiste identyfikatory zewnętrzne) oraz przeczytać ORCID rekord, adres URL autoryzacji będzie wyglądał następująco:
https://sandbox.orcid.org/oauth/authorize?client_id=[APP-****************]&response_type=code&scope=/read-limited%20/activities/update%20/person/update&redirect_uri=https://developers.google.com/oauthplaygroundAle możemy użyć placu zabaw Google OAuth, aby pomóc nam zbudować adres URL autoryzacji
- Dodaj /activities/update, /person/update, /read-limited w polu zakresów i kliknij Autoryzuj interfejsy API.
Adres URL autoryzacji zostałby utworzony na podstawie informacji wprowadzonych w polach konfiguracji i zakresu.
- An ORCID pojawi się ekran logowania; zaloguj się na swoje konto Sandbox za pomocą adresu e-mail i hasła użytego do utworzenia konta ORCID konto na początku tego samouczka. Po zalogowaniu pojawi się ekran OAuth. Nazwa klienta i odpowiednie zakresy zostaną wyświetlone na tym ekranie. Aby przyznać dostęp, kliknij „Autoryzuj dostęp'
- Po udzieleniu pozwolenia nastąpi przekierowanie z powrotem do Google OAuth Playground, ponieważ był to identyfikator URI przekierowania powiązany z Twoimi poświadczeniami Sandbox. 6-znakowy kod autoryzacji pojawi się na końcu identyfikatora URI przekierowania w pasku adresu przeglądarki (oraz pod Krok 2 sekcja po lewej stronie strony w google oauth plac zabaw)
Secure https://developers.google.com/oauthplayground/code=s536Z5Po uzyskaniu kodu autoryzacyjnego możesz go wymienić na token dostępu i Uwierzytelniony iD użytkownika, który się zalogował, co będzie potrzebne do wykonania akcji interfejsu API, o które prosiłeś o pozwolenie.
W rzeczywistej sytuacji ta wymiana byłaby wykonywana przez twój system przy użyciu języka programowania, takiego jak PHP, Java lub Ruby on Rails. W tym samouczku użyjemy Google OAuth Playground do symulacji aplikacji internetowej.
- Kliknij „Wymień kod autoryzacyjny na tokeny”
Po kliknięciu „Wymień kod autoryzacyjny na tokenyTwój token dostępu i uwierzytelniony iD pojawi się w Wymagać odpowiedzi sekcja po prawej stronie. Zobacz przykład poniżej:
{
"name": "Sophia Garcia"
"access_token": "53737721-9cdb-442a-8b77-409609bb5e43",
"expires_in": 631138518,
"token type": "bearer",
"orcid":
"0000-0002-4456-8947"
"scope": "read-limited /activities/update person/update "
"refresh token": "cOfc38fd-291e-4633-a365-6f4afa304344"
}- Zapisz ten token!
Ważne jest, aby zapisać token, który otrzymałeś w powyższym kroku, ponieważ możesz z łatwością tworzyć dowolne połączenia, które musisz wykonać za jego pomocą. Zalecamy przechowywanie pełnej odpowiedzi wymiany tokenów
Zebrałeś teraz uwierzytelniony identyfikator i pozwolenie od użytkownika na odczytanie jego danych. ORCID rejestrować i aktualizować ich ORCID rekord.