ORCID integracje wykorzystują „trójetapową autoryzację OAuth” do uwierzytelniania użytkowników i żądania pozwolenia na interakcję z ich rekordami. Każda integracja może poprosić o uprawnienia do odczytu przy użyciu publicznego interfejsu API. ORCID członkowie mogą korzystać z interfejsu API członków, aby poprosić o uprawnienia do aktualizacji. To działa tak:
- Tworzysz specjalny link
- Po kliknięciu użytkownik jest wysyłany do ORCID
- ORCID prosi użytkownika o zalogowanie się
- ORCID prosi użytkownika o nadanie uprawnień do Twojej aplikacji
- ORCID odsyła użytkownika z powrotem do systemu z kodem autoryzacyjnym
- Twój system wymienia ten kod na token dostępu
Dostosowany adres URL autoryzacji zawiera informacje o kliencie, a także „zakresy” określające określone obszary jego danych, do których chcesz uzyskać dostęp. Po zalogowaniu użytkownik autoryzuje połączenie z Twoim systemem i wraca na Twój landing page wraz z kodem autoryzacyjnym. Ten kod jest następnie używany do ich uzyskania ORCID iD wraz z tokenem dostępu ważnym dla żądanych zakresów.
Zbuduj link autoryzacyjny i uzyskaj kod autoryzacyjny
Możesz utworzyć łącze autoryzacyjne, określając identyfikator klienta i powiązaną stronę docelową (URI przekierowania) swoich danych uwierzytelniających API. Możesz wybrać, o jakie uprawnienia poprosić, ustawiając parametr zakresu.
Poniższy przykład prosi o pozwolenie na odczyt danych o ograniczonym dostępie na ORCID serwer testowy piaskownicy. W prawdziwym świecie wyświetlasz ten link na swojej stronie internetowej lub umieszczasz go w wiadomości e-mail, prosząc użytkownika o uwierzytelnienie i autoryzację. Jednak w celach testowych możesz po prostu wkleić go do przeglądarki internetowej. Zastąp dane w nawiasach informacjami o kliencie i pamiętaj o usunięciu nawiasów kwadratowych!
https://sandbox.orcid.org/oauth/authorize?client_id=[Your client ID]&response_type=code&scope=/read-limited&redirect_uri=[Your landing page]
Jeden użytkownik kliknął link, zalogował się pod adresem ORCID i przyznane uprawnienia są przekierowywane z powrotem do Twojej witryny, na przykład:
https://[Your landing page]?code=Q70Y3A
Wymień kod autoryzacyjny na ORCID iD i token dostępu
Należy niezwłocznie wymienić kod autoryzacyjny na ORCID iD i token dostępu. Kod autoryzacyjny wygasa po użyciu. Żądanie wygląda tak i nie można wykonać w przeglądarce internetowej, musi być wykonane przez twój serwer.
URL=https://sandbox.orcid.org/oauth/token
HEADER: Accept: application/json
HEADER: Content-Type: application/x-www-form-urlencoded
METHOD: POST
DATA:
client_id=[Your client ID]
client_secret=[Your client secret]
grant_type=authorization_code
code=Six-digit code
redirect_uri=[Your landing page]
ORCID następnie zwróci uwierzytelniony badacz ORCID iD oraz token dostępu w formacie JSON:
{"access_token":"f5af9f51-07e6-4332-8f1a-c0c11c1e3728","token_type":"bearer",
"refresh_token":"f725f747-3a65-49f6-a231-3e8944ce464d","expires_in":631138518,
"scope":"/read-limited","name":"Sofia Garcia","orcid":"0000-0001-2345-6789"}
Tokeny dostępu są domyślnie długowieczne i wygasają po 20 latach od wydania. Token może być używany wielokrotnie, zanim wygaśnie.
Użyj tokena dostępu
Trójnożne tokeny dostępu są powiązane z konkretnymi ORCID nagrywać. Aby z nich skorzystać, dołączasz je do żądań API, które wysyłasz w celu odczytania lub zaktualizowania tego rekordu.