Dokładamy wszelkich starań, aby umieszczać opisowe komunikaty o błędach w naszym Rejestrze i interfejsie API. Oto kilka wskazówek, które pomogą Ci rozwiązać wszelkie błędy, które możesz napotkać.
Błędy interfejsu API
Nasze kody błędów interfejsu API zawierają opisowe komunikaty, które powinny być łatwo zrozumiałe.
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ć.
Błędy formatowania XML/JSON
Jeśli masz problem z formatowaniem danych, które próbujesz dodać lub zaktualizować w pliku ORCID rekord, zalecamy zapoznanie się z przykładami przez:
- Wysłanie wezwania do odczytania rekordu lub pojedynczego elementu w celu otrzymania przykładowego kodu XML/JSON lub, jeśli aktualizujesz rekord, pełnego pliku XML/JSON dla aktualizowanego elementu i użycie tego jako punktu wyjścia
- Konsultacje z naszym przykładowe pliki XML i JSON w naszym repozytorium GitHub — mamy zarówno czysty XML/JSON do publikowania, jak i pełny XML/JSON do odczytu przykładów
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.
Błędy zakresu
Jeśli otrzymujesz błędy związane z zakresami, zalecamy:
- Sprawdź, czy nie używasz zakresów członkowskich z publicznym klientem API.
- Jeśli dodajesz, aktualizujesz lub odczytujesz dane o ograniczonej widoczności, masz odpowiednie zakresy do wykonania akcji.
- Sprawdź, czy nie żądasz dwuetapowych zakresów przy użyciu trzyetapowej autoryzacji OAuth i odwrotnie.
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.
Istnieją dwa różne zakresy aktualizacji – jeden dla szczegółów biograficznych, drugi dla działań.
Zakres | Opis | 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 |
Komunikaty o błędach rejestru
Zasadniczo Twoi użytkownicy napotkają tylko kilka błędów związanych z interfejsem API podczas autoryzacji połączenia z Twoją aplikacją:
Zły identyfikator URI przekierowania
Identyfikator URI przekierowania nie pasuje do zarejestrowanych identyfikatorów URI przekierowania.
Ten komunikat o błędzie wskazuje, że link autoryzacyjny określa identyfikator URI przekierowania, którego nie zarejestrowałeś w poświadczeniach klienta interfejsu API. Jeśli korzystasz z publicznego interfejsu API, możesz to naprawić samodzielnie w swoim Narzędzia Deweloperskie. Jeśli korzystasz z Member API, będziesz musiał poprosić o ORCID Engagement team, aby zaktualizować Twoje dane uwierzytelniające.
Nie można znaleźć żądanej strony. Jeśli masz tę stronę w zakładkach, usuń ją. Jeśli skorzystałeś z linku, zgłoś to.
Ten błąd zwykle występuje, gdy link autoryzacyjny OAuth jest nieprawidłowo utworzony, np https://orcid.org/signin/oauth/authorize?[….] zamiast https://orcid.org/oauth/authorize?[…]. Aby rozwiązać problem, po prostu popraw link.
Nieopisowy komunikat
Wystąpił problem z serwerem. Jeśli ten problem będzie się powtarzał, skontaktuj się z pomocą techniczną.
Ten błąd występuje najczęściej, gdy nie określono zakresu. Musisz podać zakres w łączu autoryzacyjnym OAuth; minimalny zakres to /authenticate.
Sprawdź, czy ORCID działa!
Jest to bardzo, bardzo rzadkie, ale jeśli uważasz, że błąd jest problemem z plikiem ORCID Serwery, na których możesz sprawdzić http://status.orcid.org/
Zauważ, że ORCID Piaskownica nie jest objęta umową dotyczącą poziomu usług i może być niedostępna przez 20 minut, gdy udostępniamy aktualizacje kodu.
Otrzymywać pomoc
Zawsze chętnie pomożemy! ORCID organizacje członkowskie mogą uzyskać wsparcie od ORCID bezpośrednio.
Wszystkich integratorów zachęcamy również do przyłączenia się do ORCID Grupa użytkowników API, gdzie możesz komunikować się z innymi integratorami i użytkownikami API, a także z ORCID zespół.