Wir tun unser Bestes, um beschreibende Fehlermeldungen in unserer Registrierung und API bereitzustellen. Hier sind einige Tipps, die Ihnen bei eventuellen Fehlern helfen sollen.
API-Fehler
Unsere API-Fehlercodes enthalten beschreibende Meldungen, die leicht verständlich sein sollten.
Eine Liste häufiger API-Fehlercodes, ihre möglichen Bedeutungen und Tipps zur Fehlerbehebung finden Sie in unserem Technische Dokumentation.
Wenn Sie das aufgetretene Problem nicht lösen können, teilen Sie uns dies bitte mit.
XML/JSON-Formatierungsfehler
Wenn Sie Probleme mit der Formatierung der Daten haben, die Sie hinzufügen oder aktualisieren möchten ORCID Aufnahme empfehlen wir Beratungsbeispiele von:
- Senden Sie einen Aufruf zum Lesen des Datensatzes oder einzelnen Elements, um Beispiel-XML/JSON zu erhalten, oder, wenn Sie einen Datensatz aktualisieren, das vollständige XML/JSON für das Element, das Sie aktualisieren, und verwenden Sie dies als Ausgangspunkt
- Beratung bei uns Beispiel-XML- und JSON-Dateien in unserem GitHub-Repository – wir haben sowohl sauberes XML/JSON zum Posten als auch vollständiges XML/JSON für Lesebeispiele
Bevor Sie ein Element zum hinzufügen können ORCID Datensatz müssen Sie Ihre Daten formatieren ORCID Schema. Formatieren Sie Ihre Daten im ORCID Nachrichtenschema in XML oder JSON.
Unser GitHub-Repository enthält Ressourcen, die bei der Formatierung beim Erstellen neuer Elemente auf dem GitHub-Repository hilfreich sind ORCID aufzeichnen und beim Lesen vorhandener Elemente auf dem ORCID Aufzeichnung:
Beachten Sie, dass verschiedene Versionen der API unterschiedliche Nachrichtenformate haben. Schemata und Beispiele der Versionen 2.0 und 2.1 sind ebenfalls verfügbar.
Weitere Beispiele können leicht gefunden werden, indem man die Metadaten eines gut gefüllten Datensatzes liest.
Scope-Fehler
Wenn Sie Fehler in Bezug auf Bereiche erhalten, empfehlen wir Ihnen Folgendes:
- Stellen Sie sicher, dass Sie keine Mitgliedsbereiche mit einem öffentlichen API-Client verwenden.
- Wenn Sie eingeschränkte Sichtbarkeitsdaten hinzufügen, aktualisieren oder lesen, stellen Sie sicher, dass Sie über die richtigen Bereiche zum Ausführen der Aktion verfügen.
- Stellen Sie sicher, dass Sie keine zweibeinigen Bereiche mit dreibeinigem OAuth anfordern und umgekehrt.
Wenn Sie um Erlaubnis zur Interaktion mit einem bitten ORCID Im Datensatz des Benutzers geben Sie einen oder mehrere „Bereiche“ an. In jedem Bereich können Sie bestimmte Dinge tun, z. B. den Datensatz lesen oder einen bestimmten Abschnitt aktualisieren.
Dreibeinig bezieht sich auf die drei Akteure, die an der Einholung der Erlaubnis eines Benutzers beteiligt sind; ORCID, Ihr System und der Benutzer selbst.
/authentifizieren
Dieser Bereich wird zum Sammeln der verwendet ORCID iD und lesen Sie öffentliche Informationen nur in der Akte. Alle anderen dreibeinigen Bereiche umfassen die Authentifizierungsberechtigung, sodass dieser Bereich weggelassen werden kann, wenn Sie einen anderen Zugriff anfordern. Dieser Bereich ist in der Member- oder Public-API verfügbar.
/read-limited (nur Mitglieder-API)
Dieser Bereich wird verwendet, um Zugriff zum Lesen öffentlicher und eingeschränkt sichtbarer Elemente auf einem zu erhalten ORCID aufzeichnen. Dieser Bereich ist nur auf der Member-API verfügbar.
/activities/update (nur Mitglieder-API)
Dieser Bereich wird zum Schreiben, Aktualisieren und Löschen von Einträgen in den Abschnitten Zugehörigkeit, Finanzierung, Werke, berufliche Aktivitäten, Forschungsressourcen und Peer-Review eines ORCID aufzeichnen. Dieser Bereich ist nur auf der Member-API verfügbar.
/person/update (nur Mitglieder-API)
Dieser Bereich wird zum Schreiben, Aktualisieren und Löschen von Elementen in den Abschnitten „Andere Namen“, „Schlüsselwörter“, „Länder“, „Forscher-URLs“, „Websites“ und „Persönliche externe Identifikatoren“ des Datensatzes verwendet. Dieser Bereich ist nur auf der Member-API verfügbar.
openid
Dieser Bereich wird von OpenID-Integratoren verwendet, wenn ein id_token erforderlich ist. Wenn der openid-Bereich enthalten ist, gibt die Registry ein id_token in der Token-Antwort zurück und erteilt dem Client die Berechtigung, auf den Benutzerinformationsendpunkt für diesen Benutzer zuzugreifen. Dieser Bereich ist in der öffentlichen und Mitglieder-API verfügbar.
Bitte beachten Sie, dass der Bereich „openid“ nicht wie der andere mit einem „/“ beginnt ORCID API-Bereiche. Dies liegt daran, dass der Bereich „openid“ nicht durch definiert ist ORCID, sondern durch die OpenID Connect-Spezifikation definiert. Bitte sehen Sie sich unsere an OpenID-Dokumentation um mehr zu erfahren.
Mehrere Bereiche
In einer einzigen Interaktion können mehrere Bereiche angefordert werden, indem die Bereiche in der Authentifizierungs-URL mit einem codierten Leerzeichen dazwischen aufgelistet werden, z. B. „scope=/read-limited%20/activities/update%20/person/update“.
Vollständiger Zugriff
Wenn Sie vollen Zugriff zum Lesen und Bearbeiten eines Datensatzes wünschen, schließen Sie drei Bereiche in Ihre Authentifizierungs-URL ein: /read-limited, /activities/update und /person/update. In der URL würden sie als „scope=/read-limited%20/activities/update%20/person/update“ erscheinen
Zweibeinige Bereiche (Client-Anmeldeinformationen).
Für einige Aktivitäten müssen Sie den Benutzer nicht um Erlaubnis bitten. Zweibeinige OAuth-Bereiche werden direkt vom angefordert ORCID API und erfordern keine Erlaubnis des Forschers. Token mit diesen Gültigkeitsbereichen sind 20 Jahre lang gültig und können wiederverwendet werden
/read-public
Dieser Bereich wird verwendet, um öffentliche Informationen zu einem einzelnen zu lesen ORCID iD,Suche nach ORCID Datensätze oder zum Lesen von Übersichtsinformationen (nur Mitglieds-API). Dieser Bereich ist für die Mitglieds- oder öffentliche API verfügbar.
/ Webhook
Dieser Bereich ermöglicht es einer Clientanwendung, einen Webhook auf einem zu registrieren ORCID Datensatz, um Benachrichtigungen zu erhalten, wenn ein Datensatz aktualisiert wird. Dieser Umfang steht Premium zur Verfügung ORCID nur für Mitglieder.
Es gibt zwei unterschiedliche Aktualisierungsbereiche – einen für biografische Details und einen für Aktivitäten.
Geltungsbereich | Beschreibung | API-Endpunkte |
/person/update | Biografische Daten – die linke Spalte des ORCID Benutzeroberfläche aufzeichnen. | /Adresse /externe-Identifikatoren /Schlüsselwörter /andere Namen /researcher-urls |
/Aktivitäten/Update | Forschungsaktivitätsdaten – die rechte Spalte des ORCID Benutzeroberfläche aufzeichnen. | /Unterscheidung /Unterscheidungen /Bildung /Bildungen /Anstellung /Beschäftigungen /Finanzierung /Finanzierungen /eingeladene-position /eingeladene-positionen /Mitgliedschaft /Mitgliedschaften /peer-review /peer-reviews /Qualifikation /Qualifikationen / Forschungsressource / Forschungsressourcen /Bedienung /Dienstleistungen /Arbeit /funktioniert |
Fehlermeldungen der Registry
Im Allgemeinen werden Ihre Benutzer nur auf wenige API-bezogene Fehler stoßen, wenn sie eine Verbindung mit Ihrer Anwendung autorisieren:
Ungültiger Weiterleitungs-URI
Der Umleitungs-URI stimmt nicht mit Ihren registrierten Umleitungs-URIs überein.
Diese Fehlermeldung weist darauf hin, dass Ihr Autorisierungslink einen Umleitungs-URI angibt, den Sie nicht in Ihren API-Client-Anmeldeinformationen registriert haben. Wenn Sie die öffentliche API verwenden, können Sie das Problem selbst in Ihrem beheben Entwicklertools. Wenn Sie die Mitglieder-API verwenden, müssen Sie diese anfordern ORCID Engagement-Team, um Ihre Anmeldeinformationen zu aktualisieren.
Die angeforderte Seite kann nicht gefunden werden. Wenn Sie diese Seite als Lesezeichen gespeichert haben, löschen Sie sie bitte. Wenn Sie einem Link gefolgt sind, melden Sie ihn bitte.
Dieser Fehler tritt häufig auf, wenn der OAuth-Autorisierungslink falsch formatiert ist, z https://orcid.org/signin/oauth/authorize?[….] statt https://orcid.org/oauth/authorize?[…]. Um das Problem zu beheben, korrigieren Sie einfach den Link.
Nicht beschreibende Nachricht
Es ist ein Problem mit dem Server aufgetreten. Wenn das Problem weiterhin besteht, wenden Sie sich bitte an den Support.
Dieser Fehler tritt am häufigsten auf, wenn kein Bereich angegeben ist. Sie müssen einen Bereich in den OAuth-Autorisierungslink einfügen; Der Mindestbereich ist /authenticate.
Überprüfen Sie, ob ORCID funktioniert!
Es kommt sehr, sehr selten vor, aber wenn Sie glauben, dass der Fehler ein Problem mit dem ist ORCID Server, auf denen Sie nachsehen können http://status.orcid.org/
Beachten Sie, dass die ORCID Für Sandbox gibt es keine Service-Level-Vereinbarung und es kann sein, dass sie für einen Zeitraum von 20 Minuten nicht verfügbar ist, wenn wir Code-Updates veröffentlichen.
Hilfe bekommen
Wir helfen Ihnen gerne weiter! ORCID Mitgliedsorganisationen erhalten können Unterstützung von ORCID direkt.
Alle Integratoren werden ebenfalls aufgefordert, sich dem anzuschließen ORCID API-Benutzergruppe, wo Sie mit anderen Integratoren und API-Benutzern sowie dem kommunizieren können ORCID Team.