Wie funktioniert „3-beiniges OAuth“?

ORCID Integrationen verwenden „3-beiniges OAuth“, um Benutzer zu authentifizieren und die Erlaubnis zur Interaktion mit ihren Datensätzen anzufordern. Jede Integration kann mithilfe der öffentlichen API Leseberechtigungen anfordern. ORCID Mitglieder können die Mitglieder-API verwenden, um Aktualisierungsberechtigungen anzufordern. Es funktioniert so:

• Sie erstellen einen speziellen Link
• Beim Anklicken wird der Benutzer weitergeleitet ORCID
  • ORCID fordert den Benutzer auf, sich anzumelden
  • ORCID fordert den Benutzer auf, Ihrer Anwendung die Erlaubnis zu erteilen
  • ORCID sendet den Benutzer mit einem Autorisierungscode an Ihr System zurück
• Ihr System tauscht diesen Code gegen ein Zugriffstoken aus

Die benutzerdefinierte Autorisierungs-URL enthält Ihre Kundeninformationen sowie die „Bereiche“, die die spezifischen Bereiche ihres Datensatzes angeben, auf die Sie zugreifen möchten. Nach der Anmeldung autorisiert der Benutzer die Verbindung mit Ihrem System und wird zusammen mit einem Autorisierungscode zu Ihrer Zielseite zurückgeleitet. Dieser Code wird dann verwendet, um ihre zu erhalten ORCID iD zusammen mit einem Zugriffstoken, das für die angeforderten Bereiche gültig ist.

Erstellen Sie den Autorisierungslink und rufen Sie einen Autorisierungscode ab

Sie erstellen Ihren Autorisierungslink, indem Sie die Client-ID Ihrer API-Anmeldeinformationen und die zugehörige Zielseite (Umleitungs-URI) angeben. Sie wählen aus, welche Berechtigungen angefordert werden sollen, indem Sie der Scope-Parameter.

Im folgenden Beispiel wird die Erlaubnis zum Lesen von Daten mit eingeschränktem Zugriff angefordert ORCID Sandbox-Testserver. In der realen Welt zeigen Sie diesen Link auf Ihrer Website an oder fügen ihn in eine E-Mail ein, wenn Sie den Benutzer zur Authentifizierung und Autorisierung auffordern. Zu Testzwecken können Sie es jedoch einfach in Ihren Webbrowser einfügen. Ersetzen Sie die Daten in Klammern durch Ihre Kundeninformationen und entfernen Sie unbedingt die eckigen Klammern!

https://sandbox.orcid.org/oauth/authorize?client_id=[Your client ID]&response_type=code&scope=/read-limited&redirect_uri=[Your landing page]

Sobald der Benutzer auf den Link geklickt hat, hat er sich angemeldet ORCID und erteilten Berechtigungen werden sie auf Ihre Website zurückgeleitet, wie folgt:

https://[Your landing page]?code=Q70Y3A

Tauschen Sie den Autorisierungscode gegen einen aus ORCID iD und Zugriffstoken

Sie sollten den Autorisierungscode umgehend gegen den austauschen ORCID iD und Zugriffstoken. Der Autorisierungscode verfällt bei Verwendung. Die Anfrage sieht so aus und kann nicht in einem Webbrowser erstellt werden, es muss von Ihrem Server erstellt werden.

 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 wird dann die Authentifizierung des Forschers zurücksenden ORCID iD und ein Zugriffstoken im JSON-Format:

{"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"}

Zugriffstoken haben standardmäßig eine lange Lebensdauer und verfallen 20 Jahre nach der Ausstellung. Der Token kann mehrfach verwendet werden, bevor er abläuft.

Verwenden Sie das Zugriffstoken

Dreibeinige Zugriffstoken sind mit bestimmten verknüpft ORCID aufzeichnen. Um sie zu verwenden, fügen Sie sie in API-Anfragen ein, die Sie zum Lesen oder Aktualisieren dieses Datensatzes stellen.