Schritt 2 von 5)
2. Authentifiziert sammeln ORCID IDs und Berechtigungen
In diesem Schritt erfahren Sie, wie Sie eine Authentifizierung erhalten iD und die erforderliche Erlaubnis zum Lesen und Schreiben von Daten auf und von einem ORCID Rekord.
ORCID Integrationen verwenden „3-beiniges OAuth” um Benutzer zu authentifizieren und die Erlaubnis zur Interaktion mit ihren Datensätzen anzufordern. ORCID Mitglieder können die Mitglieder-API verwenden, um Lese- und Schreibberechtigungen anzufordern.
In diesem Abschnitt gehen wir die Schritte durch, die Ihre eigene benutzerdefinierte Integration ausführen müsste, um eine Authentifizierung zu erhalten iD und die Erlaubnis, eine zu lesen und zu schreiben ORCID Rekord
Eine Authentifizierung erhalten iD und die Zugriffsberechtigung eines Benutzers aufzuzeichnen, erfordert Folgendes OAuth 2.0, ein branchenübliches Protokoll zur Autorisierung. Mit OAuth kann ein Benutzer einer Website oder Anwendung Zugriff auf Kontoinformationen gewähren, die auf einer anderen Website gespeichert sind, ohne dieser Website sein Passwort mitzuteilen.
Wenn Sie sich jemals über Google oder Facebook auf einer Website angemeldet haben, anstatt Ihre Anmeldeinformationen für diese bestimmte Website einzugeben, haben Sie bereits OAuth verwendet!
Der OAuth-Prozess umfasst drei Schritte:
- Erstellen Sie eine Autorisierungs-URL
- Holen Sie sich einen Autorisierungscode
- Tauschen Sie den Autorisierungscode gegen ein Zugriffstoken aus
Um den OAuth-Prozess zu starten, müssen wir eine spezielle Autorisierungs-URL erstellen, die Benutzer an eine weiterleitet ORCID Anmeldebildschirm. Diese URL besteht aus Autorisierungsendpunkt, Plus Parameter die Ihre Organisation und die Berechtigungen identifizieren, die Sie anfordern möchten.
Parameter | Beschreibung | Beispiel |
---|---|---|
Antworttyp | Code | |
Umfang | API-Aktion(en), für die Sie eine Berechtigung anfordern möchten, aus der Liste ORCID Scopes | /person/update /activities/update /read-limited /authentifizieren |
client_id | Ihr Mitgliedskunde ID (ausgestellt von ORCID) | [APP-***] |
URI umleiten | Seite, die Benutzern angezeigt wird, nachdem sie den Autorisierungsprozess abgeschlossen haben. (Für dieses Tutorial wird es Google OAUth Playground sein) | https://developers.go ogle.com/oauthplayground |
Um die Erlaubnis zum Hinzufügen/Aktualisieren von Aktivitäten (Zugehörigkeiten, Finanzierung, Werke, Peer-Review, Forschungsressourcen) und zum Hinzufügen/Aktualisieren persönlicher Elemente (andere Namen, Schlüsselwörter, Länder, Forscher-URLs, Websites und persönliche externe Identifikatoren) anzufordern und um das zu lesen ORCID Datensatz lautet die Autorisierungs-URL:
https://sandbox.orcid.org/oauth/authorize?client_id=[APP-****************]&response_type=code&scope=/read-limited%20/activities/update%20/person/update&redirect_uri=https://developers.google.com/oauthplayground
Aber wir können Google OAuth Playground nutzen, um uns bei der Erstellung der Autorisierungs-URL zu helfen
- Fügen Sie /activities/update, /person/update, /read-limited in das Feld „Bereiche“ ein und klicken Sie auf „APIs autorisieren“.
Die Autorisierungs-URL wurde anhand der Informationen erstellt, die Sie in die Konfigurations- und Bereichsfelder eingegeben haben.
- An ORCID Der Anmeldebildschirm wird angezeigt. Melden Sie sich mit der E-Mail-Adresse und dem Passwort, mit denen Sie Ihr Sandbox-Konto erstellt haben, bei Ihrem Sandbox-Konto an ORCID Konto zu Beginn dieses Tutorials. Sobald Sie sich angemeldet haben, wird der OAuth-Bildschirm angezeigt. Auf diesem Bildschirm werden der Clientname und die relevanten Bereiche angezeigt. Um Zugriff zu gewähren, müssen Sie auf „Zugriff autorisieren'
- Nachdem Sie die Berechtigung erteilt haben, werden Sie zurück zum Google OAuth Playground weitergeleitet, da dies der Weiterleitungs-URI war, der mit Ihren Sandbox-Anmeldeinformationen verknüpft war. Ein 6-stelliger Autorisierungscode wird am Ende des Umleitungs-URI in der Adressleiste des Browsers (und unter dem) angezeigt Schritt 2 Abschnitt links auf der Seite im Google Oauth Playground)
Secure https://developers.google.com/oauthplayground/code=s536Z5
Sobald Sie über einen Autorisierungscode verfügen, können Sie diesen gegen ein Zugriffstoken und die Authentifizierung eintauschen iD des Benutzers, der sich angemeldet hat, den Sie benötigen, um die API-Aktion(en) auszuführen, für die Sie die Erlaubnis angefordert haben.
In einer realen Situation würde dieser Austausch von Ihrem System mithilfe einer Programmiersprache wie PHP, Java oder Ruby on Rails durchgeführt werden. Für dieses Tutorial verwenden wir Google OAuth Playground, um eine Webanwendung zu simulieren.
- Klicken Sie auf Kostenlos erhalten und dann auf Installieren. „Autorisierungscode gegen Token eintauschen“
Sobald Sie auf „Tauschen Sie den Autorisierungscode für Token aus„Ihr Zugriffstoken und authentifiziert iD erscheint in der Anfrage/Antwort Abschnitt auf der rechten Seite. Bitte sehen Sie sich das folgende Beispiel an:
{
"name": "Sophia Garcia"
"access_token": "53737721-9cdb-442a-8b77-409609bb5e43",
"expires_in": 631138518,
"token type": "bearer",
"orcid":
"0000-0002-4456-8947"
"scope": "read-limited /activities/update person/update "
"refresh token": "cOfc38fd-291e-4633-a365-6f4afa304344"
}
- Speichern Sie diesen Token!
Es ist wichtig, das Token, das Sie im obigen Schritt erhalten haben, zu speichern, da Sie damit problemlos alle erforderlichen Anrufe tätigen können. Wir empfehlen Ihnen, die vollständige Antwort auf den Token-Austausch zu speichern
Sie haben jetzt eine Authentifizierung gesammelt ID und die Erlaubnis des Benutzers, sie zu lesen ORCID aufzeichnen und aktualisieren ORCID Rekord.