API-Tutorial: Daten in einem Datensatz lesen

Wir empfehlen Entwicklern, die öffentliche API im zu testen Sandbox-Testserver bevor Sie die Produktionsversion verwenden. Nachfolgend finden Sie die Schritte zur Registrierung für öffentliche API-Anmeldeinformationen sowohl in der Sandbox- als auch in der Produktionsumgebung.

• Melden Sie sich in Ihrem ORCID Aufzeichnung:
  Produktionsserver: https://orcid.org/signin
  Sandbox-Testserver: https://sandbox.orcid.org/signin
• Klicken Sie oben rechts auf Ihren Namen
• Klicken Sie  Entwicklertools aus der Menüoption
  Hinweis: Um auf die Entwicklertools zugreifen zu können, müssen Sie Ihre E-Mail-Adresse bestätigen. Wenn Sie Ihre E-Mail-Adresse noch nicht bestätigt haben, werden Sie dazu aufgefordert, bevor Sie sich für öffentliche API-Anmeldeinformationen registrieren können
• Lesen Sie die 'ORCID Nutzungsbedingungen für öffentliche Kunden
• Klicken Sie auf „Registrieren für“. ORCID „Öffentliche API-Anmeldeinformationen“-Schaltfläche.

Ausfüllen des Formulars mit den Bewerbungsdetails

• Sobald Sie sich für Ihre öffentlichen API-Anmeldeinformationen registriert haben, werden Sie zurück zu den Entwicklertools weitergeleitet (https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
• Sie müssen das Formular mit den Bewerbungsdetails ausfüllen, um eine neue Bewerbung zu registrieren.
  • Name: Der Name Ihrer Anwendung. Dies wird den Benutzern angezeigt, wenn sie Ihrer Anwendung die Erlaubnis erteilen, ihre zu erhalten ORCID iD, und es wird in ihrem angezeigt Liste vertrauenswürdiger Organisationen. Wir empfehlen, den Namen Ihrer Organisation oder Ihres Dienstes zu verwenden (z. B. den Namen einer Zeitschrift).
  • Anwendungs-URL: Die Website, die der Benutzer besuchen kann, um mehr über Ihre Anwendung zu erfahren. Dies wird auch in ihrem angezeigt Liste vertrauenswürdiger Organisationen.
  • Anwendungsbeschreibung: Informationen über die Anwendung, die Sie entwickeln, und wie Sie die des Benutzers verwenden werden ORCID Ausweis. Dies wird den Benutzern auf dem OAuth-Bildschirm angezeigt.

Hinzufügen Umleitungs-URIs

Sobald der Benutzer Ihre Anwendung autorisiert hat, werden sie an einen von Ihnen angegebenen URI zurückgegeben. Sie müssen diese URIs im Voraus bereitstellen, da sonst bei Ihren Integrationsbenutzern ein Fehler auftritt.

• Geben Sie Ihren Weiterleitungs-URI in das dafür vorgesehene Feld ein
• Wenn Sie mehr als einen Umleitungs-URI eingeben müssen, klicken Sie auf „Weiteren Umleitungs-URI hinzufügen“.

Bitte beachte:

• Nur HTTPS-URIs werden in die Produktion übernommen
• Domains registriert MUST macht exakt mit den verwendeten Domains, inklusive Subdomains, übereinstimmen
• Registrieren Sie nach Möglichkeit alle Weiterleitungs-URIs vollständig. Dies ist die sicherste Option und wird von uns empfohlen. Weitere Informationen zu Weiterleitungs-URIs finden Sie in unserem FAQ zur Umleitungs-URI

Speichern Ihrer Bewerbung

Sobald Sie das Bewerbungsformular ausgefüllt und Ihre Weiterleitungs-URIs hinzugefügt haben, können Sie Ihre Bewerbung speichern.

• Klicken Sie auf „Meine Anwendung speichern und meine Client-ID und mein Geheimnis generieren“.

Sie werden zurück zur Entwicklertools-Seite weitergeleitet, die nun Ihre Anmeldeinformationen für den öffentlichen API-Client enthält

Aktualisieren Ihrer Anmeldeinformationen

Eine Änderung Ihrer Bewerbungsinformationen ist sehr einfach.

• Bearbeiten Sie die relevanten Informationen und klicken Sie dann auf „Antrag speichern“.

Nutzen Sie Ihre Anmeldedaten

Da Sie nun über Ihre Anmeldeinformationen verfügen, ist es an der Zeit, mit der Nutzung zu beginnen ORCID Öffentliche API!

Bitte beachten Sie, dass wir Ihre Zugangsdaten an die Mitglieder-API übertragen können, wenn Sie Mitglied werden ORCID Mitglied in der Zukunft.

Du kannst dich Fordern Sie Anmeldeinformationen für die Sandbox-Mitglieds-API an um Ihre Anwendung zu erstellen und zu testen. Mit diesen Anmeldeinformationen können Sie Aufrufe an die Sandbox-Premium-Mitglieds-API tätigen, um zu lesen, zu schreiben und zu aktualisieren ORCID Aufzeichnungen. Der Zugriff auf die Sandbox-Testumgebung steht jedem frei zur Verfügung, auch wenn Sie kein Benutzer sind ORCID Mitgliedsorganisation.

Note: Wenn Sie eine verwenden ORCID zertifiziertes Service-Provider-System, das bereits ORCIDmüssen Sie sich nicht für Sandbox-API-Anmeldeinformationen registrieren, es sei denn, Sie möchten die ORCID Integrationsfunktionalität innerhalb der Sandbox-Umgebung. 

Mit der Sandbox können Sie Testbenutzerkonten erstellen und Ihre Integration entwickeln, ohne sich Gedanken über die Beeinträchtigung der Live-Daten (Produktion) machen zu müssen. ORCID Registrierung. Die Sandbox verhält sich genauso wie die Produktion ORCID Registrierung bei ein paar Ausnahmen.

Erstellen eines Testkontos

Um das zu testen ORCID API und API-Aufrufe, z. B. das Lesen und Hinzufügen von Informationen zu einem ORCID Um den Datensatz aufzuzeichnen, müssen Sie auch einen Test erstellen ORCID Aufnahme in die Sandbox. Dies kann über die Benutzeroberfläche erfolgen, ähnlich wie in der Produktion ORCID Registrierung. Gehe zu https://sandbox.orcid.org/register und registrieren Sie sich für ein Konto.

Mailinator-E-Mail-Adressen

Der Sandbox-Server sendet E-Mails nur an Mailinator (@mailinator.com) E-Mail-Adressen, um Mailserver nicht unbeabsichtigt zu spammen. Sie erhalten keine Verifizierungs-E-Mail oder Benachrichtigung zum Zurücksetzen des Passworts, es sei denn, Sie verwenden eine @mailinator.com-Adresse und eine Verifizierung ist erforderlich, um manuelle Änderungen an Sandbox-Datensätzen vorzunehmen. Erfahren Sie mehr über die kostenlosen öffentlichen Posteingänge . Wenn Sie a nicht verwenden möchten Mailinator Bitte notieren Sie sich dann Ihren Benutzernamen und Ihr Passwort (da Sie diese beim Testen zur Autorisierung Ihrer Anwendung verwenden) und kontaktieren Sie uns, um Unterstützung bei der Verifizierung anzufordern.

Mailinator ist ein E-Mail-Dienst, der über einen öffentlichen kostenlosen Dienst und einen privaten kostenpflichtigen Dienst verfügt. Zum Testen können Sie den völlig kostenlosen öffentlichen Dienst nutzen. Erfahren Sie mehr über ihre Stufen Hier .

Mailinator ist ein Drittanbieterdienst, der nicht von verwaltet oder gewartet wird ORCID. Wir empfehlen Ihnen, die Funktionsweise dieses Dienstes und seine Einschränkungen zu prüfen, bevor Sie diese Adressen verwenden.

Jeder mit öffentlichen oder Mitglieds-API-Anmeldeinformationen kann eine erhalten /read-public Zugangstoken. Um einen Token zu erhalten, rufen Sie an ORCID API-Token-Endpunkt.

Dieser Prozess wird oft als OAuth-Ablauf für Client-Anmeldeinformationen oder 2-stufiges OAuth bezeichnet.

Ein Beispielaufruf zum Erhalten eines Zugriffstokens zum Lesen öffentlicher Daten in der Sandbox – ersetzen Sie die Platzhalter durch Ihre Anmeldeinformationen (entfernen Sie unbedingt die Klammern).

URL=https://sandbox.orcid.org/oauth/token
  HEADER: Accept: application/json
  METHOD: POST
  DATA: 
    client_id=[Your public API client ID]
    client_secret=[Your public API secret]
    grant_type=client_credentials
    scope=/read-public

Sie erhalten dann ein Zugriffstoken ähnlich dem folgenden zurück. Der zurückgegebene Token ist langlebig (er läuft etwa 20 Jahre lang nicht ab) und kann mehrfach zum Abrufen öffentlicher Daten verwendet werden ORCID Records. 

{"access_token":"4bed1e13-7792-4129-9f07-aaf7b88ba88f","token_type":"bearer",
"refresh_token":"2d76d8d0-6fd6-426b-a017-61e0ceda0ad2","expires_in":631138518,
"scope":"/read-public","orcid":null}

Hinweis: Alle Token mit dem Geltungsbereich /authenticate enthalten jetzt auch den Geltungsbereich /read-public. Wenn Sie nur den Bereich /authenticate verwenden, können Sie die gespeicherten Zugriffstoken zum Lesen öffentlicher Daten verwenden, ohne erneut ein Zugriffstoken anfordern zu müssen. 

Integratoren, die die Mitglieds-API verwenden, können die verwenden /read-public Spielraum zum Lesen ORCID Zusammenfassungen aufzeichnen.

Um einen /lesebeschränkten Zugriff zu erhalten, müssen Sie den Forscher um Erlaubnis bitten. Sie tun dies mit OAuth. Konkret: „3-beiniges OAuth".

Weitere Informationen finden Sie in unserem API-Tutorial: Lesen Sie Daten auf einem ORCID Rekord

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.

Die Sichtbarkeit gibt die Datenschutzeinstellung des Elements an, basierend auf der vom Benutzer festgelegten Sichtbarkeitseinstellung. Wenn bei der Veröffentlichung von Informationen über die API ein Sichtbarkeits-Tag enthalten ist, wird es ignoriert. Vielmehr werden die Informationen gemäß der standardmäßigen Sichtbarkeitseinstellung des Benutzers veröffentlicht, die in seinen Kontoeinstellungen festgelegt ist.

Öffentliche Elemente können von jedem über die API gelesen werden und werden im öffentlichen Datensatz des Forschers angezeigt. Elemente vertrauenswürdiger Parteien werden nur über die API an Clients zurückgegeben, die über eingeschränkten Lesezugriff verfügen. sie sind nicht in den öffentlichen Aufzeichnungen des Forschers enthalten. Private Elemente sind nur für den Forscher und die Quelle des Elements sichtbar – die einzigen privaten Elemente, die über die API zurückgegeben werden, sind diejenigen, die über Ihre Integration zum Datensatz hinzugefügt wurden Weitere Informationen zu Sichtbarkeitseinstellungen finden Sie im ORCID Registratur.

Dieser Beispielaufruf ruft eine Zusammenfassung des gesamten ab ORCID Datensatz im XML-Format mithilfe der Member-API auf dem Sandbox-Server. Sie benötigen ein Zugriffstoken, um API-Anfragen an die öffentliche oder Mitglieder-API zu stellen.

Method: GET Accept: application/vnd.orcid+xml
Authorization type and Access token: 
Bearer [Stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/record

Die API gibt eine 200 OK-Nachricht zurück, die angibt, dass die Anfrage erfolgreich empfangen wurde, und die vollständige Zusammenfassung der Anfrage ORCID Aufzeichnung, einschließlich Zusammenfassungen einzelner Elemente.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>
     <funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">
  [...] 
  </record:record>

Für jedes Element (Arbeit, Finanzierung, Beschäftigung usw.) gibt es eine Code eingeben. Dies kann bei Bedarf verwendet werden, um vollständige Details zum Artikel zu erhalten.

Der ORCID Der Datensatz ist in einzelne Abschnitte unterteilt, um das Lesen des Datensatzes schneller und konsistenter zu gestalten. Sie können zunächst einen Abschnitt aufrufen, um dessen Zusammenfassung zu erhalten, und dann mithilfe des Put-Codes eines einzelnen Elements aufrufen, um aussagekräftige Informationen zu diesem Element zu erhalten.

Nachfolgend finden Sie eine Tabelle mit den zusammenfassenden Abschnitten, die Sie mit der API lesen können.

Alle Artikel (außer dem Biografietext) auf einem ORCID Rekord haben eine Code eingeben:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>   
<record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>      
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">   [...] 
</record:record>

Mit diesem Put-Code kann die API aufgerufen werden, um die vollständigen Daten für einen Artikel abzurufen. Die folgenden Elemente können mit a abgefragt werden Code eingeben:

Mithilfe des Abschnittsendpunkts und des Put-Codes können Sie die API mit demselben Zugriffstoken aufrufen, um dieses bestimmte Element vollständig abzurufen. Dieser Beispielaufruf ruft den vollständigen Finanzierungsartikel 4413 im XML-Format mithilfe der Mitglieds-API auf dem Sandbox-Server ab.

Method: GET Accept: application/vnd.orcid+xml Authorization type and Access token: Bearer [stored access token]URI: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/funding/4413

Beispielaufruf: GitHub

Die API gibt eine 200 OK-Nachricht zurück, um anzugeben, dass die Nachricht erfolgreich empfangen wurde, und gibt den vollständigen XML-Code des Finanzierungselements zurück:

<?xml version="1.0"  encoding="UTF-8" standalone="yes"?>
    <funding:funding put-code="4413" path="/0000-0002-9227-8514/funding/4413" visibility="public"  [...] >
    [...] 
    </funding:funding>

Sie können das überprüfen Quelle eines Artikels wenn Sie es lesen möchten, wenn Sie wissen möchten, wer es hinzugefügt hat.

Funktioniert ORCID werden auf der Grundlage ihrer Identifikatoren und der Beziehung dieser Identifikatoren zum Werk gruppiert. Es gibt vier Arten von Beziehungen:

• Selbst: Die Kennung bezieht sich ausschließlich auf dieses Werk und kann mit anderen Werken gruppiert werden, die dieselbe Kennung haben
• Ein Teil: Das Werk ist Teil dieser Kennung und kann nicht mit anderen Werken gruppiert werden
• Version von: Diese Identifikatoren gelten für alternative Versionen des Werks und können mit Selbst- und Versions-Identifikatoren gruppiert werden
• Gefördert durch: Diese Kennungen gelten für die Finanzierung der Arbeit. Diese Kennungen werden nicht zur Gruppierung von Werken verwendet.

Unsere API bietet hierfür Unterstützung im XSD. Jedes Element hat ein Anzeigeindexattribut, das seinen Rang innerhalb seiner Gruppe angibt. Der höchste Anzeigeindex ist das vom Forscher ausgewählte bevorzugte Element. Über die API hinzugefügte Elemente, die vom Forscher nicht bewertet wurden, haben einen Anzeigeindex von 1 und werden als standardmäßig bevorzugte Quelle innerhalb der Gruppe verwendet, bis sie vom Forscher geändert werden. Der Anzeigeindex bestimmt auch die Arbeitsreihenfolge beim Lesen der ORCID Datensatz mit der API.

Weitere Informationen zur Gruppierung finden Sie unter ORCID Aufzeichnungen finden Sie in unserer Unterstützungsartikel.

Der ORCID Registry unterstützt „Content Negotiation“. Dies bedeutet, dass Maschinen und andere Systeme nachfragen können ORCID Register für Personenmetadaten in verschiedenen Formaten.

Eines dieser Formate ist JSON-LD, das das verwendet schema.org Vokabular, insbesondere der Personentyp, die wir mit Werken, Organisationen und anderen Identifikatoren verknüpfen. Wir unterstützen auch XML, JSON, RDF XML und Turtle und haben Cross-Origin Resource Sharing (CORS) implementiert, um den Zugriff auf unsere Daten zu erleichtern.

• Siehe Blogbeitrag für einen Überblick über ORCID und schema.org
• Sie finden weitere Information unter den jeweiligen Technische Dokumentation zur Inhaltsverhandlung

Suche nach einem Benutzer mit cURL wie folgt:

curl -iL https://orcid.org/0000-0000-0000-0000

Gibt 200 zurück, auch wenn der Benutzer nicht existieren. Um dies zu vermeiden, verwenden Sie in Ihrem Anruf die Inhaltsverhandlung wie folgt:

curl -iL -H 'Accept: application/xml' https://orcid.org/0000-0000-0000-0000