Ten samouczek przeprowadzi Cię przez czytanie informacji publicznych i informacji o ograniczonym dostępie na ORCID rekord przy użyciu publicznego lub członkowskiego interfejsu API. Opiera się na wersji 3.0 programu ORCID schemat wiadomości.
- Zdobądź dane uwierzytelniające klienta
- Uzyskaj token dostępu
- Zdecyduj, co chcesz przeczytać
- Użyj tokena, aby uzyskać dostęp do interfejsu API
- Więcej informacji
Zdobądź dane uwierzytelniające klienta
Poświadczenia klienta to nazwa użytkownika i hasło, których aplikacja/strona internetowa będzie używać w celu uzyskania dostępu do ORCID API. Każdy może zarejestrować się w celu uzyskania poświadczeń Public API tylko do odczytu, ORCID członkowie mogą zarejestrować się w interfejsie API członków.
Zalecamy, aby programiści przetestowali publiczny interfejs API w serwer testowy piaskownicy przed użyciem wersji produkcyjnej. Poniżej przedstawiono kroki, jak zarejestrować się w celu uzyskania poświadczeń publicznego interfejsu API zarówno w środowisku Sandbox, jak i w środowisku produkcyjnym.
- Zaloguj się na swoje ORCID rekord:
Serwer produkcyjny: https://orcid.org/signin
Serwer testowy piaskownicy: https://sandbox.orcid.org/signin - Kliknij swoje imię w prawym górnym rogu
- Kliknij Narzędzia Deweloperskie z opcji menu
Uwaga: Aby uzyskać dostęp do Narzędzi dla programistów, musisz zweryfikować swój adres e-mail. Jeśli nie zweryfikowałeś jeszcze swojego adresu e-mail, zostaniesz poproszony o zrobienie tego, zanim będziesz mógł zarejestrować się w celu uzyskania publicznych poświadczeń API - Przeczytaj i zaakceptuj „ORCID Warunki korzystania z usług publicznych interfejsów API
- Kliknij przycisk „Zarejestruj się ORCID Przycisk „Publiczne dane uwierzytelniające API”.

Wypełnienie formularza szczegółów aplikacji
- Po zarejestrowaniu się w celu uzyskania poświadczeń publicznego interfejsu API nastąpi przekierowanie z powrotem do narzędzi dla programistów (https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
- Aby zarejestrować nową aplikację, należy wypełnić przedstawiony formularz szczegółów wniosku.
- Imię: Nazwa Twojej aplikacji. Zostanie to wyświetlone użytkownikom, gdy udzielą Twojej aplikacji pozwolenia na ich uzyskanie ORCID iD i będzie wyświetlany w ich Lista zaufanych organizacji. Zalecamy użycie nazwy organizacji lub usługi (np. nazwy czasopisma).
- URL aplikacji: Witryna, którą użytkownik może odwiedzić, aby dowiedzieć się więcej o Twojej aplikacji. Będzie to również widoczne w ich Lista zaufanych organizacji.
- Opis aplikacji: Informacje o aplikacji, którą tworzysz i o tym, jak będziesz korzystać z aplikacji użytkownika ORCID ID. Zostanie to wyświetlone użytkownikom na ekranie OAuth.

Dodawanie 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.
- Wprowadź identyfikator URI przekierowania w wyświetlonym polu
- Jeśli musisz wprowadzić więcej niż 1 identyfikator URI przekierowania, kliknij „Dodaj kolejny identyfikator URI przekierowania”
UWAGA:
- Only Identyfikatory URI HTTPS są akceptowane w produkcji
- Domeny zarejestrowane MUST dokładnie pasują do używanych domen, w tym subdomen
- Jeśli to możliwe, należy w pełni zarejestrować wszystkie identyfikatory URI przekierowań. Jest to najbezpieczniejsza opcja i zalecamy. Aby uzyskać więcej informacji na temat identyfikatorów URI przekierowania, zobacz nasze Często zadawane pytania dotyczące identyfikatora URI przekierowania
Zapisywanie aplikacji
Po wypełnieniu formularza zgłoszeniowego i dodaniu identyfikatorów URI przekierowania możesz zapisać swoją aplikację.
- Kliknij „Zapisz moją aplikację i wygeneruj mój identyfikator klienta oraz klucz tajny”
Nastąpi przekierowanie z powrotem na stronę narzędzi dla programistów, która będzie teraz zawierać poświadczenia klienta publicznego interfejsu API

Aktualizowanie poświadczeń
Dokonywanie zmian w informacjach o aplikacji jest bardzo proste.
- Edytuj odpowiednie informacje, a następnie kliknij „Zapisz wniosek”
Użyj swoich poświadczeń
Teraz, gdy masz już swoje poświadczenia, nadszedł czas, aby zacząć używać ORCID Publiczne API!
Pamiętaj, że możemy przenieść Twoje dane uwierzytelniające do API członka, jeśli zostaniesz członkiem ORCID członek w przyszłości.
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.
Uzyskaj token dostępu
Musisz uzyskać token dostępu, aby użyć ORCID API. Odbywa się to za pomocą OAuth. Pamiętaj, że:
- ORCID członkowie mogą poprosić poszczególnych badaczy o pozwolenie na odczytanie „ograniczonych” danych dotyczących widoczności z ich rejestrów.
- Klienci nie muszą pytać badacza o zgodę na zapoznanie się z publicznie dostępnymi informacjami.
Każdy, kto ma publiczne lub członkowskie poświadczenia API, może otrzymać /odczyt-publiczny token dostępu. Aby otrzymać token, dzwonisz do ORCID Punkt końcowy tokenu interfejsu API.
Ten proces jest często nazywany przepływem OAuth poświadczeń klienta lub 2-etapową autoryzacją OAuth.
Przykładowe wywołanie w celu uzyskania tokena dostępu do odczytu danych publicznych w piaskownicy — zastąp symbole zastępcze swoimi danymi uwierzytelniającymi (pamiętaj o usunięciu nawiasów.
URL=https://sandbox.orcid.org/oauth/token
HEADER: Accept: application/json
METHOD: POST
DATA:
client_id=[Your public API client ID]
client_secret=[Your public API secret]
grant_type=client_credentials
scope=/read-public
Następnie zostanie zwrócony token dostępu podobny do poniższego. Zwrócony token jest długowieczny (nie wygasa przez około 20 lat) i może być używany wielokrotnie do pobierania publicznych danych z ORCID Records.
{"access_token":"4bed1e13-7792-4129-9f07-aaf7b88ba88f","token_type":"bearer",
"refresh_token":"2d76d8d0-6fd6-426b-a017-61e0ceda0ad2","expires_in":631138518,
"scope":"/read-public","orcid":null}
Uwaga: Wszystkie tokeny z zakresem /authenticate mają teraz również zakres /read-public. Jeśli używasz tylko zakresu /authenticate, możesz użyć przechowywanych tokenów dostępu do odczytywania danych publicznych bez konieczności ponownego uzyskiwania tokenu dostępu.
Integratorzy korzystający z członkowskiego API mogą używać /odczyt-publiczny zakres do przeczytania ORCID podsumowania nagrań.
Aby uzyskać dostęp z ograniczeniem /read-limited, musisz poprosić badacza o pozwolenie. Robisz to za pomocą OAuth. Konkretnie, "3-etapowa autoryzacja OAuth".
Aby uzyskać więcej informacji, zobacz nasze Samouczek interfejsu API: Odczytywanie danych na ORCID rekord
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.
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
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.
Widoczność wskazuje ustawienie prywatności elementu na podstawie preferencji widoczności ustawionych przez użytkownika. Jeśli tag widoczności jest dołączony, gdy informacje są publikowane za pośrednictwem interfejsu API, zostanie zignorowany. Zamiast tego informacje będą publikowane zgodnie z domyślną preferencją widoczności użytkownika, ustawioną w preferencjach jego konta.
Elementy publiczne mogą być odczytywane przez każdego za pośrednictwem interfejsu API i są wyświetlane w rejestrze publicznym badacza. Elementy podmiotów zaufanych są zwracane za pośrednictwem interfejsu API tylko klientom, którzy mają ograniczony dostęp do odczytu; nie znajdują się one w publicznych rejestrach badacza. Elementy prywatne są widoczne tylko dla badacza i źródła elementu – jedynymi elementami prywatnymi zwracanymi przez API są te, które zostały dodane do rekordu poprzez Twoją integrację Więcej o ustawieniach widoczności w ORCID rejestr.
Zdecyduj, co chcesz przeczytać
Kurs ORCID rekord jest podzielony na wiele części. Możesz przeczytać całe podsumowanie lub tylko fragmenty, które Cię interesują.
To przykładowe wywołanie pobiera podsumowanie pełnego ORCID rekord w formacie XML przy użyciu interfejsu API członka na serwerze piaskownicy. Potrzebujesz tokena dostępu, aby wysyłać żądania interfejsu API do publicznego lub członkowskiego interfejsu API.
Method: GET Accept: application/vnd.orcid+xml
Authorization type and Access token:
Bearer [Stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/record
Interfejs API zwróci komunikat 200 OK, wskazujący, że żądanie zostało odebrane pomyślnie, oraz pełne podsumowanie ORCID ewidencja, w tym zestawienia poszczególnych pozycji.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">
[...]
</record:record>
Każda pozycja (praca, finansowanie, zatrudnienie itp.) umieść kod. W razie potrzeby można to wykorzystać do uzyskania pełnych szczegółów przedmiotu.
Kurs ORCID rekord jest podzielony na poszczególne sekcje, aby odczyt był szybszy i bardziej spójny. Możesz najpierw wywołać sekcję, aby otrzymać jej podsumowanie, a następnie zadzwonić przy użyciu kodu umieszczania pojedynczego elementu, aby uzyskać szczegółowe informacje o tym elemencie.
Poniżej przedstawiono tabelę sekcji podsumowania, które można odczytać za pomocą interfejsu API.
Punkt końcowy | Opis |
/rekord | Podsumowanie widoku pełnego ORCID rekord |
/osoba | Sekcja biograficzna ks ORCID rekord, w tym poprzez /researcher-urls poniżej |
/streszczenie | Widok podsumowujący zweryfikowanych i samodzielnie potwierdzonych elementów w witrynie ORCID rekord (dostępny tylko w przypadku interfejsu API członka) |
/adres | Kraje lub regiony badacza |
Adresy e-mail powiązane z rekordem | |
/zewnętrzne-identyfikatory | Połączone identyfikatory zewnętrzne w innych systemach |
/słowa kluczowe | Słowa kluczowe związane z badaczem i jego pracą |
/inne nazwy | Inne nazwiska, pod którymi badacz jest znany |
/dane osobowe | Dane osobowe: imię i nazwisko badacza, nazwisko (opublikowane) i biografia |
/researcher-urls | Linki do stron osobistych lub profilowych badacza |
/zajęcia | Podsumowanie działalności sekcji ORCID rekord, w tym poprzez /works poniżej. |
/edukacja | Przynależności edukacyjne |
/zatrudnienia | Powiązania zatrudnienia |
/ fundusze | Podsumowanie działań związanych z finansowaniem |
/ocena współpracownika | Podsumowanie działań recenzentów |
/Pracuje | Podsumowanie prac badawczych |
/zasoby-badawcze | Podsumowanie zasobów badawczych |
/usługi | Podsumowanie usług |
/kwalifikacje | Podsumowanie kwalifikacji |
/członkostwa | Podsumowanie członkostwa |
/wyróżnienia | Podsumowanie wyróżnień |
/zaproszone-pozycje | Podsumowanie zaproszonych stanowisk |
Użyj tokena, aby uzyskać dostęp do interfejsu API
Teraz, gdy masz token dostępu, możesz wykonać wywołanie API, aby uzyskać dane w formacie XML lub JSON.
Wszystkie pozycje (poza tekstem życiorysu) na ORCID rekord ma umieść kod:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0"> [...]
</record:record>
Ten kod put może służyć do wywołania interfejsu API w celu pobrania pełnych danych elementu. Następujące elementy można zapytać za pomocą a umieść kod:
Punkt końcowy | Opis |
/adres/[wpisz kod] | Pojedynczy kraj lub region |
/biografia | Pole biografii: pole tekstowe, które może edytować tylko badacz |
/edukacja/[wpisz kod] | Indywidualny element przynależności do edukacji |
/email/[wpisz kod] | Indywidualny adres e-mail powiązany z rekordem |
/praca/[wpisz kod] | Indywidualna pozycja przynależności do zatrudnienia |
/identyfikator-zewnetrzny/[wpisz kod] | Indywidualny powiązany identyfikator zewnętrzny w innym systemie |
/finansowanie/[wpisz kod] | Indywidualna działalność finansowa |
/słowa kluczowe/[wpisz kod] | Indywidualne słowo kluczowe związane z badaczem i jego pracą |
/inne-nazwy/[wpisz kod] | Indywidualna nazwa dodatkowa, pod którą znany jest badacz |
/peer-recenzja/[wpisz kod] | Indywidualne działanie recenzujące |
/researcher-urls/[wpisz kod] | Indywidualny link zewnętrzny do strony osobistej lub profilowej badacza |
/praca/[wpisz kod] | Indywidualna praca naukowa |
/działa/[podaj kod1],[podaj kod2],[podaj kod3] | Masowe indywidualne prace badawcze (do 100) |
Używając punktu końcowego sekcji i umieszczając kod, możesz wywołać interfejs API przy użyciu tego samego tokena dostępu, aby uzyskać pełny dostęp do tego konkretnego elementu. To przykładowe wywołanie pobiera pozycję pełnego finansowania 4413 w formacie XML przy użyciu interfejsu API członka na serwerze piaskownicy.
Method: GET Accept: application/vnd.orcid+xml Authorization type and Access token: Bearer [stored access token]URI: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/funding/4413
Interfejs API zwróci komunikat 200 OK, aby wskazać, że komunikat został pomyślnie odebrany, i zwróci pełny kod XML elementu finansowania:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<funding:funding put-code="4413" path="/0000-0002-9227-8514/funding/4413" visibility="public" [...] >
[...]
</funding:funding>
Można sprawdzić źródło elementu podczas czytania, jeśli chcesz wiedzieć, kto to dodał.
Więcej informacji
Uwaga na temat grupowania
Elementy są pogrupowane na ORCID rekordy na podstawie ich identyfikatorów. Może się okazać, że elementy, które czytasz, są częścią grupy.
Pracuje w ORCID są pogrupowane razem na podstawie zarówno ich identyfikatorów, jak i związku tych identyfikatorów z dziełem. Istnieją cztery rodzaje relacji:
- Samego siebie: identyfikator odnosi się wyłącznie do tego utworu i może być zgrupowany z innymi utworami, które mają ten sam identyfikator
- Część: praca jest częścią tego identyfikatora i nie może być grupowana z innymi pracami
- Wersja: te identyfikatory odnoszą się do alternatywnych wersji utworu i można je pogrupować z identyfikatorami self i version
- Ufundowane przez: te identyfikatory odnoszą się do finansowania prac. Identyfikatory te nie służą do grupowania prac.
Nasze API zapewnia obsługę tego w XSD. Każdy element ma atrybut indeksu wyświetlania, który wskazuje jego pozycję w danej grupie. Najwyższy wskaźnik wyświetlania jest preferowaną pozycją wybraną przez badacza. Elementy dodane za pośrednictwem interfejsu API, które nie zostały sklasyfikowane przez badacza, mają indeks wyświetlania równy 1 i są używane jako domyślne preferowane źródło w grupie, dopóki badacz ich nie zmieni. Indeks wyświetlacza określa również kolejność pracy podczas odczytu ORCID nagrać za pomocą API.
Aby uzyskać więcej informacji na temat grupowania na ORCID rekordy, zobacz nasze artykuł wsparcia.
Uwaga dotycząca typów treści
ORCID obsługuje wiele typów treści, w tym XML i kilka odmian JSON. Możesz poprosić o preferowany typ, dołączając nagłówek „Accept” do swoich żądań API. Nazywa się to „negocjacjami treści”.
Kurs ORCID rejestr obsługuje „negocjację treści”. Oznacza to, że maszyny i inne systemy mogą pytać ORCID rejestr metadanych osób w różnych formatach.
Jednym z tych formatów jest JSON-LD, który wykorzystuje rozszerzenie schema.org słownictwo, konkretnie typ Osoba, które łączymy z utworami, organizacjami i innymi identyfikatorami. Obsługujemy również XML, JSON, RDF XML i turtle, a także wdrożyliśmy współdzielenie zasobów między źródłami (CORS), aby ułatwić dostęp do naszych danych.
- Zobacz to wpis na blogu z przeglądem ORCID i schema.org
- Sprawdź nasz dokumentacja techniczna dotycząca negocjacji treści
Uwaga na temat nieistniejących ORCIDs
Wyszukiwanie użytkownika za pomocą cURL w następujący sposób:
curl -iL https://orcid.org/0000-0000-0000-0000
Zwróci 200, nawet jeśli użytkownik nie istnieć. Aby tego uniknąć, użyj negocjacji treści w rozmowie w następujący sposób:
curl -iL -H 'Accept: application/xml' https://orcid.org/0000-0000-0000-0000