Wenn Sie Ihre Benutzer auffordern, ihre zu erstellen oder zu verbinden ORCID iD In Ihr System können Sie Ihren Forschern Zeit und Mühe ersparen, indem Sie die Informationen eingeben, die Ihr System bereits über sie gespeichert hat, ihre Anzeigesprache festlegen und sie von allen aktiven Sitzungen abmelden, um sicherzustellen, dass sie sich richtig angemeldet haben ORCID Konto.
Der ORCID APIs bieten mehrere Optionen zum Anpassen der Benutzererfahrung
Füllen Sie das Registrierungs-/Anmeldeformular vorab aus
ORCID bietet Mitgliedern die Möglichkeit, das OAuth-Registrierungs-/Anmeldeformular als Teil einer API-Interaktion mithilfe der Parameter der URL https://orcid.org/oauth/authorize vorab auszufüllen
Es können einzelne oder alle Parameter verwendet werden:
Parameter | Feld | Notizen |
Vornamen | Vorname | Der Vorname Das Feld wird auf dem ausgefüllt Anmeldeformular wenn eine angegebene E-Mail-Adresse bzw ORCID iD entspricht nicht dem eines aktiven ORCID Rekord. |
Familiennamen | Familienname | Der Nachname Das Feld wird auf dem ausgefüllt Anmeldeformular wenn die angegebene E-Mail-Adresse bzw ORCID iD entspricht nicht dem eines aktiven ORCID Rekord. |
Der Email/ORCID iD Das Feld wird auf dem ausgefüllt Anmeldeformular wenn die angegebene E-Mail-Adresse in unserem System gefunden und nicht gültig ist ORCID iD angegeben ist.Die E-Mail Das Feld wird auf dem ausgefüllt Anmeldeformular wenn die angegebene E-Mail-Adresse in unserem System gefunden und nicht gültig ist ORCID iD angegeben ist. Die E-Mail-Adresse sollte sein URL-codiert, einschließlich der Änderung von „@“ in „%40“. Wenn Sie den Benutzer kennen ORCID iD und E-Mail-Adresse empfehlen wir einzige Bereitstellung der ORCID iD im orcid-Parameter. | ||
orcid | ORCID iD | Der Email/ORCID iD Das Feld wird auf dem ausgefüllt Anmeldeformular wenn das angegebene ORCID iD ist in unserem System zu finden.Die Anmeldeformular wird andernfalls angezeigt, wenn der angegebene Wert vorliegt ORCID iD wird in unserem System nicht gefunden ORCID iD muss in der sein 16-stelliges Format des iD URI. |
Eine Beispiel-URL mit diesen Parametern ist
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
Anzeigesprache einstellen
ORCID bietet die Möglichkeit, die Anzeigesprache des OAuth-Registrierungs-/Anmeldeformulars als Teil einer API-Interaktion mithilfe des Parameters „lang“ in der URL https://orcid.org/oauth/authorize anzugeben. Dadurch wird auch die bevorzugte Sprache des Benutzers für die Anzeige festgelegt.
Nutzer können ihre Anzeigesprache jederzeit selbständig ändern. Folgende Spracheinstellungen stehen zur Verfügung:
Sprache | Code |
عربى (Arabisch) | ar |
čeština (tschechisch) | cs |
Englisch | en |
Español (Spanisch) | es |
Français (Französisch) | fr |
Deutsch (German) | de |
Italiano (Italienisch) | it |
日本語 (Japanisch) | ja |
한국어 (Koreanisch) | ko |
Polski (Polnisch) | pl |
Português (Portugiesisch) | pt |
Русский (russisch) | ru |
Türkçe (Türkisch) | tr |
简体中文 (vereinfachtes Chinesisch) | zh_CN |
繁體中文 (traditionelles Chinesisch) | zh_TW |
Beispiel
In diesem Beispiel wird das Formular vorab ausgefüllt und die Sprache auf Spanisch eingestellt
https://sandbox.orcid.org/oauth/authorize?client_id=APP-NPXKK6HFN6TJ4YYI
&response_type=code
&scope=/authenticate
&redirect_uri=https%3A%2F%2Fdevelopers.google.com%2Foauthplayground
&family_names=Finn&given_names=Huckleberry&email=huck%40mailinator.com
&lang=es
Standardmäßig das Anmeldeformular oder das Registrierungsformular verwenden
Derzeit ORCID Der OAuth-Bildschirm zeigt standardmäßig das Anmeldeformular an und bietet einen Link zum Wechseln zum Registrierungsformular. Unabhängig vom Standardverhalten kann das angezeigte Formular durch Hinzufügen des Parameters „&show_login=true“ zur Anzeige des Anmeldeformulars oder „&show_login=false“ zur Anzeige des Registrierungsformulars festgelegt werden. Beachten Sie, dass, wenn eine E-Mail-Adresse oder ORCID iD werden in der URL angegeben, die angezeigte Form wird durch diese Parameter bestimmt und der Parameter &show_login wird ignoriert.
ORCID empfiehlt dringend die Best Practice, Endbenutzern die Möglichkeit zu geben, die Größe des OAuth-Anmeldefensters zu ändern, um die Zugänglichkeit zu verbessern, im Einklang mit unseren Werten rund um die Inklusion.
Identifizieren Sie den Forscher anhand eines benutzerdefinierten „Status“-Parameters
Dies wird aus technischen Gründen von einigen Integrationen verwendet. Es erscheint nicht auf dem Anmeldebildschirm.
In die Autorisierungs-URL kann ein Statusparameter eingefügt werden, um den Benutzer zu identifizieren, beispielsweise eine eindeutige Zahlenfolge, die in die interne Kennung des Benutzers in Ihrem System übersetzt wird. Der Parameter hat keinen Einfluss auf die Erfahrung des Benutzers, wird jedoch mit dem Autorisierungscode zurückgegeben und kann zur Identifizierung des Benutzers oder der Sitzung verwendet werden. Der Statusparameter wird auch zurückgegeben, wenn der Benutzer den Zugriff verweigert.
Bitte beachten Sie, dass der Statusparameter eine Beschränkung auf 2000 Zeichen hat.
Optional können Sie die Abmeldung erzwingen
Sie können den Benutzer abmelden, wenn Sie befürchten, dass sich mehrere Benutzer auf einem einzigen Computer befinden.
Wenn Sie befürchten, dass sich mehrere Benutzer auf demselben Computer befinden und sich zwischen den Sitzungen nicht abmelden, können Sie sie während des OAuth-Vorgangs zu einer erneuten Authentifizierung zwingen. Einfach einbinden prompt=login
in der OAuth-Anfrage. Sie können auch ein max_age in Sekunden festlegen, um Benutzer zu einer erneuten Authentifizierung zu zwingen, wenn ihre Sitzung eine bestimmte Länge überschreitet. Sehen Sie sich unsere an OpenID Connect-Dokumentation für weitere Informationen an.
Überspringen der Autorisierung
ORCID überspringt unter bestimmten Umständen die Autorisierung.
Wenn bereits ein aktives Zugriffstoken mit denselben Bereichen vorhanden ist, die Ihre OAuth-Autorisierungs-URL anfordert, und der Benutzer dort angemeldet ist ORCID werden sie nicht erneut aufgefordert, die Autorisierung zu erteilen. Stattdessen werden sie direkt zum Umleitungs-URI weitergeleitet. Wenn Sie möchten, dass ein Benutzer bei jeder Verbindung eine Autorisierung erteilt, verwenden Sie die Abmeldemethode erzwingen