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 (Public API); inne są dostępne tylko dla ORCID organizacje członkowskie (Member i Premium Member API).
Każdy może przetestować interfejs API na naszym serwerze testowym piaskownicy i zachęcamy wszystkie organizacje korzystające ORCID – członków i osób niebędących członkami – do przyłączenia się do naszej Grupa użytkowników API, gdzie możesz zadawać pytania i poznawać nowe rozwiązania techniczne.
Przeszukaj najczęściej zadawane pytania tutaj:
Podstawy
Pozycje (prace, zatrudnienie, finansowanie, recenzowanie itp.) ORCID nagrywaj ręcznie lub za pomocą ORCID API członka. Jeśli jesteś osobą fizyczną i chcesz zaktualizować swoje dane, sprawdź nasze sekcję pomocy na ten temat tutaj. Jeśli jesteś członkiem i chcesz dodać elementy do ORCID zapisz, będziesz potrzebować:
- Pozwolenie naukowców
- Poświadczenia interfejsu API członka
- albo:
- System dostawcy, który integruje się z ORCID Interfejs API członków
- Twój własny system, który integruje się z ORCID Interfejs API członków
Aby zapoznać się z kompletnym przewodnikiem dla członków korzystających z interfejsu API do elementów rekordu, sprawdź nasz link do samouczka dotyczącego interfejsu API poniżej:
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.
Integracja ORCID do Twojego systemu pozwala Twojej organizacji na zbieranie uwierzytelnionych danych ORCID iDs i dodaj je do własnych danych. Jednocześnie badacz zapewnia organizacji uprawnienia do odczytu i zapisu do i z ich danych ORCID rekord.
Aby to zadziałało, organizacje MUST uzyskać uwierzytelniony ORCID identyfikatory używając ORCID API OAuth. Oznacza to, że obejmują one ORCID markowy przycisk lub link w ich systemie, który po kliknięciu prosi użytkownika o zalogowanie się ORCID rekord.
Po zalogowaniu użytkownik zostanie poproszony o autoryzację dostępu do systemu z prośbą o podanie danych ORCID iD
użytkownika ORCID iD i imię na ORCID rekord (w zależności od ustawień widoczności) jest w ramach tego procesu zwracany organizacji. System może następnie zażądać dodatkowych danych od ORCID API.
Opisany powyżej przepływ pracy dotyczący gromadzenia uwierzytelnionych interfejsów API jest dostępny w obu przypadkach ORCIDpubliczne i członkowskie interfejsy API. Z tej pierwszej można korzystać bezpłatnie w serwisach niekomercyjnych.
Proces uzyskiwania uprawnień do dodawania lub aktualizowania danych użytkownika ORCID rekord używa OAuth, jak opisano w naszym Często zadawane pytania dotyczące trzyetapowej autoryzacji OAuth, Tylko ORCID członkowie mogą korzystać z interfejsu API członków, aby poprosić o uprawnienia do aktualizacji. W uproszczeniu działa to tak:
- Twój system lokalny tworzy specjalne łącze
- Po kliknięciu użytkownik jest wysyłany do ORCID, loguje się i udziela pozwolenia
- ORCID odsyła użytkownika z powrotem do twojego systemu z „kodem autoryzacyjnym”
- Twój system wymienia ten kod na „token dostępu”
- Token dostępu umożliwia aktualizację rekordu użytkownika
ORCID dąży do umożliwienia przejrzystych i godnych zaufania powiązań między badaczami, ich wkładem i powiązaniami, zapewniając unikalny, trwały identyfikator, z którego mogą korzystać osoby fizyczne angażujące się w badania, stypendia i działania innowacyjne. Zapewnienie, że jest to prawidłowe ORCID iD powiązanie z właściwym badaczem jest krytycznym krokiem w budowaniu wiarygodności badacza ORCID zbioru danych i szerszego ekosystemu komunikacji naukowej. Z tego powodu, ORCID nie pozwala na ręczne zbieranie ani wprowadzanie ORCID Identyfikatory w dowolnym przepływie pracy, w którym można je zebrać ORCID Identyfikatory bezpośrednio od samych rekordzistów.
Naukowcy mogą łatwo i bezpiecznie udostępniać swoje dane ORCID iD z systemami, z którymi wchodzą w interakcję, co dowodzi, że są ich właścicielami ORCID ID. Systemy te mogą następnie udostępniać informacje na temat działań badaczy innym systemom, co tworzy łańcuch zweryfikowanych i wiarygodnych twierdzeń na temat działalności badaczy. Efektem końcowym jest powiązanie właściwej osoby z właściwymi działaniami w szerokim zakresie przepływów informacji naukowych.
Aby uzyskać więcej informacji, patrz: https://info.orcid.org/collecting-and-sharing-orcid-ids/
Możesz ułatwić życie swoim użytkownikom, łącząc zweryfikowane informacje z ich danymi ORCID dokumentacja. Pomożesz również w budowaniu zaufania do komunikacji naukowej, a aktualizując te dane, możesz zmniejszyć obciążenia związane z raportowaniem dla użytkowników i poprawić jakość danych.
ORCID dla organizacji badawczych
Oprócz wykorzystania go jako trwałego identyfikatora dla badaczy, ORCID może pomóc Ci przejąć kontrolę nad tym, jak nazwa Twojej instytucji jest używana w różnych systemach badawczych. W połączeniu z innymi trwałymi identyfikatorami ORCID umożliwia autorytatywne potwierdzenie powiązań pracowników, wykładowców i studentów z instytucją. Możesz także użyć ORCID Interfejsy API do otrzymywania powiadomień w czasie rzeczywistym o działaniach badawczych, automatycznej aktualizacji formularzy i śledzenia karier absolwentów.
ORCID dla organizacji finansujących
Poprzez osadzenie ORCID iDs w swoich procesach finansowania, możesz niezawodnie łączyć stypendystów i programy finansowania — oszczędzając wszystkim czas i zmniejszając liczbę błędów spowodowanych ręcznym wprowadzaniem informacji. Za pomocą ORCID w swoim systemie (systemach), możesz odegrać swoją rolę w budowaniu zaufanej infrastruktury informacyjnej badań, zapewniając powiązania między poszczególnymi osobami i przyznanymi im grantami.
ORCID dla Wydawców
Badacze znajdują się w centrum wszystkiego, co robią wydawcy naukowi i badacze. Dokładne informacje o autorze i recenzencie są niezbędne do indeksowania, wyszukiwania i odkrywania, śledzenia publikacji, atrybucji finansowania i wykorzystania zasobów oraz wspierania recenzowania.
ORCID służy jako centrum informacji, umożliwiając autorom i recenzentom niezawodne połączenie z ich wkładem oraz udostępnianie informacji od nich ORCID rejestrować podczas interakcji z systemami wydawniczymi. Zbieranie identyfikatorów dla wszystkich autorów i recenzentów podczas procesu publikacji — niezależnie od tego, czy dotyczy to książek, czasopism, zbiorów danych, kompozycji, prezentacji, kodu czy wielu innych prac — umożliwia łatwe udostępnianie informacji, gwarantuje, że badacze mogą wyrazić zgodę na udostępnianie, oszczędza czas i kłopoty naukowców, zmniejsza ryzyko błędów i, co najważniejsze, umożliwia naukowcom uzyskanie uznania, na jakie zasługują za ważną pracę, którą wykonują.
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
Integracja
Poświadczenia klienta publicznego są przyznawane osobom fizycznym, a nie organizacjom. Poświadczeń nie można przenosić z jednej osoby na drugą, ale można je przekształcić w poświadczenia API członka, jeśli uzyskano zgodę wszystkich stron, a organizacja jest aktywnym członkiem ORCID.
Przeniesienie identyfikatora klienta do interfejsu API członkowskiego nie spowoduje zmiany identyfikatora klienta, a jedynie tajnego klucza klienta. Zachowasz także liczbę połączonych identyfikatorów z uprawnieniami tylko do odczytu.
Podczas konwertowania klienta publicznego interfejsu API na klienta interfejsu API członka Warunki świadczenia usług dla klientów publicznych nie mają już zastosowania i są zastępowane warunkami Umowy członkowskiej.
Do przelewu potrzebowalibyśmy:
- Potwierdzenie publicznego identyfikatora klienta API, który ma zostać przekonwertowany.
- Aby główny kontakt organizacji i posiadacz rekordu bieżącego identyfikatora klienta Public API zgodzili się ze zmianą w Warunkach korzystania z usługi. (Posiadacz rekordu musi być pracownikiem, kontrahentem lub urzędnikiem organizacji członkowskiej) Będziemy przechowywać zapis zgody obu stron.
- Data/godzina migracji. W ramach tej migracji zaktualizujemy identyfikator klienta i wyślemy Ci nowy sekret klienta w zaszyfrowanej wiadomości e-mail. Należy pamiętać, że po zaktualizowaniu klienta Twoja integracja nie będzie działać, dopóki nie zaktualizujesz sekretu klienta. Dlatego musimy ustalić datę i godzinę, aby to zrobić i zapobiec niedogodnościom dla użytkowników.
Aby konwersja została zakończona, musisz zaktualizować:
- Stary klucz klienta do nowego klucza klienta.
- Host API z pub.orcid.org do api.orcid.org.
Za pomocą przekonwertowanego identyfikatora klienta Member API możesz zaktualizować zakresy do dodania zakresy członkowskich API. Będzie to wymagało autoryzacji od użytkowników, a nowe tokeny dostępu zostaną wygenerowane w celu uwzględnienia nowych zakresów/uprawnień.
Należy pamiętać, że nie jesteśmy w stanie przekonwertować poświadczeń klientów Member API na poświadczenia publicznego API.
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.
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.
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.
Zalecamy, aby programiści przetestowali publiczny interfejs API w serwer testowy piaskownicy przed użyciem wersji produkcyjnej. Poniżej znajdują się kroki dotyczące rejestracji w celu uzyskania poświadczeń publicznych interfejsów API zarówno w środowisku piaskownicy, jak i 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 świadczenia usług dla klientów publicznych
- Kliknij przycisk „Zarejestruj się ORCID przycisk poświadczeń publicznego interfejsu 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.
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.)
- Przedstaw ekran autoryzacji OAuth zgodnie z naszymi wytyczne
- Uwzględnij ORCID markowy przycisk lub link w Twojej witrynie, aby zainicjować uwierzytelnianie identyfikatora.
- 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.
- Czy nie poproś użytkowników o zmianę ustawień widoczności elementów na ich kontach ORCID record, aby skorzystać z integracji.
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
Kreatory wyszukiwania i łączenia to integracje, za pomocą których można importować elementy (głównie prace) do ORCID Rejestr. Muszą przejść testy między integratorem a ORCID zanim będą mogły zostać zwolnione do środowiska rejestru produkcyjnego.
W zależności od Twoich odpowiedzi na poniższe pytania, Twoja integracja może być odpowiednim kandydatem do wyszukiwania i łączenia — skontaktuj się z nami, aby omówić to dokładniej przed rozpoczęciem tworzenia kreatora wyszukiwania i łączenia:
- Jaka jest grupa docelowa kreatora? Na przykład autorzy, recenzenci lub osoby ubiegające się o granty na poziomie krajowym, dyscyplinarnym lub globalnym
- Jak duża jest spodziewana publiczność?
- Czy będzie służyć populacji, która jest obecnie niedostatecznie obsłużona przez istniejących czarodziejów? Na przykład wkład w badania w określonym języku lub dyscyplinie, lub które są nowatorskiego typu
- W jaki sposób zapewnisz, że kreator zapewnia dobre wrażenia użytkownika?
- Jakie wsparcie dla użytkowników będziesz zapewniać?
- Czy istnieje — lub będzie — ORCID wskazać osobę w Twojej organizacji, na przykład kierownika produktu, dla kreatora?
- Jak to zapewnisz ORCID identyfikatory są uwierzytelnione?
- Czy – lub będziesz – spożywać i wyświetlać ORCID iDs na Twojej platformie?
- Czy wyszukiwanie na Twojej platformie jest obsługiwane przez iDs?
Zapoznaj się z naszą Przepływ pracy wyszukiwania i łączenia by uzyskać więcej szczegółów.
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
Webhooki pozwalają członkom premium „oglądać” ORCID ewidencji i być powiadamianym o wszelkich zmianach.
Korzystając z interfejsu API i poświadczeń klienta członka premium, członkowie premium mogą zarejestrować adres URL wywołania zwrotnego dla każdego uwierzytelnionego ORCID iD które chcą śledzić. The ORCID posiadacz rekordu nie musi udzielać organizacji konkretnego zezwolenia na rejestrację adresu URL, ale rzeczywista wymiana danych opiera się na poziomach prywatności określonych przez ORCID iD uchwyt.
Mając to na miejscu ORCID powiadomi ten określony adres URL, wysyłając żądanie, gdy nastąpią zmiany w ORCID rekord.
Metadane
Wszystkie sekcje przynależności używają tego samego zestawu metadanych w interfejsie API:
- Nazwa organizacji:* Nazwa organizacji na najwyższym szczeblu (np. „Boston University” zamiast „Boston University School of Medicine”).
- Miasto organizacji:* Miasto, w którym mieści się siedziba organizacji.
- Region organizacji: Region, w którym znajduje się siedziba organizacji.
- Kraj organizacji* kraj organizacji. To powinno być wypełnione przez dwuliterowy kod kraju ISO 3166 Alpha-2.
- Identyfikator organizacji (ROR, GRID, Ringgold** lub LEI):* Unikalny identyfikator organizacji i jej źródła. Zalecamy, aby identyfikator organizacji nadrzędnej był używany w ramach afiliacji, a nie w dziale lub departamencie.
- Rola/tytuł: Zajmowane stanowisko lub stopień naukowy przyznany lub mający zostać przyznany.
- Wydział: Dowolny oddział organizacji macierzystej.
- URL: Adres URL do zasobu dotyczącego przynależności
- Data rozpoczęcia: Data rozpoczęcia relacji między badaczem a organizacją (można określić z dokładnością do roku, miesiąca i dnia).
- Data końcowa: Data zakończenia relacji między badaczem a organizacją (można określić z dokładnością do roku, miesiąca i dnia)
- Zewnętrzny trwały identyfikator opisujący przynależność: Unikalny identyfikator rzeczywistej asercji przynależności
*Wskazuje wymagane pole.
** Chociaż identyfikatory Ringgold nadal istnieją w ramach ORCID rejestru, stan na dzień 1 sierpnia 2023 r., ORCID nie otrzymuje już aktualizacji bazy danych identyfikatorów organizacji RINGGOLD wykorzystywanej przez nasz Rejestr, ani nie będziemy mogli przetwarzać ani wykorzystywać identyfikatorów RINGGOLD utworzonych po tej dacie. Zobacz nasze FAQ więcej informacji.
Istnieje wiele sekcji w części biograficznej an ORCID rekord:
Znany również jako: Może to obejmować skrócone imię, warianty, w tym inicjały jednego lub więcej imion, drugie imię (imiona), poprzednie lub zastępcze imiona lub imiona w innym zestawie znaków. Każda nazwa powinna być dodana jako pojedyncza pozycja. To jest pole tekstowe o długości do 255 znaków.
strony: Ta sekcja zawiera opis (opcjonalnie) i adres URL witryny (wymagany)
Kraj: Sekcja krajowa an ORCID Record pozwala naukowcom i organizacjom członkowskim dodać jeden lub więcej krajów, w których prowadzą badania lub które są tematem ich badań. Pozycje na liście krajów pochodzą z ISO 3166, międzynarodowego standardu kodów krajów i regionów.
Identyfikatory zewnętrzne (inne identyfikatory): Ta sekcja może być dodana tylko przez organizacje członkowskie. Należy pamiętać, że chociaż wiele organizacji zbiera inne zewnętrzne identyfikatory dla swoich badaczy, np. identyfikatory autorów Scopus, tylko wystawca tych identyfikatorów może je autorytatywnie potwierdzić. Dlatego zdecydowanie zalecamy, aby Twoja organizacja dodawała tylko identyfikatory utworzone przez Twój system (systemy) i używane do identyfikowania badaczy. Ta sekcja zawiera cztery komponenty (* oznacza wymagane pole):
- Typ identyfikatora*
- wartość identyfikatora*
- związek identyfikacyjny*
- Adres URL identyfikatora
- Tytuł:* Tytuł pracy
- Podtytuł: Podtytuł pracy
- Przetłumaczony tytuł: Tytuł pracy występuje w innym języku, język przetłumaczonego tytułu jest zapisywany jako atrybut
- Tytuł czasopisma: Nazwa większej kolekcji, do której należy praca, na przykład czasopismo dla artykułów z czasopism lub książka dla rozdziałów w książkach. Nawet jeśli jest to oznaczony tytułem czasopisma, można go użyć do innych prac
- Krótki opis: Krótki opis lub streszczenie pracy
- Typ cytatu: Format, w jakim podany jest cytat. To pole jest wybierane z listy zawierającej następujące wartości: APA, BIBTEX, CHICAGO, HARVARD, IEEE, MLA, RIS, UNSPECIFIED, VANCOUVER
- Wartość cytatu: Treść cytatu
- Rodzaj pracy: Rodzaj obiektu, którym jest praca. To pole należy wybrać z obsługiwane rodzaje pracy
- Data publikacji: Data publikacji pracy. Zalecamy stosowanie najwcześniejszej daty publikacji
- Zewnętrzny typ identyfikatora:* Typ identyfikatora. To pole należy wybrać z obsługiwane identyfikatory pracy
- Wartość-identyfikatora-zewnętrznego:* Sam identyfikator
- Adres URL zewnętrznego identyfikatora: Adres URL, do którego odnosi się identyfikator
- Relacja-identyfikatora-zewnętrznego:* Identyfikatory odnoszące się tylko do dodawanej pracy zostaną oznaczone jako Własne. Identyfikatory odnoszące się do większej kolekcji, do której należy ta praca, zostaną ustawione na Część. Identyfikatory odnoszące się do alternatywnych wersji pracy zostaną ustawione na wersję. Identyfikatory odnoszące się do finansowania pracy zostaną ustawione na finansowane przez.
- URL do pracy: Adres URL prowadzący do pracy
- Współtwórcy pracy: Informacje o osobach, które stworzyły dzieło
- Kod języka: Język używany do opisu pracy w poprzednich polach
- Kraj: Kraj, w którym praca została opublikowana lub z którym jest w inny sposób powiązana
* Wskazuje wymagane pole
Istnieje wiele rodzajów zasobów badawczych, od odczynników jednorazowego użytku po międzynarodową współpracę z dedykowanymi obiektami. ORCID obsługuje model wysokiego poziomu, który może łączyć się z innymi miejscami w celu uzyskania szczegółów specyficznych dla domeny.
Istnieją cztery typy zasobów wysokiego poziomu:
Rodzaj zasobu | Definicja | Przykłady |
Infrastruktura | Obiekt, budynek lub inna fizyczna przestrzeń używana do prowadzenia badań | Źródło spallacji neutronów, obiekt dla zwierząt, enklawa danych, stanowisko archeologiczne, układ teleskopów. statki, samoloty, farmy, laboratoria |
Collection | Obiekt lub zespół obiektów wykorzystywany do celów badawczych; może być materialny lub cyfrowy | Misja oceaniczna, kampania terenowa, wspólne zestawy danych lub zasoby, kolekcja rzadkich książek; kolekcja muzealna, kolekcja okazów biologicznych |
Wyposażenie | Sprzęt używany do celów badawczych | Mikroskop, komputery, szkło, próbki, materiały |
Usługi | Usługi wykorzystywane do celów badawczych | Analiza proteomiczna, usługi komputerowe, analiza danych, wsparcie logistyczne, obsługa prawna, redakcja, doradztwo eksperckie lub pracownicze |
Oprócz typu zasobu, element zasobu badawczego w ramach ORCID rekord zawiera następujące informacje. * wskazuje wymagane pozycje
- Tytuł wniosku/rejestracji:* Jest to główne pole wyświetlania zasobów badawczych, np. „Nagroda wiązki neutronów” lub „Czas wiązki i zasoby obliczeniowe”
- Identyfikator wniosku/rejestracji:* Jest to publiczny identyfikator (DOI, PURL itp.) propozycji lub prośby o wykorzystanie zasobu. Idealnie byłoby, gdyby ten identyfikator był trwały i wskazywał na publiczną stronę docelową z informacjami o propozycji lub prośbie, taką jak baza danych nagród lub dziennik użytkownika zasobów.
- Gospodarze propozycji:* Jest to organizacja, która otrzymuje i przetwarza propozycje zasobów lub żądania. Host propozycji może być tym samym, co Host zasobu
- Identyfikator organizacji przyjmującej propozycję* To jest publiczny identyfikator (jeden z następujących: ROR, GRID, Open Funder ID, LEI) organizacji zarządzającej procesem wniosku lub wniosku
- Zasoby):* (do 100)
- Nazwa zasobu:* – np. „Źródło spalacji neutronów”
- Identyfikatory zasobów:* – z rozszerzalnej listy akceptowanych typów PID (np. RRID, DOI, URI)
- Typ zasobu:* – jedna z „Infrastruktur”, „Kolekcje”, „Wyposażenie” lub „Usługi”
- Host zasobów:* Jest to organizacja, która administruje Zasobem lub go obsługuje, na przykład krajowe laboratorium, agencja rządowa lub uniwersytet badawczy
- Identyfikator organizacji przyjmującej zasób:* Jest to publiczny identyfikator (jeden z ROR, GRID, Ringgold**, Open Funder ID, LEI) organizacji hostującej zasób
- URL oferty: Link do wniosku
- Data rozpoczęcia oferty: Data rozpoczęcia dostępu
- Data zakończenia oferty pakietowej: Data zakończenia lub zakończenia dostępu
* Wskazuje wymagane pole
** Chociaż identyfikatory Ringgold nadal istnieją w ramach ORCID rejestru, stan na dzień 1 sierpnia 2023 r., ORCID nie otrzymuje już aktualizacji bazy danych identyfikatorów organizacji RINGGOLD wykorzystywanej przez nasz Rejestr, ani nie będziemy mogli przetwarzać ani wykorzystywać identyfikatorów RINGGOLD utworzonych po tej dacie. Zobacz nasze FAQ
więcej informacji.
- Rola:* Rola jednostki w procesie recenzji, którą można wybrać spośród: przewodniczący, redaktor, członek, organizator, recenzent
- Identyfikator grupy:* Identyfikator grupy używany do celów agregacji — w przypadku artykułów w czasopismach domyślnym identyfikatorem jest eISSN, który jest automatycznie wypełniany poprzez integrację z bazą danych ISSN. Należy pamiętać, że jeśli trzeba przypisać identyfikator inny niż ISSN, należy utwórz go wcześniej.
- Organizacja zwołująca*: Organizacja, która zorganizowała przegląd – wydawca czasopisma, organizator konferencji, agencja finansująca, wykładowca itp
- Identyfikator organizacji: Trwały identyfikator organizacji zwołującej. Obecnie obsługujemy identyfikatory ROR, Ringgold**, GRID, LEI lub Crossref Funder Registry. Uwaga: nie jest to pole obowiązkowe, ale zalecamy zamieszczenie tych danych, jeśli je posiadasz.
- Przejrzyj dane:* Te dane odnoszą się do czynności przeglądu, a nie do tego, co zostało sprawdzone
- Typ: Rodzaj czynności przeglądowej: przegląd lub ocena
- Data: Data zakończenia przeglądu. Może to być szerokie (2008) lub szczegółowe (2010-12-10)
- Identyfikator recenzji: Unikalny, najlepiej rozwiązywalny identyfikator dostarczone przez źródło recenzji. O ile recenzja nie jest ogólnie dostępna, zalecamy, aby nie zawierała danych umożliwiających identyfikację, które można powiązać z przedmiotem recenzji
- URL recenzji: Łącze do prezentacji recenzji lub rekordu recenzji online
- Informacje o przedmiocie recenzji: Niezależnie od tego, co sprawdził recenzent
- Rodzaj przedmiotu: Rodzaj recenzowanej pozycji, np. artykuł w czasopiśmie, referat konferencyjny
- Obejmuje to wykaz typów prac ORAZ wykaz rodzajów dotacji („grant”, „kontrakt”, „nagroda”, „wynagrodzenie”) ORAZ „propozycja zasobów” ORAZ „nieokreślony”
- Nazwa przedmiotu: Nazwa recenzowanego elementu
- Identyfikator zewnętrzny podmiotu: Unikalny identyfikator przedmiotu recenzji, np. DOI artykułu
- Nazwa kontenera podmiotu: Nazwa obiektu, którego częścią jest temat recenzji, np. konferencja, dla której praca była recenzowana
- Adres URL tematu: Adres URL sprawdzanego tematu
- Rodzaj przedmiotu: Rodzaj recenzowanej pozycji, np. artykuł w czasopiśmie, referat konferencyjny
* Wskazuje wymagane pole
** Chociaż identyfikatory Ringgold nadal istnieją w ramach ORCID rejestru, stan na dzień 1 sierpnia 2023 r., ORCID nie otrzymuje już aktualizacji bazy danych identyfikatorów organizacji RINGGOLD wykorzystywanej przez nasz Rejestr, ani nie będziemy mogli przetwarzać ani wykorzystywać identyfikatorów RINGGOLD utworzonych po tej dacie. Zobacz nasze FAQ
więcej informacji.
- Rodzaj finansowania:* Rodzaj przyznanego dofinansowania, To pole jest wybierane z listy zawierającej następujące wartości: Nagroda, Kontrakt, Grant, Wynagrodzenie-nagroda
- Tytuł finansowania:* Tytuł pozycji finansowania
- Podtytuł: Podtytuł elementu finansowania
- Przetłumaczony tytuł: Tytuł, pod którym finansowanie pojawia się w innym języku, język przetłumaczonego tytułu jest zapisywany jako atrybut
- Opis Projektu: Opis lub krótkie streszczenie finansowanego projektu.
- Ilość: Wartość nagrody
- Niepowtarzalny identyfikator finansowania: Dodaj tyle z nich, ile twój system jest świadomy, ponieważ pomaga to w grupowaniu ORCID Records.
- Typ identyfikatora finansowania: Użyj numeru grantu, DOI, URI lub identyfikatora wniosku
- Wartość identyfikatora
- Adres URL identyfikatora (opcjonalnie)
- Relacja: ja/część
Ma to na celu wskazanie relacji pozycji finansowania do identyfikatora. Na przykład, jeśli pozycja finansowania dotyczy jednej fazy dotacji wieloczęściowej, a identyfikator dotyczy dotacji wieloczęściowej, wówczas relacja będzie miała postać „część”; jeśli identyfikator dotyczy indywidualnej fazy, wówczas relacja będzie miała postać „ja”.
- Agencja finansująca (organizacja):* Informacje o organizacji, która przyznała dofinansowanie
- Nazwa agencji
- Adres (miasto i kraj)
- Identyfikator organizacji:
- Data rozpoczęcia: Data rozpoczęcia finansowania
- Data końcowa: Data zakończenia finansowania
- Informacje o współtwórcach: Informacje o osobach, które otrzymały dofinansowanie
- ORCID ID: Opona ORCID iD każdego współpracownika do projektu finansowania; powinno to obejmować tylko uwierzytelnione ORCID identyfikatory
- Rola: Charakter wkładu badacza
* Wskazuje wymagane pole
Wszystkie sekcje przynależności używają tego samego zestawu metadanych w interfejsie API:
- Nazwa organizacji:* Nazwa organizacji na najwyższym poziomie (np. „Boston University” zamiast „Boston University School of Medicine”).
- Miasto organizacji:* Miasto, w którym mieści się siedziba organizacji.
- Region organizacji: Region, w którym znajduje się siedziba organizacji.
- Kraj organizacji* kraj organizacji. To powinno być wypełnione przez dwuliterowy kod kraju ISO 3166 Alpha-2.
- Identyfikator organizacji (ROR, GRID, Ringgold** lub LEI):* Unikalny identyfikator organizacji i jej źródła. Zalecamy, aby identyfikator organizacji nadrzędnej był używany w ramach afiliacji, a nie w dziale lub departamencie.
- Rola/tytuł: Zajmowane stanowisko lub stopień naukowy przyznany lub mający zostać przyznany.
- Wydział: Dowolny oddział organizacji macierzystej.
- URL: Adres URL do zasobu dotyczącego przynależności
- Data rozpoczęcia: Data rozpoczęcia relacji między badaczem a organizacją (można określić z dokładnością do roku, miesiąca i dnia).
- Data końcowa: Data zakończenia relacji między badaczem a organizacją (można określić z dokładnością do roku, miesiąca i dnia)
- Zewnętrzny trwały identyfikator opisujący przynależność: Unikalny identyfikator rzeczywistej asercji przynależności
*Wskazuje wymagane pole.
** Chociaż identyfikatory Ringgold nadal istnieją w ramach ORCID rejestru, stan na dzień 1 sierpnia 2023 r., ORCID nie otrzymuje już aktualizacji bazy danych identyfikatorów organizacji RINGGOLD wykorzystywanej przez nasz Rejestr, ani nie będziemy mogli przetwarzać ani wykorzystywać identyfikatorów RINGGOLD utworzonych po tej dacie. Zobacz nasze FAQ więcej informacji.
Wszystkie sekcje przynależności używają tego samego zestawu metadanych w interfejsie API:
- Nazwa organizacji:* Nazwa organizacji na najwyższym poziomie (np. „Boston University” zamiast „Boston University School of Medicine”).
- Miasto organizacji:* Miasto, w którym mieści się siedziba organizacji.
- Region organizacji: Region, w którym znajduje się siedziba organizacji.
- Kraj organizacji* kraj organizacji. To powinno być wypełnione przez dwuliterowy kod kraju ISO 3166 Alpha-2.
- Identyfikator organizacji (ROR, GRID, RInggold** lub LEI):* Unikalny identyfikator organizacji i jej źródła. Zalecamy, aby identyfikator organizacji nadrzędnej był używany w ramach afiliacji, a nie w dziale lub departamencie.
- Rola/tytuł: Zajmowane stanowisko lub stopień naukowy przyznany lub mający zostać przyznany.
- Wydział: Dowolny oddział organizacji macierzystej.
- URL: Adres URL do zasobu dotyczącego przynależności
- Data rozpoczęcia: Data rozpoczęcia relacji między badaczem a organizacją (można określić z dokładnością do roku, miesiąca i dnia).
- Data końcowa: Data zakończenia relacji między badaczem a organizacją (można określić z dokładnością do roku, miesiąca i dnia)
- Zewnętrzny trwały identyfikator opisujący przynależność: Unikalny identyfikator rzeczywistej asercji przynależności
*Wskazuje wymagane pole.
** Chociaż identyfikatory Ringgold nadal istnieją w ramach ORCID rejestru, stan na dzień 1 sierpnia 2023 r., ORCID nie otrzymuje już aktualizacji bazy danych identyfikatorów organizacji RINGGOLD wykorzystywanej przez nasz Rejestr, ani nie będziemy mogli przetwarzać ani wykorzystywać identyfikatorów RINGGOLD utworzonych po tej dacie. Zobacz nasze FAQ więcej informacji.
Wszystkie sekcje przynależności używają tego samego zestawu metadanych w interfejsie API:
- Nazwa organizacji:* Nazwa organizacji na najwyższym poziomie (np. „Boston University” zamiast „Boston University School of Medicine”).
- Miasto organizacji:* Miasto, w którym mieści się siedziba organizacji.
- Region organizacji: Region, w którym znajduje się siedziba organizacji.
- Kraj organizacji* kraj organizacji. To powinno być wypełnione przez dwuliterowy kod kraju ISO 3166 Alpha-2.
- Identyfikator organizacji (ROR, Ringgold**, GRID lub LEI):* Unikalny identyfikator organizacji i jej źródła. Zalecamy, aby identyfikator organizacji nadrzędnej był używany w ramach afiliacji, a nie w dziale lub departamencie.
- Rola/tytuł: Zajmowane stanowisko lub stopień naukowy przyznany lub mający zostać przyznany.
- Wydział: Dowolny oddział organizacji macierzystej.
- URL: Adres URL do zasobu dotyczącego przynależności
- Data rozpoczęcia: Data rozpoczęcia relacji między badaczem a organizacją (można określić z dokładnością do roku, miesiąca i dnia).
- Data końcowa: Data zakończenia relacji między badaczem a organizacją (można określić z dokładnością do roku, miesiąca i dnia)
- Zewnętrzny trwały identyfikator opisujący przynależność: Unikalny identyfikator rzeczywistej asercji przynależności
*Wskazuje wymagane pole.
** Chociaż identyfikatory Ringgold nadal istnieją w ramach ORCID rejestru, stan na dzień 1 sierpnia 2023 r., ORCID nie otrzymuje już aktualizacji bazy danych identyfikatorów organizacji RINGGOLD wykorzystywanej przez nasz Rejestr, ani nie będziemy mogli przetwarzać ani wykorzystywać identyfikatorów RINGGOLD utworzonych po tej dacie. Zobacz nasze FAQ więcej informacji.
An ORCID rekord może zawierać informacje o pracy naukowca, przynależnościach, finansowaniu, recenzowaniu i nie tylko.
Przedmioty włączone ORCID rekordy można podzielić na twierdzenia które łączą ORCID Posiadacz identyfikatora z działalnością lub afiliacją. Twierdzenia te można dodać do ORCID przez badacza, który jest właścicielem danych, lub przez systemy, na które badacz udzielił pozwolenia. Podmiot, który dodał asercję, nazywamy an ORCID nagraj źródło.
Przykłady
Zgodnie z naszymi zasadami przejrzystości i otwartości uważamy, że ważne jest, aby móc zobaczyć źródło twierdzenia — kto dodaje te informacje do akt. Oto jak to robimy:
- Kiedy badacz (lub osoba przez niego delegowana zaufana osoba) dodaje stwierdzenie do swojego rekordu, ORCID automatycznie rejestruje tę osobę jako źródło
- Kiedy system zatwierdzony przez badacza dodaje asercję do rekordu, ORCID automatycznie rejestruje właściciela systemu (an ORCID członek) jako źródło.
Nazwę źródła wyświetlamy w interfejsie użytkownika i udostępniamy (wraz z jej unikalnym identyfikatorem) w API:
Jednak przepływy pracy związane z wyszukiwaniem informacji mogą być bardziej skomplikowane, a prawdziwe źródło twierdzenia może zostać przypadkowo przesłonięte przez jeden system dodający element w imieniu osoby lub innego systemu. Aby zapewnić przejrzystość, musimy rozróżnić, kto stworzył połączenie między osobą a elementem oraz kto dodał element do rekordu. Jak wyżej, ktokolwiek doda element do pliku ORCID rekord jest źródło; kto tworzy połączenie między ORCID iD a przedmiotem jest pochodzenie twierdzenia.
Na przykład:
- Badacz importuje dane do swojego ORCID rekord z systemu, takiego jak kreator wyszukiwania i łączenia. Badacz formułuje twierdzenie łączące ich iD z przedmiotem, więc są pochodzenie twierdzenia; podczas gdy system jest podmiotem dodającym asercję do ORCID rekord — ew źródło
- Badacz wchodzi w interakcję z Systemem A (tzw twierdzenie oryg), która korzysta z usług świadczonych przez System B do aktualizacji ORCID rekordy, czyniąc System B źródło
Zachęcamy naszą społeczność do zaangażowania się w podejmowanie kroków w celu zachowania i udostępniania informacji o pochodzeniu twierdzeń, aby każdy mógł skorzystać z poznania źródła.
Aby uzyskać więcej informacji, zobacz:
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.
ORCID pozwala na dodanie kilku typów prac. Poniżej znajduje się lista aktualnie obsługiwanych typów prac, która jest w dużej mierze zgodna ze standardem wyjściowym CASRAI.
Publikacje
Rodzaj pracy | Zastosowanie |
książka | Książki napisane przez jednego autora lub wspólnie, oparte na badaniach lub odkryciach naukowych, generalnie pochodzących z recenzowanego finansowania. |
Rozdział książki | Teksty napisane przez jednego autora lub wspólnie, oparte na badaniach lub odkryciach naukowych i wiedzy specjalistycznej w danej dziedzinie. |
recenzja książki | Krytyczna recenzja dzieł beletrystycznych lub non-fiction, podkreślająca wkład w sztukę, dziedzinę lub dyscyplinę. |
wpis do słownika | Wpisy nowych słów, nowe znaczenia istniejących słów, zmiany pisowni i dzielenia wyrazów w dłuższym okresie czasu oraz zmiany gramatyczne. |
rozprawa | Traktat przedstawiający oryginalny punkt widzenia wynikający z badań: warunek uzyskania stopnia doktora. Jest to dostępne tylko z interfejsem API v2.x |
praca dyplomowa | Artykuł, który zazwyczaj opiera się na oryginalnych badaniach i który stanowi dowód opanowania przez kandydata zarówno własnego przedmiotu, jak i metody naukowej. Jest to dostępne tylko z interfejsem API v3.0+ |
encyklopedia-wpis | Autorskie wpisy w pracy referencyjnej lub kompendium skupiające się na określonej dziedzinie lub na wszystkich gałęziach wiedzy. |
zredagowana książka | Książki redagowane przez jednego autora lub wspólnie w celu rozpowszechniania wyników badań lub wyników naukowych, które na ogół wynikają z recenzowanego finansowania. |
artykuł w czasopiśmie | Artykuły w recenzowanych publikacjach, które rozpowszechniają wyniki oryginalnych badań i stypendiów. |
wydanie dziennika | Okresowe publikacje mające na celu wspieranie intelektualnej debaty i dociekań. |
artykuł w gazecie | Artykuły w publikacjach tematycznych ukazujących się w ustalonych odstępach czasu. |
podręcznik | Materiały do kursów i zadań przygotowane do celów dydaktycznych. |
zasoby online | Informacje dostępne tylko w Internecie za pomocą tradycyjnych metod technicznych |
artykuł w biuletynie | Artykuły w publikacjach skierowanych do badaczy, decydentów, specjalistów i opinii publicznej, które relacjonują projekt badawczy lub działalność katedry lub ośrodka badawczego. |
artykuł w gazecie | Artykuły w dzienniku, tygodniku lub miesięczniku informujące o nowościach i problemach społecznych skierowane do ogółu społeczeństwa. |
przedruk | Wersja artykułu udostępniona publicznie przed formalną recenzją i publikacją. Jest to dostępne tylko z interfejsem API v3.0+ |
raport | Raporty rozpowszechniające wyniki i rezultaty kontraktu badawczego. |
przeglądu | Formalna ocena pracy innej osoby. Jest to dostępne tylko z interfejsem API v3.0+ |
narzędziem badawczym | Seria obserwacji, pomiarów lub faktów zidentyfikowanych na podstawie badań. |
nadzorowana-publikacja studencka | Artykuły dotyczące wyników badań opublikowane wspólnie z promotorem lub pod jego nadzorem. |
test | Oceny, które obejmują testy przeznaczone do ogólnej selekcji na uniwersytet, selekcji na określone kursy lub do innych celów oceny. |
tłumaczenie | Tłumaczenia książek i artykułów, które identyfikują modyfikacje oryginalnego wydania, takie jak nowa lub poprawiona przedmowa. |
Zbieranie danych analitycznych o stronach internetowych lub aplikacjach (aby sprawdzić, czy strona działa poprawnie lub które sekcje strony są najbardziej atrakcyjne dla odwiedzających). | Samodzielne lokalizacje w sieci, w których dostępnych jest wiele rodzajów informacji na określony temat. |
dokument roboczy | Wstępne wersje artykułów, które nie zostały poddane recenzji, ale które można udostępnić w celu skomentowania. |
Konferencja
Rodzaj pracy | Zastosowanie |
Konferencja-abstrakt | Teksty o określonej długości, określające problematykę, która ma być omówiona w proponowanym referacie konferencyjnym. |
referat konferencyjny | Artykuły napisane samodzielnie lub wspólnie, zaprezentowane na konferencji naukowej i opublikowane w materiałach (nie w czasopismach naukowych). |
plakat konferencyjny | Plakaty wyświetlane w warunkach konferencyjnych i przekazujące najważniejsze informacje badawcze w efektywny sposób za pomocą atrakcyjnej grafiki. |
Własność intelektualna
Rodzaj pracy | Zastosowanie |
ujawnienie | Publikacje, które uznają wynalazki za stan techniki, uniemożliwiając w ten sposób innym patentowanie tego samego wynalazku lub koncepcji. |
licencja | Podpisane umowy na wykorzystanie części własności intelektualnej, takiej jak proces, produkt, dane lub oprogramowanie. |
patent | Forma ochrony własności intelektualnej, która definiuje wyłączne prawo wynalazców i cesjonariuszy do korzystania z ich wynalazków, produktów lub procesów przez ograniczony czas. |
zarejestrowane-prawa autorskie | Zarejestrowana własność praw w ramach systemu praw promujących zarówno tworzenie, jak i dostęp do dzieł artystycznych, literackich, muzycznych, dramatycznych i innych dzieł twórczych. |
towarowym | Znaki, takie jak nazwa, słowo, fraza, logo, symbol, wzór, wizerunek produktu lub usługi, które wskazują źródło i dają prawo do kontrolowania wykorzystania identyfikatora. |
Inne
Rodzaj pracy | Zastosowanie |
adnotacja | Adnotacje zawierają komentarze lub opisy dotyczące innego zasobu. Jest to dostępne tylko z interfejsem API v3.0+ |
występ artystyczny | Zbiór zapisów informacyjnych, które łącznie reprezentują pełną i aktualną historię twórczości artystycznej lub performatywnej wynikającej z badań lub działalności naukowej danej osoby lub z nią związanej. |
plan zarządzania danymi | Formalne oświadczenie opisujące, w jaki sposób dane badawcze będą zarządzane i dokumentowane w trakcie projektu badawczego oraz warunki dotyczące późniejszego zdeponowania danych w repozytorium danych w celu długoterminowego zarządzania i przechowywania. Jest to dostępne tylko z interfejsem API v3.0+ |
zestaw danych | Seria ustrukturyzowanych obserwacji, pomiarów lub faktów zidentyfikowanych podczas badań, które mogą być przechowywane na nośniku bazy danych. |
wynalazek | Praktyczne i oryginalne wyniki badań. |
wykład-mowa | Pouczające przemówienie dotyczące badań wygłoszone dla publiczności. |
Obiekt fizyczny | Okaz, próbka lub inny obiekt fizyczny używany do celów badawczych; nieożywiony trójwymiarowy obiekt lub substancja. Jest to dostępne tylko z interfejsem API v3.0+ |
technika badawcza | Praktyczne metody lub umiejętności zastosowane do określonych zadań zidentyfikowanych w ramach badania. |
oprogramowanie | Program służący do obsługi komputera lub innego urządzenia technicznego. |
firma typu spin-off | Firma założona przez organizację badawczą w celu komercyjnego wykorzystania wyników i ustaleń projektu badawczego. |
standardy-i-polityka | Opracowanie reguły lub zasady, która jest używana jako podstawa do osądu. |
standard techniczny | Standardy techniczne (przemysłowe lub inne), które wywodzą się z projektów badawczych, w ramach których można opracować nowe protokoły, metody lub materiały. |
inny | Każdy inny rodzaj pracy. |
Zapoznaj się z naszą lista obsługiwanych identyfikatorów dla interfejsu API w wersji 3.0. Od czasu do czasu dodajemy nowe typy na prośbę ORCID członków, którzy chcieliby z nich korzystać przy dodawaniu pozycji do rejestru.
ORCID popiera użycie identyfikatory ROR, identyfikatory GRID i Rejestr fundatorów krzyżowych identyfikatory w celu ujednoznacznienia organizacji ORCID Records.
Aby uzyskać więcej informacji, zobacz Praca z identyfikatorami organizacji
Chociaż identyfikatory Ringgold nadal istnieją w ramach ORCID rejestru, stan na dzień 1 sierpnia 2023 r., ORCID nie otrzymuje już aktualizacji bazy danych identyfikatorów organizacji RINGGOLD wykorzystywanej przez nasz Rejestr, ani nie będziemy mogli przetwarzać ani wykorzystywać identyfikatorów RINGGOLD utworzonych po tej dacie. Zobacz nasze FAQ więcej informacji
Wprowadziliśmy nowe pole generowane przez system, które wyraża zewnętrzne identyfikatory (DOI, PMCID, PMID, ArXiv, Bibcode, ISSN i ISBN) w znormalizowanym formacie na potrzeby dopasowywania i grupowania. Normalizacja odbywa się w oparciu o reguły typu identyfikatora i może polegać na ustawieniu wszystkich znaków alfanumerycznych na małe lub przekształceniu spacji, myślników, kropek i innych znaków, które można traktować jako równoważne. W razie potrzeby dodaje również standardowe przedrostki i przyrostki. Na przykład, https://doi.org/10.1/123, 10.1/123, https://dx.doi.org/10.1/123 wszystkie pojawią się w tym polu jako https://doi.org/10.1/123. Istniejąca wartość identyfikatora jest niezmodyfikowana.
- Imię
- Dodatkowy
Role dla Works API 2.0
Poniżej znajduje się lista obsługiwanych ról kontrybutorów korzystających z interfejsu API 2.0.- autor
- mandatariusz
- redaktor
- krzesło-lub-tłumacz
- współbadacz
- współtwórca
- absolwent-student
- inny wynalazca
- główny śledczy
- habilitowany naukowiec
- personel pomocniczy
Role dla Works API 3.0
Dzięki API 3.0 możesz dodać powyższe role oraz dodatkowe role CRedIT. Taksonomia CRediT składa się z 14 rodzajów wkładu w pracę naukową, wraz z wytycznymi dotyczącymi sposobu przypisania tych ról. Poniżej znajduje się pełna lista z wartością interfejsu użytkownika i wartością metadanych. Wartość metadanych to adres URL zgodnie z zaleceniami dotyczącymi wdrożenia NISO „CRediT należy zakodować w JATS xml v1.2, opisanym pod tym linkiem: https://jats4r.org/credit-taxonomy.' Podczas dodawania ról poprzez API akceptowany będzie wyłącznie adres URL.Przykładowe metadane współtwórcy pracy:
https://orcid.org/0000-0001-5109-3700 0000-0001-5109-3700 orcid.org Laure L. Haak first author
Role do finansowania
- prowadzić
- współprowadzący
- wspierany przez
- inny wkład
ORCID zapewnia pole cytatów z wolnym tekstem, dzięki czemu badacze mogą łatwo wprowadzać informacje w formacie tekstowym. Jednak gorąco zachęcamy wszystkich użytkowników API do dodawania cytatów w BibTeX, który jest odczytywalny maszynowo. Czcigodny format, pomimo wcześniejszej datowania internetu, może zostać przekształcony w pożądany format przez integracje i autorów. Jest obsługiwany przez większość menedżerów referencji i platform wydawniczych
Aby uzyskać więcej informacji na temat BibTeX-a, zobacz https://www.bibtex.org.
Każdy autor, którego wydawca używa Crossref do rejestracji DOI, może skorzystać z integracji automatycznej aktualizacji Crossref.
Wydawcy muszą dołączyć uwierzytelnione ORCID iD dla ich autorów w ramach metadanych przesyłanych do Crossref przy rejestracji DOI.
Crossref poprosi następnie autora o pozwolenie, wysyłając mu powiadomienie ORCID skrzynkę odbiorczą, aby zaktualizować swoje ORCID nagrywać z tą publikacją i wszelkimi nowymi publikacjami dowolnego wydawcy.
Aby uzyskać więcej informacji, zobacz: https://www.crossref.org/community/orcid/
Każdy element w ORCID iD ma przypisany kod, który jednoznacznie go identyfikuje. Odczytując cały rekord lub sekcję, wprowadzony kod można znaleźć jako atrybut pozycji. Gdy wywołanie określonej pozycji na płycie, wprowadzony kod służy do identyfikacji elementu. Umieszczane kody są unikalne w ramach typu pozycji, do której się odnoszą. Korzystając z tego przykładu, tylko jedna praca w ORCID Rejestr będzie miał kod put 733535, chociaż 733535 może być również używany jako kod put dla elementu finansowania lub słowa kluczowego
Jako korzyść z ORCID członkostwo, organizacje mogą zapytać ORCID do obsługi dodatkowych typów PID w ORCID Rejestr. Na przykład członek może poprosić o dodanie obsługi identyfikatorów PID, których używają do identyfikacji próbek lub zestawów danych w swojej geologicznej bazie danych. Umożliwia to powiązania między próbkami a osobami, które je pobrały. A ponieważ wszystkie nowe typy PID, które dodajemy, muszą być co najmniej rozwiązywalne, a najlepiej FAIR, powiązania te są jednoznaczne, trwałe w czasie i możliwe do zastosowania – z korzyścią dla badacza, organizacji członkowskiej i szerszej społeczności.
Dodawanie Twojego PID!
Jako organizacja społeczna chcemy to zapewnić ORCID obsługuje identyfikatory PID używane przez naszych członków. Utrzymujemy komplet lista istniejących identyfikatorów obsługiwanych w Rejestrze i zaprosić ORCID członków do wykorzystania ta forma zażądać dodatkowych PID. Staramy się odpowiedzieć na Twoją prośbę tak szybko, jak to możliwe.
ORCID ma osobną sekcję w ORCID zapisz, aby zapisać informacje o kwalifikacjach, akredytacjach, certyfikatach i odznakach.
Każdy element kwalifikacji zawsze będzie zawierał:
- Tytuł kwalifikacji
- Identyfikator organizacji dostawcy (np. identyfikator ROR)
- Data dodania do ORCID rekord
- Kto dodał kwalifikację (źródło)
Mogą zawierać:
- Data ważności, w tym data końcowa w przypadku wygaśnięcia kwalifikacji
- Trwały identyfikator kwalifikacji, identyfikujący rodzaj uzyskanej kwalifikacji.
- Adres URL kwalifikacji, który zawiera czytelny dla człowieka opis typu zdobytej kwalifikacji.
- Stały identyfikator kwalifikacji. Powinien on łączyć się z internetową wersją certyfikatu kwalifikacji. Może to być istniejący unikalny identyfikator lub po prostu URI.
Uwierzytelnianie i OAuth
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ą „3-etapowy OAuth” do uwierzytelniania użytkowników i żądania pozwolenia na interakcję z ich rekordami. Każda integracja może poprosić o uprawnienia do odczytu za pomocą publicznego API. ORCID członkowie mogą korzystać z interfejsu API członka, aby poprosić o uprawnienia do aktualizacji. Działa to w ten sposób:
- 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
Spersonalizowany adres URL autoryzacji zawiera informacje o kliencie, a także „zakresy” określające konkretne obszary jego dokumentacji, do których chcesz uzyskać dostęp. Po zalogowaniu użytkownik autoryzuje połączenie z Twoim systemem i wraz z kodem autoryzacyjnym wraca na Twój landing page. Kod ten jest następnie używany do uzyskania ich 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 dołączasz go do wiadomości e-mail, prosząc użytkownika o uwierzytelnienie i autoryzację. Jednak w celach testowych możesz po prostu wkleić go do swojej przeglądarki internetowej. Zastąp dane w nawiasach danymi swojego klienta 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ć, należy uwzględnić je w żądaniach API wysyłanych w celu odczytania lub aktualizacji tego rekordu.
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.
Jeśli obawiasz się, że wielu użytkowników korzysta z tego samego komputera i nie wylogowuje się między sesjami, możesz wymusić na nich ponowne uwierzytelnienie podczas procesu OAuth. Po prostu dołącz prompt=login
w żądaniu OAuth. Możesz także ustawić max_age w sekundach, aby zmusić użytkowników do ponownego uwierzytelnienia, jeśli ich sesja przekroczy określoną długość. Zobacz nasze Dokumentacja OpenID Connect by uzyskać więcej szczegółów.
użytkownicy mogą samodzielnie zmienić język wyświetlania w dowolnym momencie. Dostępne są następujące ustawienia języka:
Wybierz język | Code |
عربى (arabski) | ar |
čeština (czeski) | cs |
Angielski | en |
Español (hiszpański) | es |
Français (French) | fr |
Deutsch (niemiecki) | de |
włoski (włoski) | it |
日本語 (japoński) | ja |
한국어 (koreański) | ko |
polski (polski) | pl |
Português (portugalski) | pt |
Русский (rosyjski) | ru |
Turecki (turecki) | tr |
简体中文 (chiński uproszczony) | zh_CN |
繁體中文 (tradycyjny chiński) | zh_TW |
Można użyć dowolnego lub wszystkich parametrów:
Parametr | Pole | Uwagi |
imiona | Nadane imię | Opona Imię pole zostanie wypełnione na Formularz rejestracyjny jeśli określony adres e-mail lub ORCID iD nie pasuje do aktywnego ORCID rekord. |
nazwiska | Nazwisko rodowe | Opona nazwisko pole zostanie wypełnione na Formularz rejestracyjny jeśli podany adres e-mail lub ORCID iD nie pasuje do aktywnego ORCID rekord. |
Opona e-mail/ORCID iD pole zostanie wypełnione na formularz logowania jeśli podany adres e-mail zostanie znaleziony w naszym systemie i nie będzie prawidłowy ORCID iD jest określony E-mail pole zostanie wypełnione na Formularz rejestracyjny jeśli podany adres e-mail zostanie znaleziony w naszym systemie i nie będzie prawidłowy ORCID iD jest określony. Adres e-mail powinien być Zakodowany adres URL, w tym zmianę „@” na „%40”. Jeśli znasz użytkownika ORCID iD i adres e-mail, sugerujemy tylko zapewniając ORCID iD w parametrze orcid. | ||
ork | ORCID iD | Opona e-mail/ORCID iD pole zostanie wypełnione na formularz logowania jeśli określono ORCID iD znajduje się w naszym systemie.The Formularz rejestracyjny w przeciwnym razie zostanie wyświetlony, jeśli określono ORCID iD nie występuje w naszym systemie.The ORCID iD musi być w 16-cyfrowy format pliku iD URI. |
Przykładowy adres URL z tymi parametrami to
https://sandbox.orcid.org/oauth/authorize?client_id=APP-NPXKK6HFN6TJ4YYIn&response_type=coden&scope=/authenticaten&redirect_uri=https%3A%2F%2Fdevelopers.google.com%2Foauthplaygroundn&family_names=Finn&given_names=Huckleberry&email=huckle%40mailinator.com
Jeśli aktywny token dostępu już istnieje z tymi samymi zakresami, których żąda adres URL autoryzacji OAuth, a użytkownik jest zalogowany ORCID rekordu, nie zostaną poproszeni o ponowne udzielenie autoryzacji. Zamiast tego zostaną przeniesione bezpośrednio do identyfikatora URI przekierowania. Jeśli chcesz, aby użytkownik nadawał autoryzację za każdym razem, gdy się łączy, użyj metody metoda wymuszenia wylogowania
Implicit OAuth to lżejsza wersja OAuth przeznaczona do użytku w systemach, które nie mają lub nie chcą używać komponentów po stronie serwera. Niejawny OAuth można zaimplementować całkowicie w przeglądarce, używając samego JavaScript. Jest dostępny dla członków i osób niebędących członkami i działa w ten sposób:
- Tworzysz specjalny link
- Po kliknięciu użytkownik jest wysyłany do ORCID
- ORCID prosi użytkownika o podpisanie i
- ORCID prosi użytkownika o nadanie uprawnień do Twojej aplikacji
- ORCID wysyła użytkownika z powrotem do twojego systemu z jego ORCID iD, token dostępu i token identyfikacyjny.
- Twój system wyodrębnia i przechowuje uwierzytelnione ORCID iD z odpowiedzi.
Ze względów bezpieczeństwa podczas korzystania z niejawnej autoryzacji OAuth, ORCID nie zwróci tokenów dostępu z uprawnieniami do aktualizacji.
Niejawny przepływ
Niejawny przepływ jest zaprojektowany w taki sposób, że klienci nie muszą używać swojego tajnego klucza do inicjowania ORCID zaloguj się. Bezpieczeństwo jest egzekwowane poprzez ograniczenie klientów do ich zarejestrowanych adresów URL przekierowań. Ten niższy poziom bezpieczeństwa oznacza, że ORCID obsługuje zakresy /authenticate i openid tylko w przypadku korzystania z przepływu niejawnego. Tokeny są również krótkotrwałe, z 10-minutową żywotnością. Ten przepływ jest zalecany w przypadku aplikacji po stronie klienta, które nie mają dostępu do serwera zaplecza, na przykład aplikacji na telefon lub jednostronicowych aplikacji internetowych javascript.
https://localhost/#access_token=24c11342-f5da-4cf9-94a4-f8a72a30da00&token_type=bearer&expires_in=599&tokenVersion=1&persistent=false&id_token=eyJraWQiOiJxYS1vcmNpZC1vcmctcjlhZmw3cWY2aG2c5bmdzenU1bnQ3Z3pmMGVhNmkiLCJhbGciOiJSUzI1NiJ9.eyJhdF9oYXNoIjoiMW52bXZBbVdwaVd0Z3ZKZW1DQmVYUSIsImF1ZCI6IkFQUC02TEtJSjNJNUIxQzRZSVFQIiwic3ViIjoiMDAwMC0wMDAyLTUwNjItMjIwOSIsImF1dGhfdGltZSI6MTUwNTk4Nzg2MiwiaXNzIjoiaHR0cHM6XC9cL29yY2lkLm9yZyIsIm5hbWUiOiJNciBDcmVkaXQgTmFtZSIsImV4cCI6MTUwNTk4ODQ2MywiZ2l2ZW5fbmFtZSI6IlRvbSIsImlhdCI6MTUwNTk4Nzg2Mywibm9uY2UiOiJ3aGF0ZXZlciIsImZhbWlseV9uYW1lIjoiRGVtIiwianRpIjoiY2U0YzlmNWUtNTBkNC00ZjhiLTliYzItMmViMTI0ZDVkNmNhIn0.hhhts2-4-ibjXPW6wEsFRaNqV_A-vTz2JFloYn7mS1jzQt3xuHiSaSIiXg3rpnt1RojF_yhcvE9Xe4SOtYimxxVycpjcm8yT_-7lUSrc46UCt9qW6gV7L7KQyKDjNl23wVwIifpRD2JSnx6WbuC0GhAxB5-2ynj6EbeEEcYjAy2tNwG-wcVlnfJLyddYDe8AI_RFhq7HrY4OByA91hiYvHzZ8VzoRW1s4CTCFurA7DoyQfCbeSxdfBuDQbjAzXuZB5-jD1k3WnjqVHrof1LHEPTFV4GQV-pDRmkUwspsPYxsJyKpKWSG_ONk57E_Ba--RqEcE1ZNNDUYHXAtiRnM3w
Sprawdź nasz dokumentacja techniczna po więcej informacji.
Co to są identyfikatory URI przekierowania i jak są używane?
Identyfikatory URI przekierowania są używane przez naszą usługę uwierzytelniania OAuth jako środek bezpieczeństwa. ORCID wyśle uwierzytelniających użytkowników tylko do identyfikatorów URI zarejestrowanych przez klienta żądającego uwierzytelnienia. Zapobiega to podszywaniu się usług pod inne osoby.
Należy pamiętać, że tylko identyfikatory URI HTTPS są akceptowane w produkcji. Możesz testować przy użyciu identyfikatorów URI HTTP, ale musisz się zarejestrować Identyfikatory URI HTTPS podczas ubiegania się o poświadczenia interfejsu API członka produkcyjnego.
Jak dopasowujemy identyfikatory URI przekierowania?
- MUSISZ zarejestrować subdomeny jako osobne identyfikatory URI. https://anythingelse.thirdparty.com nie będzie działać.
- Zaleca się pełną rejestrację wszystkich identyfikatorów URI przekierowania, w tym ścieżki, jest tym, co robi większość stron trzecich i jest najbezpieczniejszą opcją.
- Jeśli aplikacja kliencka jest zarejestrowana z identyfikatorem uri przekierowania, który jest tylko nazwą hosta, można użyć dowolnego identyfikatora uri przekierowania na tym hoście. Na przykład, jeśli zarejestrowany jest następujący identyfikator uri przekierowania: https://thirdparty.com wtedy wszystkie następujące redirect_uris będą działać:
- https://thirdparty.com/oauth/callback1
- https://thirdparty.com/callback2
- https://thirdparty.com/anything-else-as-long-as-the-host-is-the-same
Jednak https://anythingelse.thirdparty.com nie będzie działać. You MUST zarejestrować subdomeny jako osobne identyfikatory URI.
Co się stanie, jeśli mój identyfikator URI przekierowania jest nieprawidłowy?
Użytkownicy wysłani do uwierzytelnienia w ORCID z nieprawidłowymi identyfikatorami URI przekierowania, zostanie wyświetlony komunikat o błędzie podobny do tego:
Zarządzanie przekierowaniami URI dla członków
Jeśli korzystasz z interfejsu API członka i potrzebujesz zmian w identyfikatorach URI przekierowania, skontaktuj się z naszym zespołem ds. zaangażowania
Zarządzanie przekierowaniami URI dla klientów publicznych
Jeśli korzystasz z publicznego interfejsu API, musisz wykonać poniższe czynności, aby zaktualizować listę identyfikatorów URI przekierowań, które są powiązane z Twoim ORCID publiczny identyfikator klienta API. Możesz to zrobić, wykonując poniższe czynności:
- Zaloguj się do swojego konta ORCID rekord
- Kliknij swoje imię w prawym rogu
- Wybierz narzędzia programistyczne
- Kliknij ołówek edycji obok nazwy klienta
- Edytuj istniejący identyfikator URI przekierowania lub kliknij „Dodaj kolejny identyfikator URI przekierowania”, aby edytować istniejący
- Po dokonaniu zmian należy kliknąć ikonę zapisywania
Tylko identyfikatory URI HTTPS są akceptowane w produkcji. Możesz testować przy użyciu identyfikatorów URI http, ale będziesz musiał zarejestrować identyfikatory URI HTTPS podczas ubiegania się o poświadczenia API członka produkcyjnego.
OpenID Connect Connect 1.0 to prosta warstwa tożsamości oparta na protokole OAuth 2.0. Uzupełnia istniejące przepływy uwierzytelniania OAuth i dostarcza klientom informacji o użytkownikach w dobrze opisany sposób.
OpenID connect to ustandaryzowany sposób implementacji OAuth i udostępniania informacji o uwierzytelnionych użytkownikach. Teraz będzie można skonfigurować usługi do użycia ORCID „od razu” obok innych dostawców zgodnych ze standardami OpenID Connect. OpenID Connect zapewnia również udostępnialne tokeny ID, które są podpisanymi obiektami, które mogą udowodnić, że użytkownik został uwierzytelniony za pomocą ORCID w określonym czasie. Te tokeny mogą być używane przez elementy interfejsu użytkownika do utrzymywania sesji użytkownika.
ORCID obsługuje profil zgodności Basic OpenID Provider, który jest rozszerzeniem przepływu kodu autoryzacyjnego OAuth. ORCID obsługuje również niejawny przepływ tokenów dla zakresów „/authenticate” i „openid”.
Oznacza to, że ORCID:
- Osadza podpisane tokeny identyfikacyjne w odpowiedziach tokenów dla kodów autoryzacyjnych generowanych przy użyciu zakresu „openid”
- Obsługuje niejawny przepływ podczas korzystania z typów odpowiedzi „token” lub „token id_token” i zakresu „openid”.
- Obsługuje parametry „prompt”, „nonce” i „max_age” dla żądań autoryzacji, które obejmują zakres „openid”.
- Obsługuje wykrywanie Openid Connect i punkty końcowe informacji o użytkownikach
- Obsługuje pole „amr” dla integratorów korzystających z interfejsu API członka w przypadku żądań autoryzacji, które obejmują zakres „openid”. Można to wykorzystać do wykrycia, czy użytkownik został uwierzytelniony przy użyciu uwierzytelniania dwuskładnikowego.
Inicjowanie uwierzytelniania OpenID Connect działa tak samo, jak zwykłe uwierzytelnianie OAuth. Wymagane jest tylko, aby klient zażądał zakresu „openid”. Jeśli używasz zakresu /authenticate, zastąp go openid, ponieważ uwierzytelnianie i openid mają tę samą autoryzację, należy użyć tylko jednego lub drugiego. Jeśli używasz innych zakresów, dodaj openid do listy żądanych zakresów. Gdy uwzględniony jest zakres openid, Rejestr zwróci id_token w odpowiedzi tokenu i udzieli klientowi pozwolenia na dostęp do punktu końcowego informacji o użytkowniku dla tego użytkownika.
zauważ, że zakres „openid” nie zaczyna się od „/”, jak drugi ORCID zakresy API. Dzieje się tak, ponieważ zakres „openid” nie jest zdefiniowany przez ORCID, ale zamiast tego zdefiniowane przez specyfikację OpenID Connect.
Sprawdź nasz dokumentacja techniczna po więcej informacji.
ORCID umożliwia użytkownikom włączenie Uwierzytelnianie dwuskładnikowe (2FA) na ich ORCID konto. 2FA to dodatkowa kontrola bezpieczeństwa przeprowadzana podczas procesu logowania. Zapewnia dodatkowe potwierdzenie, że użytkownik jest rzeczywiście osobą logującą się do ORCID konto. Aby uzyskać więcej informacji na temat tego, jak można to skonfigurować dla użytkowników, zobacz nasze Artykuł KB.
Otwórz identyfikator Connect integratorzy korzystający z członkowskiego API mogą sprawdzić, czy użytkownik zalogował się do ich ORCID konto z włączoną funkcją 2FA w ramach procesu OAuth. Może to pozwolić integratorom będącym członkami na przyznanie swoim naukowcom dostępu do systemów o wyższym poziomie bezpieczeństwa.
Zgodnie z nasze zobowiązanie do kontrolowania ich przez badaczy ORCID rekord, rekordzista może w dowolnym momencie odwołać dowolny token dostępu, usuwając go z uprawnień w Zaufana organizacjan na swojej stronie Zaufane strony.
Od 2018 r. badacze mogą przyznawać tylko tokeny dostępu o długiej żywotności, które obowiązują przez 20 lat, chyba że użytkownik cofnie pozwolenie.
ORCID zapewnia proste Widżet JavaScript które można wykorzystać do uzyskania uwierzytelnienia ORCID Identyfikatory używające OAuth z OpenID Connect.
Należy pamiętać, że widżet korzysta z niejawnej autoryzacji OAuth, więc nie zbiera żadnych uprawnień do zapisu. Oznacza to, że nie nadaje się do integracji członków, które chcą aktualizować rekordy. Zobacz nasz samouczek dot Dodawanie i aktualizacja danych dot ORCID Records.
ORCID API
Poświadczenia klienta publicznego są przyznawane osobom fizycznym, a nie organizacjom. Poświadczeń nie można przenosić z jednej osoby na drugą, ale można je przekształcić w poświadczenia API członka, jeśli uzyskano zgodę wszystkich stron, a organizacja jest aktywnym członkiem ORCID.
Przeniesienie identyfikatora klienta do interfejsu API członkowskiego nie spowoduje zmiany identyfikatora klienta, a jedynie tajnego klucza klienta. Zachowasz także liczbę połączonych identyfikatorów z uprawnieniami tylko do odczytu.
Podczas konwertowania klienta publicznego interfejsu API na klienta interfejsu API członka Warunki świadczenia usług dla klientów publicznych nie mają już zastosowania i są zastępowane warunkami Umowy członkowskiej.
Do przelewu potrzebowalibyśmy:
- Potwierdzenie publicznego identyfikatora klienta API, który ma zostać przekonwertowany.
- Aby główny kontakt organizacji i posiadacz rekordu bieżącego identyfikatora klienta Public API zgodzili się ze zmianą w Warunkach korzystania z usługi. (Posiadacz rekordu musi być pracownikiem, kontrahentem lub urzędnikiem organizacji członkowskiej) Będziemy przechowywać zapis zgody obu stron.
- Data/godzina migracji. W ramach tej migracji zaktualizujemy identyfikator klienta i wyślemy Ci nowy sekret klienta w zaszyfrowanej wiadomości e-mail. Należy pamiętać, że po zaktualizowaniu klienta Twoja integracja nie będzie działać, dopóki nie zaktualizujesz sekretu klienta. Dlatego musimy ustalić datę i godzinę, aby to zrobić i zapobiec niedogodnościom dla użytkowników.
Aby konwersja została zakończona, musisz zaktualizować:
- Stary klucz klienta do nowego klucza klienta.
- Host API z pub.orcid.org do api.orcid.org.
Za pomocą przekonwertowanego identyfikatora klienta Member API możesz zaktualizować zakresy do dodania zakresy członkowskich API. Będzie to wymagało autoryzacji od użytkowników, a nowe tokeny dostępu zostaną wygenerowane w celu uwzględnienia nowych zakresów/uprawnień.
Należy pamiętać, że nie jesteśmy w stanie przekonwertować poświadczeń klientów Member API na poświadczenia publicznego API.
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.
Opona 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 Projektu |
/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 |
Pozycje (prace, zatrudnienie, finansowanie, recenzowanie itp.) ORCID nagrywaj ręcznie lub za pomocą ORCID API członka. Jeśli jesteś osobą fizyczną i chcesz zaktualizować swoje dane, sprawdź nasze sekcję pomocy na ten temat tutaj. Jeśli jesteś członkiem i chcesz dodać elementy do ORCID zapisz, będziesz potrzebować:
- Pozwolenie naukowców
- Poświadczenia interfejsu API członka
- albo:
- System dostawcy, który integruje się z ORCID Interfejs API członków
- Twój własny system, który integruje się z ORCID Interfejs API członków
Aby zapoznać się z kompletnym przewodnikiem dla członków korzystających z interfejsu API do elementów rekordu, sprawdź nasz link do samouczka dotyczącego interfejsu API poniżej:
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.
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.
Zanim będzie można dodać element do ORCID rekord, będziesz musiał sformatować swoje dane do formatu ORCID schemat. Sformatuj swoje dane w ORCID schemat wiadomości w formacie XML lub JSON.
Nasze repozytorium GitHub zawiera zasoby, które pomogą w formatowaniu podczas tworzenia nowych elementów na ORCID rekord, a podczas czytania istniejących pozycji na ORCID rekord:
pamiętaj, że różne wersje API mają różne formaty komunikatów. Dostępne są również schematy i przykłady w wersji 2.0 i 2.1.
Więcej przykładów można łatwo znaleźć, czytając metadane dobrze wypełnionego rekordu.
Wcześniejsza wersja ORCID API miało dodatkowe zakresy. Te zakresy zostały wycofane wraz z interfejsem API w wersji 2.0. Zachęcamy wszystkie integracje do używania tylko zalecanych zakresów. Poniżej wymieniono wcześniejsze zakresy wraz z bieżącym zakresem, który powinien być używany w zamian
- /orcid-profile/read-limited użyj zamiast tego /ograniczony do odczytu
- /orcid-works/read-limited użyj zamiast tego /ograniczony do odczytu
- /orcid-bio/limit-odczytud użyj zamiast tego /ograniczony do odczytu
- /orcid-works/utwórz użyj zamiast tego /działania/aktualizacja
- /orcid-works/aktualizacja użyj zamiast tego /działania/aktualizacja
- /przynależności/utwórz użyj zamiast tego /działania/aktualizacja
- /przynależności/aktualizacja użyj zamiast tego /działania/aktualizacja
- /finansowanie/tworzenie użyj zamiast tego /działania/aktualizacja
- /funding/update użyj zamiast /activities/update
- /orcid-bio/aktualizacja użyj zamiast tego /osoba/aktualizacja
- /orcid-bio/zewnętrzne-identyfikatory/utwórz użyj zamiast tego /osoba/aktualizacja
Tokeny odświeżania służą do generowania dodatkowych tokenów dostępu. Token odświeżania jest zwracany wraz z tokenem dostępu podczas wymiany kodu autoryzacji w ramach trójetapowe procesy OAuthi można z niego korzystać tak długo, jak token dostępu pozostaje aktywny.
Nowe tokeny dostępu mogą mieć takie same wygaśnięcia i zakresy jak oryginalny token dostępu lub mogą mieć krótszy okres istnienia, a także mniejszy podzbiór zakresów z oryginalnego tokenu dostępu. Nowe tokeny dostępowe mogą być generowane w celu zastąpienia oryginalnego tokena lub wygenerowane jako dodatkowy token. Możesz również użyć wywołań tokenu odświeżania, aby całkowicie wygasnąć oryginalne tokeny dostępu i odświeżania oraz wszelkie uprawnienia udzielone przez użytkownika.
Sugerujemy użycie tokenów odświeżania w następujących warunkach:
- Zastępowanie tokenów dostępu, które mogły zostać naruszone (pamiętaj, aby później odwołać oryginalny token dostępu)
- Dawanie osobie trzeciej, która jest również częścią ciebie ORCID integracja bardziej ograniczony dostęp i/lub dostęp przez ograniczony czas.
Prosimy o zapoznanie się z naszą dokumentacja techniczna jak tworzyć nowe tokeny dostępu z tokenów odświeżania.
Istnieją dwa różne zakresy aktualizacji – jeden dla szczegółów biograficznych, drugi dla działań.
Zakres | Opis Projektu | Punkty końcowe interfejsu API |
/osoba/aktualizacja | Dane biograficzne – lewa kolumna ks ORCID rekordowy interfejs użytkownika. | /adres /zewnętrzne-identyfikatory /słowa kluczowe /inne nazwy /researcher-urls |
/działania/aktualizacja | Dane o działalności badawczej – prawa kolumna ORCID rekordowy interfejs użytkownika. | /różnica /wyróżnienia /Edukacja /edukacja /zatrudnienie /zatrudnienia /finansowanie / fundusze /zaproszona-pozycja /zaproszone-pozycje /członkostwo /członkostwa /recenzja /ocena współpracownika /kwalifikacja /kwalifikacje /zasoby-badawcze /zasoby-badawcze /usługa /usługi /praca /Pracuje |
Użyj swojego identyfikatora klienta, tajnego klucza i aktywnego tokenu lub powiązanego z nim tokenu odświeżania, aby odwołać parę tokenów. Możesz odwołać pary tokenów utworzone zarówno w dwunożnych, jak i trójetapowe procesy OAuth. Jeśli masz wiele zestawów tokenów, np. dla różnych zakresów, tylko określony token dostępu i odpowiadający mu token odświeżania zostaną unieważnione.
Sugerujemy unieważnienie tokenów w następujących warunkach:
- Aby unieważnić tokeny wydane zewnętrznemu dostawcy po zakończeniu relacji;
- Aby odwołać tokeny, gdy użytkownicy odłączą swoje ORCID iD z twojego systemu;
- Aby umożliwić użytkownikom odwoływanie tokenów z poziomu Twojego systemu.
Zalecamy korzystanie z odśwież tokeny ograniczyć zakres lub czas trwania istniejącego tokena dostępu lub zaktualizować token, jeśli został naruszony.
Wywołanie interfejsu API odwołania
https://sandbox.orcid.org/oauth/revoke (or https://orcid.org/oauth/revoke)
METHOD: POST
HEADER: accept:application/json
CONTENT-TYPE: application/x-www-form-urlencoded
DATA:
client_id=[Your client ID]
client_secret=[Your client secret]
token=[access token or refresh token for token pair to be revoked]
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 Projektu |
/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ł.
Lista typowych kodów błędów interfejsu API, ich możliwe znaczenie oraz wskazówki dotyczące rozwiązywania problemów są dostępne w naszym serwisie dokumentacja techniczna.
Jeśli nie jesteś w stanie rozwiązać problemu, którego doświadczasz, daj nam znać.
ORCID członkowie mogą aktualizować informacje, które wcześniej dodali do pliku ORCID nagrywać. Tylko jeden element może być aktualizowany naraz i może być aktualizowany tylko przy użyciu poświadczeń klienta, które go utworzyły.
Aby ułatwić aktualizację, upewnij się, że przechowuj wprowadzony kod i token dostępu podczas tworzenia przedmiotów.
Sformatuj zaktualizowany element in ORCID schemat wiadomości ze zmienionymi informacjami i uwzględnić zapisane umieść kod.
<?xml version="1.0" encoding="UTF-8"?> <employment:employment put-code="739288" [...]> [...] </employment:employment>
Wywołaj interfejs API:
Method: PUT Content-type: application/vnd.orcid+xml or application/vnd.orcid+jsonnAuthorization type and Access token: Bearer [stored access token]Data: link to file or text of affiliation to update URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment/739288
Interfejs API zwróci komunikat 200 OK, aby wskazać, że element został poprawnie zaktualizowany. Sprawdź naszą stronę rozwiązywania problemów, jeśli pojawi się inny komunikat.
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 publicznym rejestrze badacza. Elementy strony zaufanej są zwracane za pośrednictwem interfejsu API wyłącznie klientom, którzy mają dostęp do ograniczonego odczytu; nie znajdują się one w rejestrze publicznym badacza. Prywatne przedmioty są widoczne tylko dla badacza i źródła przedmiotu – jedynymi prywatnymi przedmiotami zwróconymi przez API są te, które zostały dodane do rekordu poprzez Twoją integrację Więcej o ustawieniach widoczności w ORCID rejestr.
Pozycje (prace, zatrudnienie, finansowanie, recenzowanie itp.) ORCID nagrywać za pomocą ORCID API członka. Aby to zrobić, musisz najpierw uzyskać zgodę badacza za pomocą OAuth i sformatować metadane elementu używając ORCID schemat wiadomości.
Po sformatowaniu danych i zebraniu ORCID iD i token dostępu, wysyłasz żądanie API za pomocą HTTP POST, określając odpowiedni punkt końcowy.
Method: POST
Content-type: application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]data: link to file or text of single employment item to add
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment
Poniższe wywołanie dodaje nowe zatrudnienie przynależność do rekordu na serwerze testowym piaskownicy:
<?xml version="1.0" encoding="UTF-8"?>
<employment:employment [...]>
[...]
</employment:employment>
Interfejs API zwróci komunikat 201, aby wskazać, że przedmiot został wysłany poprawnie wraz z przedmiotem umieść kod. Twój klient zostanie wymieniony jako źródło elementu.
Sprawdź nasze Rozwiązywanie problemów stronę, jeśli zwrócona zostanie inna wiadomość. Będziesz musiał zapisać plik przechowuj wprowadzony kod i token dostępu aby dokonać aktualizacji lub usunąć element.
Opona ORCID interfejs API wyszukiwania używa składni SOLR. Obsługiwane są wszystkie składnie zapytań dostępne w SOLR 3.6, w tym Lucene z rozszerzeniami Solr (Domyślne), DisMax i Rozszerzony Dismax.
Aby z niego korzystać, potrzebujesz tokena dostępu „/read-public”. Po uzyskaniu tokena wyszukiwania utwórz podstawowy adres URL wyszukiwania:
Typ poświadczeń: | Publiczny interfejs API | Interfejs API członków |
URL zasobu: | Piaskownica: https://pub.sandbox.orcid.org Produkcja: https://pub.orcid.org | Piaskownica: https://api.sandbox.orcid.org Produkcja: https://api.orcid.org |
Wersja API: | v3.0 | |
Wyszukaj punkt końcowy | /szukaj/?=[zapytanie] |
Przykładowe wywołanie wyszukiwania „orcid” przy użyciu tokena w publicznym interfejsie API sandbox, z wynikami zwróconymi w formacie XML, wygląda następująco:
Method: GET Content-type: application/vnd.orcid+xmlnAuthorization type and Access token: Bearer [stored access token]URL: https://pub.sandbox.orcid.org/v3.0/search/?q=orcid
Wyniki będą określać liczbę znalezionych wyników (liczba-znalezionych) i domyślnie wyświetlać pierwsze 1000 wyników:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<search:search num-found="385" xmlns:search="https://www.orcid.org/ns/search" xmlns:common="https://www.orcid.org/ns/common">
<search:result>
<common:orcid-identifier>
<common:uri>https://sandbox.orcid.org/0000-0001-2345-6789</common:uri>
<common:path>/0000-0001-2345-6789</common:path>
<common:host>sandbox.orcid.org</common:host>
</common:orcid-identifier>
</search:result>
[...]
</search:search>
Przykładowe wyszukiwanie podstawowe w publicznym interfejsie API piaskownicy z wynikami zwróconymi w formacie json:
Method: GET
Content-type: application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.sandbox.orcid.org/v3.0/search/?q=newman
Wyszukiwanie zwraca tylko osobę ORCID Identyfikatory rekordów zawierających dane publiczne pasujące do wyszukiwania. Aby uzyskać więcej informacji o wyniku, zadzwoń, aby przeczytać ORCID nagrywać bezpośrednio.
Aby uzyskać więcej informacji, zobacz naszą Samouczek interfejsu API wyszukiwania.
Jeśli dodałeś dane, które należy usunąć, na przykład, jeśli zostały skojarzone z niewłaściwym ORCID iD, możesz wykonać żądanie HTTP DELETE określające odpowiedni punkt końcowy, razem z ORCID ID, przechowywany token dostępu i przechowywany kod put. Jednorazowo można usunąć tylko jeden element, a usunąć można tylko elementy dodane przez klienta. Możesz usuwać elementy nawet wtedy, gdy użytkownik cofnął pozwolenie.
To przykładowe wywołanie usuwa pozycję zatrudnienia z kodem „739288” z rekordu”
Method: DELETE
Content-type: application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment/739288
Opona ORCID interfejs API wyszukiwania używa składni SOLR. Obsługiwane są wszystkie składnie zapytań dostępne w SOLR 3.6, w tym Lucene z rozszerzeniami Solr (Domyślne), DisMax i Rozszerzony Dismax.
Możesz użyć wyszukiwania w polach, gdy chcesz przeszukać określoną sekcję ORCID nagrywać. Aktualna lista pól rozpoznawanych w wyszukiwarce API wraz z odpowiadającymi im elementami struktury rekordów przedstawia się następująco:
Pole wyszukiwania | Opis Projektu |
Dane biograficzne | |
imiona | Podane (imię) imię (imiona) użytkownika. |
nazwisko rodowe | Nazwisko (nazwisko) rodowe użytkownika. |
nazwa-kredytu | „Opublikowana nazwa” na ORCID interfejs użytkownika, nazwa, która zwykle pojawia się w publikacjach użytkownika |
inne nazwy | Alternatywne nazwy, które mogły pojawić się w publikacjach użytkownika. |
Adres e-mail użytkownika. | |
keyword | Wszelkie słowa kluczowe powiązane z użytkownikiem. |
odnośnik do identyfikatora zewnętrznego | Identyfikatory z innych systemów dodawane do użytkownika ORCID nagrywać za pomocą API. |
Dane dotyczące afiliacji | |
nazwa-organizacji-przynależności | Nazwa dowolnej organizacji w elemencie edukacji lub zatrudnienia w rekordzie użytkownika. |
identyfikator-grid-org | Opona IDENTYFIKATOR SIATKI dowolnej organizacji w sekcji działań rekordu użytkownika. Ogólnie będzie to związane z pozycją edukacji lub zatrudnienia. |
identyfikator ror-org | Opona Identyfikator ROR dowolnej organizacji w sekcji działań rekordu użytkownika. Ogólnie będzie to związane z pozycją edukacji lub zatrudnienia. |
identyfikator ringgold-org | Opona Identyfikator Ringgolda* dowolnej organizacji w sekcji działań rekordu użytkownika. Generalnie będzie to powiązane z kwestią edukacji lub zatrudnienia. |
Dane o finansowaniu | |
tytuły finansowania | Tytuł dowolnej pozycji finansowania w rekordzie użytkownika. |
identyfikator organizacji fundref | Opona Identyfikator rejestru fundatora krzyżowego dowolnej organizacji w sekcji działań rekordu użytkownika. Zasadniczo będzie to powiązane z elementem finansowania, ale może być również powiązane z afiliacją. |
numery grantów | Numer grantu (identyfikator) dowolnej pozycji finansowania w rekordzie użytkownika. |
Dane dotyczące działalności badawczej | |
tytuły prac | Tytuły dowolnej pracy w rekordzie użytkownika. |
cyfrowe-identyfikatory-obiektów | Zewnętrzny identyfikator pracy z typem doi |
zrób to sam | Zewnętrzny identyfikator pracy z typem doi i relacją identyfikatora zewnętrznego ustawioną na self |
[typ identyfikatora zewnętrznego]* | Zewnętrzny identyfikator pracy o podanym typie |
[typ identyfikatora zewnętrznego]*-self | Zewnętrzny identyfikator pracy z podanym typem i relacją identyfikatora zewnętrznego ustawioną na self |
[typ identyfikatora zewnętrznego]*-część-z | Zewnętrzny identyfikator pracy o podanym typie i relacji identyfikatora zewnętrznego ustawionej na część |
[typ identyfikatora zewnętrznego]*-wersja-of | Zewnętrzny identyfikator pracy o podanym typie i relacji identyfikatora zewnętrznego ustawionej na wersję-of * Pełna lista identyfikatorów zewnętrznych znajduje się w lista identyfikatorów. Niektóre identyfikatory mogą wymagać „-self”, „-part-of” lub „-version-of”, aby zwrócić wyniki |
ORCID nagrywać informacje | |
ork | 16-cyfrowy ORCID identyfikator użytkownika w formacie 0000-0001-2345-6789. |
data przesłania profilu | Data i godzina utworzenia rekordu. |
profil-data-ostatniej-modyfikacji | Data i godzina ostatniej modyfikacji rekordu. |
Wszystkie dane | |
XNUMX | Wszystkie powyższe pola. Jest to również pole domyślne dla zapytań dotyczących składni Lucene. |
Sprawdź nasz Samouczek API wyszukiwania po więcej informacji.
*Chociaż identyfikatory Ringgold nadal istnieją w ramach ORCID rejestru, stan na dzień 1 sierpnia 2023 r., ORCID nie otrzymuje już aktualizacji bazy danych identyfikatorów organizacji RINGGOLD wykorzystywanej przez nasz Rejestr, ani nie będziemy mogli przetwarzać ani wykorzystywać identyfikatorów RINGGOLD utworzonych po tej dacie. Zobacz nasze FAQ więcej informacji
W rzeczywistych sytuacjach interakcje API są realizowane przez system przy użyciu języka programowania, takiego jak PHP, Java lub Ruby on Rails. Aby ćwiczyć i testować, możesz wchodzić w interakcje z ORCID Interfejsy API wykorzystujące szereg narzędzi zdolnych do wykonywania i odbierania żądań HTTP. Większość narzędzi HTTP na komputery stacjonarne jest uruchamianych w wierszu poleceń; dla tych, którzy preferują interfejs graficzny, użyteczną alternatywą są narzędzia internetowe.
WERYFIKACJA XML/XSD
Istnieje wiele narzędzi, które zweryfikują Twój XML za Ciebie; dobrze jest go adoptować. W przypadku wielu wywołań interfejsu API będziesz pracować z informacjami w formacie XML. Szczególnie podczas pracy z ORCID API, ważne będzie, aby używany XML był zgodny z XSD. (Zobacz nasz dokumentacja na GitHubie dla ORCID schemat wiadomości XSD.)
ORCID SERWER TESTOWY SANDBOX
Opona serwer testowy piaskownicy jest kopią ORCID Oprogramowanie rejestru i zawiera tylko dane testowe. Został zaprojektowany, aby zapewnić miejsce do wypróbowania różnych rzeczy bez wpływu na rzeczywistość ORCID iDs, szczególnie jeśli pracujesz z ORCID API i potrzebujesz miejsca do testowania swojej pracy. Możesz tworzyć konta użytkowników i testować wywołania API w piaskownicy, nie martwiąc się o wpływ na dane produkcyjne lub przypadkowe spamowanie badaczy.
Nie musisz nawet być ORCID Member, aby wypróbować interfejs API członka w piaskownicy. Wszyscy mogą poprosić o poświadczenia interfejsu API członka piaskownicy i wypróbować wszystkie funkcje dostępne w interfejsie API członka.
Witryna i interfejsy API nie będą tak niezawodne, jak w przypadku serwerów produkcyjnych. Nie udzielamy żadnych gwarancji dotyczących danych w piaskownicy; nie są archiwizowane i mogą zostać usunięte. Piaskownica może również zawierać pewne eksperymentalne funkcje, których jeszcze nie ma na serwerach produkcyjnych, więc możesz wypróbować różne rzeczy, zanim pojawią się w rejestrze. ZOBACZ WIĘCEJ o serwerze testowym piaskownicy lub zażądać poświadczeń klienta.
NARZĘDZIA HTTP
Dostępnych jest wiele narzędzi do uruchamiania żądań HTTP. Niektóre używamy:
Webhooki mogą być rejestrowane przez członków premium przeciwko dowolnym ORCID zapis w rejestrze. Kroki są następujące:
Zakoduj adres URL
Adres URL — zakoduj żądany adres URL ORCID zadzwonić, gdy rekord użytkownika zostanie zaktualizowany. Na przykład następujący adres URL:
https://nowhere2.com/0000-0002-7465-2162/updated
staje się
https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
Zbuduj adres URL
Zbuduj pełny adres URL dla ORCID Wywołanie interfejsu API rozpoczynające się od adresu URL pliku ORCID rekord, a następnie dodając ‚√∫/webhook‚√π i adres URL, który chcesz wywołać. Powinno to wyglądać tak: https://api.sandbox.orcid.org/{ORCID}/webhook/{URL-ZAKODOWANY-WEBHOOK-URL}
Na przykład przy użyciu powyższego adresu URL elementu webhook i pliku ORCID iD 0000-0002-7465-2162, pełny adres URL to:
https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
Zarejestruj webhooka
Użyj swojego tokena dostępu do webhooków, aby zarejestrować swój webhook względem użytkownika ORCID nagrywać. Musisz użyć żądania HTTP PUT, ale nie powinieneś niczego umieszczać w treści żądania.
URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdatedn HEADER: Accept: application/json HEADER: Authorization: Bearer [Your access token]n HEADER: Content-Length: 0n METHOD: PUT
Odpowiedzią powinno być 201, ale jeśli wywołanie zwrotne już istniało, odpowiedź wyniesie 204.
HTTP/1.1 201nServer: nginx/1.1.19nConnection: keep-alive Location: https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Frequestb.in%2Fz57lzcz5
Adres URL służący do wyrejestrowania elementu webhook jest taki sam, jak w przypadku rejestracji. Musisz jednak użyć metody HTTP DELETE.
URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
HEADER: Authorization: Bearer [Your access token]
HEADER: Content-Length: 0
METHOD: DELETE
Odpowiedź powinna być 204 No Content
.
HTTP/1.1 204 No Content
Server: Apache-Coyote/1.1
Date: Fri, 05 Apr 2013 12:49:17 GMT
Opona ORCID Rejestr wykona następujące wywołanie HTTP, gdy rekord zostanie zaktualizowany. Żądanie używa metody HTTP POST, ale treść żądania jest pusta.
curl -v -X POST https://nowhere2.com/0000-0002-7253-3645/updated
Twój serwer powinien odpowiedzieć standardowymi kodami odpowiedzi HTTP. Jeśli więc połączenie się powiodło, powinieneś zwrócić 204 No Content.
HTTP/1.1 204 No Content
Dowolny kod odpowiedzi 2xx oznacza, że połączenie się powiodło. Jeśli zwrócisz kod inny niż 2xx, spróbujemy ponownie zadzwonić pięć minut później.
W rzeczywistych sytuacjach interakcje API są realizowane przez system przy użyciu języka programowania, takiego jak PHP, Java lub Ruby on Rails. Jednak w celu ćwiczeń i testów możesz wchodzić w interakcje z ORCID Interfejs API korzystający z szeregu narzędzi zdolnych do wykonywania i odbierania żądań HTTP. Większość narzędzi HTTP dla komputerów stacjonarnych (takich jak cURL) są uruchamiane w wierszu poleceń; dla tych, którzy preferują interfejs graficzny, użyteczną alternatywą są narzędzia internetowe.
Jednym z popularnych narzędzi jest Platforma zabaw Google OAuth 2.0, bezpłatne narzędzie internetowe opracowane i obsługiwane przez firmę Google.
Zapraszamy do zapoznania się z naszym praktycznym samouczkiem dotyczącym interfejsu API pod adresem: https://info.orcid.org/hands-on-with-the-orcid-api/
Uwaga: ORCID nie utrzymuje OAuth 2.0 Playground – to narzędzie zostało stworzone przez Google, który wyłącznie utrzymuje jego kod. Chociaż okresowo aktualizujemy tę dokumentację, od czasu do czasu mogą występować pewne nieścisłości, ponieważ możemy nie być natychmiast świadomi zmian w OAuth 2.0 Playground.
Dla naszego API w wersji 2.0 i nowszych limity są następujące:
- Poproś o drugie – 24
- Wybuch – 40
Poproś o sekundę — liczba żądań, które można wykonać w ciągu sekundy.
Burst – Liczba żądań, które pozwolimy umieścić w kolejce przed odrzuceniem. Żądania w kolejce są spowalniane do szybkości żądań na sekundę. Jeśli przekroczysz serię, otrzymasz odpowiedź 503.
Jeśli masz problemy z limitami, skontaktuj się ze swoim kierownikiem zespołu ds. zlecenia w celu uzyskania pomocy.
Kontrola badacza to rdzeń ORCID zasada więc adresy e-mail zarejestrowane i dodane do ORCID rekord są domyślnie ustawione jako widoczne tylko dla posiadacza rekordu. Niezweryfikowane adresy e-mail nie są wyświetlane w publicznym widoku rekordu, a w wynikach interfejsu API pojawią się tylko zweryfikowane adresy e-mail.
Gdy badacze zweryfikują swój adres e-mail, muszą zdecydować, czy będzie on widoczny dla wszystkich (tj. publicznie) lub dla zaufanych stron (tj. ograniczony dostęp), aby adres e-mail mógł być odczytany przez organizacje zewnętrzne.
Jeśli badacz ustawił swój adres e-mail jako Zaufane strony, zostanie on zwrócony wraz z zapisem, jeśli badacz przyznał Ci dostęp z ograniczonym dostępem do odczytu. Aby uzyskać więcej informacji, zobacz ORCID ustawienia widoczności.
API 3.0 to domyślna wersja API i zalecamy korzystanie z tej wersji przy budowaniu nowych integracji. Będziemy nadal wspierać interfejsy API 2.0 i 2.1 w dającej się przewidzieć przyszłości i powiadomimy o tym z co najmniej 12-miesięcznym wyprzedzeniem przed wyłączeniem tych wersji.
Wiele się nauczyliśmy podczas przejścia z API 1.2 na API 2. Tym razem znacznie ułatwiliśmy zarządzanie aktualizacją. API 3.0 dodaje nowe funkcje, modyfikując istniejące funkcje tylko wtedy, gdy jest to absolutnie konieczne. Oznacza to, że integratorzy powinni mieć możliwość przejścia na nowy interfejs API przy minimalnym wysiłku. Oznacza to również, że chociaż zalecamy jak najszybsze rozpoczęcie planowania aktualizacji, aby Twoja organizacja i badacze mogli skorzystać z nowych funkcji, masz dużą elastyczność w decydowaniu, kiedy przeprowadzić aktualizację do wersji 3.0.
Mała lista potencjalnie przełomowych zmian znajduje się w naszych informacjach o wydaniu interfejsu API tutaj i tutaj. Wprowadzono kilka zmian dotyczących pól opcjonalnych/obowiązkowych, nieznacznie zmodyfikowano wyliczenia JSON, a także przeprowadziliśmy niewielką refaktoryzację naszych schematów XML, dodając kilka nowych pól zawierających metadane wymagane dla nowej funkcjonalności.
Proszę zobaczyć ORCID strona systemów obsługiwanych przez dostawców dla wydawców w celu uzyskania najbardziej aktualnych informacji
Każdy członek premium może otrzymać token dostępu „/webhook”. Pojedynczy token może służyć do rejestrowania elementów webhook dla wielu rekordów. 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.
Poniżej znajduje się przykładowe wywołanie w celu uzyskania tokena dostępu — zastąp symbole zastępcze swoimi poświadczeniami (pamiętaj o usunięciu nawiasów).
curl -i -L -H "Accept: application/json"
-d "client_id=(your client ID)"
-d "client_secret=(your client secret)"
-d "scope=/webhook"
-d "grant_type=client_credentials"
"https://sandbox.orcid.org/oauth/token"
Następnie zostanie zwrócony token dostępu podobny do poniższego.
{"access_token":"5eb23750-1e19-47a3-b6f6-26635c34e8ee",
"token_type":"bearer",
"refresh_token":"c7d3d5fd-e4c0-4825-89f2-7cfb4a1cf01e",
"expires_in":631138518,
"scope":"/webhook"}
Tak! Możesz przeczytać więcej o naszych wersjach API, uzasadnieniu tego i nie tylko, tutaj na naszej stronie Zasady dotyczące wersji interfejsu API.
Ponieważ stale rozwijamy nasze produkty, istnieje wiele funkcji, które są dostępne tylko z interfejsem API 3.0, który jest naszą najnowszą i domyślną wersją interfejsu API.
Poniższa tabela zawiera krótki opis każdej funkcji. Jeśli masz jakiekolwiek pytania dotyczące którejkolwiek z funkcji lub uaktualnienia do wersji 3.0, skontaktuj się z liderem ds. zaangażowania lub liderem konsorcjum.
Możliwość odczytu i zapisu wszystkich typów afiliacji (członkostwo, usługi, zaproszone stanowiska, wyróżnienia i kwalifikacje nie są dostępne w poprzednich wersjach API) |
Umiejętność czytania i pisania zasobów badawczych. |
Możliwość odczytu i zapisu identyfikatorów pracy z typem relacji „Finansowane przez”. Służy do łączenia identyfikatorów dotacji lub propozycji z metadanymi roboczymi. |
Możliwość odczytu i zapisu identyfikatorów pracy z typem relacji „Wersja”. Służy do łączenia ze sobą innych wersji pracy. Przykładowym przypadkiem użycia byłoby powiązanie preprintu i opublikowanego artykułu. |
Możliwość odczytu i zapisu ról CRediT w metadanych prac. |
Możliwość odczytu dodatkowych pól źródłowych wspólne: potwierdzenie-pochodzenie-identyfikator-klienta i wspólne:nazwa-pochodzenia-twierdzenia dla afiliacji dodanych przez ORCID portal członków i prace dodane przez kreatorów wyszukiwania i linków. |
Umiejętność czytania i pisania prac o typie pracy: adnotacja plany zarządzania danymi praca dyplomowa przedruk Obiekt fizyczny przeglądu |
Możliwość odczytu i zapisu identyfikatorów zewnętrznych dla afiliacji. |
Identyfikatory organizacji są obowiązkowe przy dodawaniu powiązań i finansowania ORCID Records. |
Formalizacja identyfikatorów — wprowadziliśmy nowe pole generowane przez system, które wyraża zewnętrzne identyfikatory (DOI, PMCID, PMID, ArXiv, Bibcode, ISSN i ISBN) w znormalizowanym formacie na potrzeby dopasowywania i grupowania. Normalizacja odbywa się w oparciu o reguły typu identyfikatora i może polegać na ustawieniu wszystkich znaków alfanumerycznych na małe lub przekształceniu spacji, myślników, kropek i innych znaków, które można traktować jako równoważne. W razie potrzeby dodaje również standardowe przedrostki i przyrostki. Na przykład, https://doi.org/10.1/123, 10.1/123, https://dx.doi.org/10.1/123 wszystkie pojawią się w tym polu jako https://doi.org/10.1/123. Istniejąca wartość identyfikatora jest niezmodyfikowana. |
Bardziej szczegółowe informacje można znaleźć tutaj.
Inne
Otrzymują powiadomienie w swoim ORCID Skrzynka. W przypadku zmiany danych dot ORCID rekordu, użytkownik otrzymuje powiadomienie z podstawowymi informacjami o zmianie, zawierającymi nazwę klienta dokonującego aktualizacji, datę zmiany oraz pozycję w ORCID rekord, który został zaktualizowany. Zobacz nasze Baza wiedzy użytkowników, aby uzyskać więcej informacji na temat powiadomień.
ORCID zapisy na piaskownicy też mają działające skrzynki pocztowe. Zalecamy regularne przeglądanie skrzynek odbiorczych swoich testów ORCID rekordy podczas planowania, w jaki sposób systemy będą planować aktualizacje danych.
Aktualizacje i inne ogłoszenia dla użytkowników API są udostępniane za pośrednictwem ORCID Grupa użytkowników API. Możesz również subskrybować ogólne wiadomości i aktualizacje za pośrednictwem ORCID Blog.
ORCID członkowie otrzymują również ORCID Biuletyn dla członków, w którym zawarte są te informacje. Wreszcie kontakt techniczny dla każdego ORCID członek z aktywną, niestandardową integracją będzie również otrzymywać wiadomości e-mail o wszelkich krytycznych aktualizacjach programu ORCID Rejestr. Jeśli chcesz być wymieniony jako kontakt techniczny w swojej organizacji, proszę skontaktuj się z nami.
ORCID zobowiązuje się do otwartości i przejrzystości. To znaczy nasz mapa drogowa produktu jest dostępny dla każdego, podobnie jak praca obecnie w fazie rozwoju.
Plan działania produktu ma kluczowe znaczenie dla ORCID proces rozwoju produktu. Wymagania przechodzą z zarządzanych przez zespół tablic trello, przez tablicę trello Product Roadmap i dalej do tablicy trello Current Development, gdzie są wdrażane i przenoszone do naszych systemów produkcyjnych.
Ta tablica zawiera dobrze zdefiniowane wymagania, które są zaplanowane do wdrożenia w pewnym momencieoraz listę priorytetowych wymagań planowanych do wdrożenia w najbliższym czasie.
Skąd się biorą wymagania?
Wymagania są zbierane z wielu źródeł przez ORCID personel. Mogą one pochodzić między innymi z próśb członków, opinii konsorcjum, testów użytkowników, projektów strategicznych i raportów o błędach. Ponadto wszystkie ORCID zespoły generują własne wymagania wewnętrzne, takie jak zmiany w witrynie, aktualizacje infrastruktury i aktualizacje systemów operacyjnych. Każda karta jest opatrzona etykietą zespołu, który opracował wymaganie — komunikacji, strategii, technologii, zaangażowania lub operacji.
Jak sprawy na mapie drogowej?
ORCID dąży do zrównoważonego cyklu rozwoju produktu i regularnie organizuje spotkania między zespołami w celu omówienia krótko- i długoterminowych priorytetów. Dokładamy wszelkich starań, aby w równym stopniu zająć się błędami, nowymi funkcjami, długami technicznymi, aktualizacjami witryny i elementami strategicznymi.
Jak mogę przyczynić się do realizacji planu?
Czekamy na sugestie, jak ulepszyć ORCID rejestr. Wszelkie uwagi prosimy kierować na adres nasz zespół.
Dodatkowo, ORCID jest projektem typu open source i mile widziane są wkłady w nasz kod źródłowy, jak również wszystkie inne nasze repozytoria.
Preprint to kompletny manuskrypt naukowy, który autorzy przesyłają na publiczny serwer. Preprint zawiera kompletne dane i metodologie; często jest to ten sam rękopis przesyłany do czasopisma. Po krótkiej kontroli jakości, mającej na celu upewnienie się, że praca ma charakter naukowy, manuskrypt autora zostaje opublikowany w Internecie w ciągu mniej więcej jednego dnia bez recenzji i może być przeglądany bezpłatnie przez każdego na świecie. Na podstawie informacji zwrotnych i/lub nowych danych można przesyłać nowe wersje preprintu; jednak zachowane są również wcześniejsze wersje przeddruku. Serwery preprint pozwalają naukowcom bezpośrednio kontrolować rozpowszechnianie ich pracy w światowej społeczności naukowej. W większości przypadków ta sama praca opublikowana jako przedruk jest również przesyłana do recenzji w czasopiśmie. Tak więc preprinty (szybkie, ale nie zweryfikowane przez recenzentów) i publikacje w czasopismach (powolne, ale zapewniające weryfikację za pomocą recenzji) działają równolegle jako system komunikacji w badaniach naukowych.
Uwaga: ta treść i wideo pierwotnie pojawiły się na stronie witryna ASAPBio Dzięki ASAPBio za udostępnienie go na licencji CC-BY!
Biuletyn dla członków wysyłany co miesiąc od ORCID poprzednio zawierał link do folderu Dysku Google, w którym były przechowywane wszystkie zgłoszenia członków. Zostało to teraz zastąpione nowymi raportami dostępnymi dla wszystkich członków w programie portal członkowski.
Poprzednie raporty:
- Członkowie premium z aktywnymi integracjami otrzymać unikalny link do folderu zawierającego osobne, spersonalizowane raporty z danymi dla każdej integracji z poprzedniego miesiąca.
- Członkowie premium, którzy nie mają jeszcze aktywnej integracji otrzymać unikalny link do folderu zawierającego spersonalizowane raporty ze statystykami e-mail dla swojej instytucji, a także link do folderu zawierającego ogólne raporty z zagregowanymi danymi dla wszystkich aktywnych integracji członkowskich.
- Członkowie podstawowi otrzymać link do folderu zawierającego raporty ogólne wydawane dwa razy w roku, zawierające zagregowane dane dotyczące wszystkich aktywnych integracji członków w poprzednim półroczu; publikowane jest sprawozdanie za I półrocze lipiec (dane styczeń-czerwiec), raport za drugie półrocze wydany w XNUMX r styczeń (lipiec-grudzień następnego roku).
Jeśli jesteś ORCID członkiem i nie otrzymujesz obecnie miesięcznego biuletynu członkowskiego, skontaktuj się z nami [email chroniony]
Członkowie premium z aktywnymi integracjami
Folder Dysku Google zawiera raport dotyczący każdego z wydanych Ci identyfikatorów klienta produkcyjnego. Nazwy plików zawierają wyświetlaną nazwę klienta iD i datę raportu; posortuj według daty modyfikacji, aby znaleźć najnowszy raport. Istnieje również folder raw_data zawierający dane użyte do wygenerowania raportu, który w razie potrzeby jest dostępny do dodatkowej analizy.
Członkowie premium, którzy nie mają jeszcze aktywnej integracji
Folder Dysku Google zawiera raport członka zawierający wyłącznie dane statystyczne dotyczące poczty e-mail, a także link do folderu Dysku Google zawierającego ogólne raporty miesięczne z zagregowanymi danymi dotyczącymi wszystkich aktywnych integracji członków, za bieżący i poprzednie lata. Surowe dane nie są dostępne dla tych raportów.
Liczba domen poczty e-mail
Ta sekcja zawiera liczby ORCID Identyfikatory zarejestrowały obecnie domeny e-mail Twojej instytucji we wszystkich okresach. Aby wygenerować te liczby, wyszukujemy domeny pasujące do adresu URL witryny zarejestrowanej przez Twoją organizację (np. jeśli URL Twojej witryny to www.universitycollege.edu, szukamy e-maili kończących się na @universitycollege). Jeśli nie mamy zarejestrowanego adresu URL witryny, w tej sekcji zobaczysz komunikat „√∫Nie podano domen poczty e-mail”√π. Jeśli Twoja domena e-mail nie została poprawnie dobrana lub jeśli chcesz dodać dodatkowe domeny, prosimy skontaktuj się z nami.
- Rekordy zarejestrowane w Twoich domenach e-mail¬¨‚Liczba unikalnych ORCID Identyfikatory, które zawierają adres w domenach e-mail Twojej instytucji
- Rekordy zarejestrowane w Twoich domenach e-mail ORAZ powiązane z Twoim identyfikatorem klienta¬¨‚Liczba unikalnych ORCID identyfikatory, które zawierają adres w domenach e-mail Twojej instytucji ORAZ które obejmują Twoją instytucję jako zaufaną stronę (tj. rejestry, dla których Twoja instytucja ma ważny token dostępu)
Utworzono i zażądano rekordów
(Uwaga: większość klientów nie będzie miała tej sekcji w swoich raportach)
Jeśli masz klienta instytucjonalnego, który był używany do tworzenia rekordów w imieniu badaczy za pośrednictwem API, otrzymasz sekcję o nazwie Statystyki rejestru. Obejmuje to informacje o liczbie rekordów, które utworzyłeś i ile zostało zgłoszonych (plik raw_data zawiera więcej informacji o konkretnych rekordach użytych do wygenerowania tych liczb).
użytkownicy
Ta sekcja raportu zawiera łączną liczbę badaczy, którzy wykorzystali Twoją integrację do połączenia ORCID iD do Twojego systemu w ciągu miesiąca raportowania. Dodatkowo podaje łączną liczbę tych badaczy, którzy zapisali się na nowy ORCID iD jako część iD proces połączenia.
Wykres o nazwie Łączna liczba zdarzeń integracyjnych pokazuje liczbę badaczy, którzy korzystali z integracji w ciągu ostatniego miesiąca, w podziale na dni
Eventy
Raport zawiera również wydarzenia informacje, działania, które badacz wykonał podczas łączenia ich ORCID rejestrować w swoim systemie w miesiącu sprawozdawczym. Każde zdarzenie reprezentuje dowolny dostęp przyznany przez użytkownika lub akcję, którą wykonał na ORCID witryny (np. logowanie się lub udzielanie dostępu z ograniczeniem odczytu). Z większością badaczy wiąże się więcej niż jedno zdarzenie.
Jeżeli do zdarzenia dopisane jest ‚√∫√π, oznacza to, że badacz nadał długowieczne (Ptrwały) w porównaniu z tokenem krótkotrwałym, który wygasa w ciągu jednej godziny. Od marca 2018 r. obsługiwane są tylko tokeny o długiej żywotności ORCID Rejestr; Twój zintegrowany system lub użytkownik może w dowolnym momencie odwołać token.
Użytkownicy według kraju
Ostatnia sekcja raportów zawiera informacje o badaczach, którzy korzystali z Twojej integracji, podzielone według kraju, z którego uzyskali dostęp do Twojej integracji. Dane te pochodzą z adresu IP badacza lub jego identyfikatora geograficznego (zostającego ustalonego przez Google na podstawie adresu IP badacza).
Próbowanie
Ponieważ tak wielu badaczy używa tzw ORCID Registry, nie jest możliwe tworzenie raportów na całym zbiorze danych badacza. Zamiast tego podane tutaj liczby są tworzone przy użyciu trendów z próbkowanego i niepróbkowanego zestawu. Sekcje raportu utworzone na podstawie próbkowanych danych są oznaczone gwiazdką, a próbkowany rozmiar i miejsce są określone na karcie Dane Analytics. Liczby w sekcji Google Analytics raportu mogą nie w pełni odpowiadać żadnym lokalnym statystykom, które prowadzisz, a liczby między sekcjami raportu mogą się nieznacznie różnić.
Parametry próbkowania wymienione poniżej Integration Analytics mają zastosowanie do wszystkich sekcji oznaczonych gwiazdką. Odsetek sesji przechwyconych przez dane analityczne to (rozmiar próbki)/(przestrzeń próbki) * 100%. Więcej informacji na temat pobierania próbek można znaleźć na stronie Google Developers.
Puste raporty
Sekcje Użytkownicy i Zdarzenia w raporcie zawierają tylko dane z ostatniego miesiąca. Jeśli żaden badacz nie korzystał z Twojej integracji w ciągu ostatniego miesiąca, żadne dane nie zostaną zwrócone.
pytania
Jeśli masz jakieś pytania dotyczące raportów członkowskich, proszę skontaktuj się z nami.
Opona ORCID Rejestr został zaprojektowany tak, aby użytkownicy dostarczali swoje identyfikatory organizacjom korzystającym z protokołu OAuth, co zapewnia poprawność iD jest zbierany dla każdego badacza. Odradzamy organizacjom dodawanie ORCID identyfikatory do swoich systemów w oparciu o wyszukiwanie badaczy według nazwiska. Pomocne może być jednak sprawdzenie, ilu naukowców ma Twoja organizacja ORCID identyfikatory, które można wykonać za pośrednictwem interfejsu API. Sugestie dotyczące wyszukiwania według organizacji podano poniżej.
Aby zapoznać się z wprowadzeniem do wyszukiwania, jak uzyskać token dostępu, jak rozumieć wyniki wyszukiwania oraz szczegóły dotyczące innych pól, które można przeszukiwać, zobacz naszą Przeszukiwanie samouczka interfejsu API rejestru
Szukaj według nazwy i DOI
Podczas sprawdzania, czy dana osoba ma ORCID rekord, zalecamy wyszukiwanie zarówno według ich nazwiska, jak i DOI jednej lub więcej ich ostatnich prac. Powinno to skutkować tylko zapisem badacza, którego szukasz, a nie rekordami kogokolwiek innego, kto ma to samo nazwisko.
Przykładowe wywołanie wyszukiwania wszystkich rekordów o nazwisku „Laurel Haak” i DOI 10.1087/20120404 lub DOI 10.6084/M9.FIGSHARE.1115124:
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search?q=family-name:Haak+AND+given-names:Laurel+AND+digital-object-ids:%2210.1087/20120404%22+OR+digital-object-ids:%2210.6084/M9.FIGSHARE.1115124’%22
Szukaj według przynależności
Pola przynależności można wyszukiwać według nazwy przynależności lub unikalnego identyfikatora ROR lub identyfikatora GRID organizacji. (Identyfikator GRID organizacji można znaleźć w GRID lub Twój identyfikator ROR w rejestru ROR)
Szukaj według nazwy organizacji
Method: GET Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=affiliation-org-name:"University+of+Johannesburg"
Lub dla dokładnego dopasowania
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=affiliation-org-name:(%22Boston%20University%22)
Szukaj według identyfikatora GRID
Przykładowe wywołanie wyszukiwania wszystkich rekordów z identyfikatorem GRID grid.5509.9 (Uniwersytet w Tampere):
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=grid-org-id:grid.5509.9
Szukaj według identyfikatora ROR
Przykładowe wywołanie wyszukiwania wszystkich rekordów z ROR ID 04fa4r544 (ORCID):
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=ror-org-id:"https://ror.org/04fa4r544"
Szukaj według domeny e-mail
Możesz użyć interfejsu API do wyszukiwania badaczy według domeny e-mail. Należy pamiętać, że około 97% adresów e-mail w ORCID są prywatne i żadne rekordy z prywatnym lub zaufanym adresem e-mail nie zostaną zwrócone w tym wyszukiwaniu.
Przykładowe wywołanie w celu wyszukania wszystkich rekordów z adresem e-mail @orcid.org:
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=email:*@orcid.org
Wyniki wyszukiwania zwrócone w formacie CSV
Wyniki wyszukiwania można również zwrócić w formacie CSV. W ramach wywołania możesz określić kolumny wyjściowe z listy dostępnych pól poniżej:
ork
E-mail
nadane imię
nazwisko rodowe
imiona i nazwiska
nazwa-kredytu
inna nazwa
obecna-nazwa-przynależności-instytucji
nazwa-byłej-przynależności-instytucji
Korzystając z poświadczeń, musisz określić nagłówek, który ma być „tekst/csv'. W ramach wywołania wyszukiwania musisz również dodać pola, które są wymagane w danych wyjściowych do zapytania.
Wyszukiwanie za pomocą samej przeglądarki
Możesz również zakończyć wyszukiwanie za pomocą przeglądarki. Adres URL jest skonstruowany w ten sam sposób, ale nie musisz używać żadnych danych uwierzytelniających API. Pamiętaj, że można to zrobić tylko za pomocą publicznego interfejsu API.
Poniżej znajduje się przykładowe wywołanie przy użyciu publicznego interfejsu API wyszukiwania według nazwy organizacji z rozszerzeniem ORCID, imiona, nazwiska, obecna nazwa przynależności do instytucji i poprzednia nazwa przynależności do instytucji jako pożądane dane wyjściowe.
https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:ORCID&fl=orcid,given-names,family-name,current-institution-affiliation-name,past-institution-affiliation-name
Poniżej znajduje się inne przykładowe wywołanie przy użyciu publicznego API wyszukiwania według różnych odmian nazwy organizacji.
https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:("University of Plymouth" OR "Plymouth University")
Schemat eduPerson dodał plik eduPersonOrcid atrybut w swoim Aktualizacja z lutego 2016 r.
Zgodnie z Specyfikacja eduPerson:
RFC4512 definition
( 1.3.6.1.4.1.5923.1.1.1.16
NAME 'eduPersonOrcid'
DESC 'ORCID researcher identifiers belonging to the principal'
EQUALITY caseIgnoreMatch
SYNTAX '1.3.6.1.4.1.1466.115.121.1.15' )
Należy zauważyć, że format tego pola to ORCID-preferowana reprezentacja identyfikatora URI, tj https://orcid.org/0000-0001-5727-2427.
Więcej informacji o formacie ORCID iD można znaleźć Struktura ORCID identyfikator.
ORCID została założona na zasada że badacze powinni mieć kontrolę nad swoimi informacjami. Aby uszanować tę zasadę, mamy silny Polityka prywatności, który został zaprojektowany w celu uwzględnienia lokalnych różnic w przepisach dotyczących prywatności, a my koncentrujemy się na perspektywie badacza podczas opracowywania zasad i funkcjonalności.
Zgodnie z naszym podstawowa zasada kontroli badaczy, ORCID rekordy mogą być tworzone wyłącznie przez samych badaczy, na ORCID stronie internetowej.
W ramach procesu integracji twoi badacze będą mogli zarejestrować się w nowym ORCID iD lub zaloguj się do ich istniejącego rekordu, umożliwiając zebranie ich uwierzytelnionych ORCID ID. Proszę zobaczyć nasze Samouczki API po więcej informacji.
Jeśli uważasz, że dane wyświetlane w Twoim raporcie są niedokładne, proszę skontaktuj się z nami tak szczegółowo, jak to możliwe, a nasz zespół ds. zlecenia zbada sprawę.
Jeśli Twoja organizacja jest ORCID członkiem, musisz skontaktować się z ORCID kontakt w Twojej organizacji, który będzie w stanie zapewnić Ci dostęp do ORCID Portal dla członków. Jeśli nie możesz zidentyfikować swoich organizacji ORCID skontaktuj się z liderem konsorcjum lub przedstawicielem zespołu wykonującego zlecenie.
Uwielbiamy opinie od naszej społeczności, więc daj nam znać, jeśli masz jakieś opinie na temat raportów członków, kontaktując się z nami pod adresem https://support.orcid.org/hc/en-us/requests/new
Dane wykorzystywane do tworzenia raportów członkowskich i integracyjnych są aktualizowane codziennie.