ORCID bietet mehrere APIs, die es Ihren Systemen ermöglichen, eine Verbindung zum herzustellen ORCID Registrierung, einschließlich Lesen und Schreiben ORCID Aufzeichnungen. Einige API-Funktionen sind für jedermann frei verfügbar (Public API); andere stehen nur zur Verfügung ORCID Mitgliedsorganisationen (Mitglieder- und Premium-Mitglieder-API).
Jeder kann die API auf unserem Sandbox-Testserver testen und wir ermutigen alle Organisationen, diese zu verwenden ORCID – Mitglieder und Nichtmitglieder – um sich unserem anzuschließen API-BenutzergruppeHier können Sie Fragen stellen und sich über neue technische Entwicklungen informieren.
Durchsuchen Sie die FAQs hier:
Die Grundlagen
Elemente (Arbeiten, Beschäftigung, Finanzierung, Peer-Review usw.) können zu einem hinzugefügt werden ORCID entweder manuell oder mit dem aufzeichnen ORCID Mitglieds-API. Wenn Sie eine Einzelperson sind und Ihre Akte aktualisieren möchten, schauen Sie sich unsere an Hilfebereich dazu finden Sie hier. Wenn Sie Mitglied sind und Elemente zu einem hinzufügen möchten ORCID Für die Aufnahme benötigen Sie Folgendes:
- Die Erlaubnis der Forscher
- Anmeldeinformationen für die Mitglieds-API
- Und entweder:
- Ein Anbietersystem, das sich in das integrieren lässt ORCID Mitglieder-API
- Ihr eigenes System, das sich in das integrieren lässt ORCID Mitglieder-API
Eine vollständige Anleitung für Mitglieder, die die API verwenden, um Elemente in einen Datensatz aufzunehmen, finden Sie in unserem API-Tutorial-Link unten:
Zur Unterstützung der sozialen Komponente bieten wir ein Toolkit an Outreach-Ressourcen um Ihnen bei der Entwicklung einer Kampagne zur Unterstützung Ihrer Integration und der Kommunikation mit Ihren Forschern zu helfen:
- Was ORCID ist.
- Warum Ihr System IDs sammelt und wie Ihr System Aufgaben ausführt, z. B. die Aktualisierung ihrer Datensätze.
- Warum Ihre Forscher von der Erstellung einer ORCID iD und ihre IDs mit Ihrem System verbinden.
- Wie ORCID kommt der breiteren, globalen Forschungsgemeinschaft zugute.
Wir werden diese „Bibliothek“ an Ressourcen basierend auf dem Feedback der Community kontinuierlich erweitern. Wenn Sie eine Idee für etwas haben, das Ihnen gefallen könnte, können Sie sich gerne an uns wenden.
Integration ORCID in Ihr System ermöglicht es Ihrer Organisation, authentifizierte Daten zu sammeln ORCID iDs und fügen Sie sie zu Ihren eigenen Daten hinzu. Gleichzeitig erteilt der Forscher der Organisation die Erlaubnis, von und zu lesen und zu schreiben ORCID Rekord.
Damit dies funktioniert, Organisationen MUST macht erhalten authentifiziert ORCID IDs Verwendung der ORCID OAuth-API. Dies bedeutet, dass sie eine enthalten ORCID Marken-Schaltfläche oder Link in ihrem System, der den Benutzer beim Klicken dazu auffordert, sich bei ihm anzumelden ORCID Rekord.
Sobald der Benutzer angemeldet ist, wird er aufgefordert, den Zugriff auf das System zu autorisieren ORCID iD
Die des Benutzers ORCID iD und Name auf dem ORCID Der Datensatz (abhängig von den Sichtbarkeitseinstellungen) wird im Rahmen dieses Prozesses an die Organisation zurückgegeben. Das System kann dann weitere Daten von der anfordern ORCID API.
Der oben beschriebene Workflow zum Sammeln authentifizierter APIs ist in beiden verfügbar ORCID's öffentliche und Mitglieder-APIs. Ersteres steht nichtkommerziellen Diensten kostenfrei zur Nutzung zur Verfügung.
Der Prozess, um die Erlaubnis zum Hinzufügen oder Aktualisieren von Daten eines Benutzers zu erhalten ORCID Der Datensatz verwendet OAuth, wie in unserem beschrieben 3-beinige OAuth-FAQ. Nur ORCID Mitglieder können die Mitglieder-API verwenden, um Aktualisierungsberechtigungen anzufordern. Vereinfacht ausgedrückt funktioniert es so:
- Ihr lokales System erstellt einen speziellen Link
- Beim Anklicken wird der Benutzer weitergeleitet ORCID, meldet sich an und erteilt die Erlaubnis
- ORCID sendet den Benutzer mit einem „Autorisierungscode“ an Ihr System zurück
- Ihr System tauscht diesen Code gegen ein „Zugriffstoken“ aus.
- Mit dem Zugriffstoken können Sie den Benutzerdatensatz aktualisieren
ORCID ist bestrebt, transparente und vertrauenswürdige Verbindungen zwischen Forschern, ihren Beiträgen und ihren Zugehörigkeiten zu ermöglichen, indem Einzelpersonen eine eindeutige, dauerhafte Kennung bereitstellen, die sie bei der Teilnahme an Forschungs-, Wissenschafts- und Innovationsaktivitäten verwenden können. Sicherstellen, dass die korrekte ORCID iD Die Verbindung mit dem richtigen Forscher ist ein entscheidender Schritt beim Aufbau der Vertrauenswürdigkeit des ORCID Datensatz und das breitere Ökosystem der wissenschaftlichen Kommunikation. Aus diesem Grund, ORCID erlaubt nicht die manuelle Erfassung oder Eingabe von ORCID IDs in jedem Workflow, in dem eine Erfassung möglich ist ORCID Ausweise direkt von den Rekordhaltern selbst.
Forscher können ihre Daten einfach und sicher teilen ORCID iDs mit den Systemen, mit denen sie interagieren, was beweist, dass sie deren Besitzer sind ORCID Ausweis. Diese Systeme können dann Informationen über Forscheraktivitäten mit anderen Systemen teilen, wodurch eine Kette validierter und vertrauenswürdiger Aussagen über Forscheraktivitäten entsteht. Das Endergebnis ist, dass der richtigen Person in einem breiten Spektrum wissenschaftlicher Informationsabläufe die richtigen Aktivitäten zugeordnet werden.
Für weitere Informationen siehe: https://info.orcid.org/collecting-and-sharing-orcid-ids/
Sie können Ihren Benutzern das Leben erleichtern, indem Sie validierte Informationen mit ihnen verknüpfen ORCID Aufzeichnungen. Sie tragen außerdem dazu bei, Vertrauen in die wissenschaftliche Kommunikation aufzubauen, und indem Sie diese Daten auf dem neuesten Stand halten, können Sie den Berichtsaufwand für Ihre Benutzer verringern und die Datenqualität verbessern.
ORCID für Forschungseinrichtungen
Zusätzlich zur Verwendung als dauerhafte Kennung für Ihre Forscher, ORCID kann Ihnen dabei helfen, die Kontrolle darüber zu behalten, wie der Name Ihrer Institution in Forschungssystemen verwendet wird. In Kombination mit anderen persistenten Identifikatoren ORCID ermöglicht es Ihnen, die Zugehörigkeit Ihrer Mitarbeiter, Lehrkräfte und Studenten zu Ihrer Institution verbindlich geltend zu machen. Sie können auch verwenden ORCID APIs, um Echtzeitbenachrichtigungen über Forschungsaktivitäten zu erhalten, Formulare automatisch zu aktualisieren und die Karrieren Ihrer Alumni zu verfolgen.
ORCID für Förderorganisationen
Durch Einbetten ORCID Mit iDs in Ihren Förderabläufen können Sie Ihre Stipendiaten und Förderprogramme zuverlässig verknüpfen – und allen Zeit sparen und Fehler reduzieren, die durch die manuelle Eingabe von Informationen entstehen. Benutzen ORCID In Ihren Systemen können Sie Ihren Teil zum Aufbau einer vertrauenswürdigen Forschungsinformationsinfrastruktur beitragen, indem Sie Verbindungen zwischen Einzelpersonen und den ihnen gewährten Zuschüssen herstellen.
ORCID für Verlage
Forscher stehen im Mittelpunkt aller Aktivitäten von Wissenschafts- und Forschungsverlagen. Genaue Autoren- und Gutachterinformationen sind für die Indizierung, Suche und Entdeckung, Veröffentlichungsverfolgung, Finanzierungs- und Ressourcennutzungszuordnung sowie die Unterstützung von Peer-Reviews von entscheidender Bedeutung.
ORCID dient als Informationsdrehscheibe und ermöglicht Ihren Autoren und Rezensenten eine zuverlässige Verbindung zu ihren Beiträgen und den Austausch von Informationen aus ihnen ORCID zeichnen Sie auf, wie sie mit Ihren Veröffentlichungssystemen interagieren. Das Sammeln von IDs für alle Ihre Autoren und Gutachter während des Veröffentlichungsprozesses – sei es für Bücher, Zeitschriften, Datensätze, Kompositionen, Präsentationen, Code oder eine Vielzahl anderer Werke – ermöglicht eine einfache Weitergabe von Informationen und stellt sicher, dass Forscher ihre Einwilligung zur Weitergabe erteilen können. spart Forschern Zeit und Ärger, verringert das Fehlerrisiko und ermöglicht es Forschern vor allem, die Anerkennung zu erhalten, die sie für die wichtige Arbeit, die sie leisten, verdienen.
Anfrage der Mitgliedsorganisationen ORCID Mitglieds-API-Anmeldeinformationen auf dem Produktionsserver (Liveserver), indem Sie Folgendes ausfüllen Antragsformular für den Production Member API-Client. Vor der Ausgabe der API-Anmeldeinformationen für Produktionsmitglieder muss die ORCID Das Engagement-Team/der Konsortialleiter wird eine Demo Ihrer Integration im ORCID Sandbox. Dies gibt uns die Möglichkeit, die großartigen Integrationen zu sehen, die Sie erstellt haben, und Workflow-Verbesserungen anzubieten. Außerdem können wir prüfen, ob alle Integrationen unseren Best Practices und Mindestanforderungen für den Start entsprechen.
Um eine Demo Ihres Systems bereitzustellen, müssen Sie eine funktionierende Integration mit dem einrichten ORCID Sandbox, die die ORCID Das Team kann eine Vorschau anzeigen. Es gibt mehrere Möglichkeiten, Ihre funktionierende Sandbox-Integration zu teilen:
- Empfohlen: Live-Demo: Kontaktieren Sie uns, um eine Live-Demonstration zu vereinbaren. Wir stellen Ihnen eine Meeting-Software zur Verfügung, mit der Sie Ihren Bildschirm freigeben können, um Ihre Integration vorzuführen.
- Testseite: Wenn Ihre Entwicklungsseite öffentlich ist, Schicken Sie uns die URL zusammen mit Testanmeldeinformationen (falls erforderlich) für den Zugriff auf Ihr System und Anweisungen zur Verwendung Ihres Systems ORCID Merkmale. Stellen Sie zusätzliche Dokumentation bereit, um zu überprüfen, was wir vom Benutzer aus nicht sehen können, z. B. die verwendete API-Version, welche Daten von Ihrem System gespeichert werden usw.
- Screencast oder Screenshots:Senden Sie eine Aufnahme oder eine Reihe von Screenshots mit Beschreibungen, die klar erklären und demonstrieren, wie Ihre Integration in jedem Schritt funktioniert, einschließlich dessen, was passiert, wenn ein Benutzer den Zugriff verweigert oder seine iD trennt. Stellen Sie sicher, dass Sie zusätzliche Unterlagen bereitstellen, um alles zu verifizieren, was wir vom Benutzer aus nicht sehen können, z. B. die verwendete API-Version und wie Daten gespeichert werden
Integration
Anmeldeinformationen für öffentliche Kunden werden Einzelpersonen und nicht Organisationen gewährt. Anmeldeinformationen können nicht von einer Person auf eine andere übertragen werden, sie können jedoch in API-Anmeldeinformationen für Mitglieder umgewandelt werden, wenn alle Parteien zustimmen und die Organisation ein aktives Mitglied ist ORCID.
Den Kunden verschieben ID Die Verbindung mit der Mitglieder-API ändert nicht die Client-ID, sondern nur das Client-Geheimnis, und Sie behalten die Anzahl der verbundenen iDs mit Ihrer schreibgeschützten Berechtigung.
Bei der Konvertierung des Public API-Clients in einen Member API-Client wird der Nutzungsbedingungen für öffentliche Kunden gelten nicht mehr und werden durch die Bedingungen der Mitgliedsvereinbarung ersetzt.
Für die Überweisung benötigen wir:
- Bestätigung des öffentlichen API-Clients ID umgewandelt werden.
- Das ist der Hauptkontakt der Organisation und der Datensatzinhaber des aktuellen öffentlichen API-Clients ID stimmen Sie der Änderung der Nutzungsbedingungen zu. (Der Inhaber der Aufzeichnungen muss ein Mitarbeiter, Auftragnehmer oder leitender Angestellter der Mitgliedsorganisation sein.) Wir werden die Zustimmung beider Parteien protokollieren.
- Ein Datum/eine Uhrzeit für die Migration. Im Rahmen dieser Migration werden wir den Client aktualisieren ID und senden Ihnen ein neues Client-Geheimnis in einer verschlüsselten E-Mail. Bitte beachten Sie, dass Ihre Integration nach der Aktualisierung des Clients erst dann funktioniert, wenn Sie das Client-Geheimnis aktualisieren. Aus diesem Grund müssen wir ein Datum und eine Uhrzeit dafür festlegen, um Unannehmlichkeiten für die Benutzer zu vermeiden.
Damit die Konvertierung abgeschlossen werden kann, müssen Sie Folgendes aktualisieren:
- Das alte Client-Geheimnis zum neuen Client-Geheimnis.
- Der API-Host von Kneipe.orcid.org €XNUMX zu api.orcid.org €XNUMX.
Mit Ihrer konvertierten Member API-Client-ID können Sie die hinzuzufügenden Bereiche aktualisieren Mitglieder-API-Bereiche. Dies erfordert eine Autorisierung durch die Benutzer und es werden neue Zugriffstoken generiert, um die neuen Bereiche/Berechtigungen einzuschließen.
Bitte beachten Sie, dass wir die Anmeldeinformationen von Mitglieds-API-Clients nicht in Anmeldeinformationen für die öffentliche API umwandeln können.
Zur Unterstützung der sozialen Komponente bieten wir ein Toolkit an Outreach-Ressourcen um Ihnen bei der Entwicklung einer Kampagne zur Unterstützung Ihrer Integration und der Kommunikation mit Ihren Forschern zu helfen:
- Was ORCID ist.
- Warum Ihr System IDs sammelt und wie Ihr System Aufgaben ausführt, z. B. die Aktualisierung ihrer Datensätze.
- Warum Ihre Forscher von der Erstellung einer ORCID iD und ihre IDs mit Ihrem System verbinden.
- Wie ORCID kommt der breiteren, globalen Forschungsgemeinschaft zugute.
Wir werden diese „Bibliothek“ an Ressourcen basierend auf dem Feedback der Community kontinuierlich erweitern. Wenn Sie eine Idee für etwas haben, das Ihnen gefallen könnte, können Sie sich gerne an uns wenden.
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.
Integrationen müssen mehr als nur speichern ORCID Aufzeichnungen. Ihr System muss in der Lage sein:
- Akzeptieren und speichern ORCID IDs: Ihr System muss das wissen iD dauert ebenfalls 3 Jahre. Das erste Jahr ist das sog. ORCID Datensatz zur Anzeige der iD und korrekt zu aktualisieren. Speichern Sie es zusammen mit den Informationen des Forschers, die in der Token-Austauschantwort zurückgegeben werden. Wir empfehlen, die vollständige https-URI zu speichern: https://orcid.org/0000-0001-5727-2427.
- Akzeptieren und speichern Sie persistent Zugriffstoken und Token aktualisieren: Zugriffstoken können zum Lesen und Aktualisieren von Datensätzen sowie zum Anzeigen verwendet werden, dass die iD wurde authentifiziert. Zugriffstoken sind etwa 20 Jahre lang gültig oder bis der Benutzer sie widerruft. Wir empfehlen Ihnen außerdem, die Token-Bereich, Token-Ablauf und Token aktualisieren. Aktualisierungstoken können bei Bedarf verwendet werden, um neue Zugriffstoken mit demselben oder eingeschränktem Umfang zu erstellen. Speichern Sie die Daten des Zugriffstokens zusammen mit den Informationen des Forschers.
- Akzeptieren und speichern Codes eingeben : Jedes Element, das Sie hinzufügen, um ORCID Die Registrierung wird von der mit einem Put-Code zurückgegeben ORCID API. Speichern Sie diesen 6-stelligen Put-Code zusammen mit dem Artikel in Ihrem System. So können Sie erkennen, welcher Artikel gelesen, aktualisiert oder gelöscht werden muss.
- Geben Sie Fehlermeldungen und einen Support-Kontakt an, wenn eine Interaktion nicht wie erwartet verläuft.
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 Bewerbung speichern und meinen Kunden generieren“. ID und geheim'
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.
Es gibt eine Reihe von Anforderungen, die wir von allen Mitgliederintegrationen erwarten. Der ORCID Das Team stellt im Rahmen des Integrationsüberprüfungsprozesses sicher, dass diese Anforderungen erfüllt wurden.
- Verwenden Sie die OAuth zu authentifizieren ORCID iDs (Erlauben Sie Benutzern nicht, nach IDs zu suchen oder etwas einzugeben ORCID IDs.)
- Präsentieren Sie den OAuth-Autorisierungsbildschirm gemäß unserem Richtlinien
- Fügen Sie ein ORCID gebrandeter Button oder Link auf Ihrer Website, um die Authentifizierung der iD einzuleiten.
- Verwenden Sie HTTPS für die Umleitungs-URIs Ihrer Website und darüber hinaus ORCID API-Aufrufe
- Akzeptieren und speichern Sie alle im Token-Austausch zurückgegebenen Daten zusammen mit den Benutzerdaten in Ihrem System
- Verwenden Sie geeignete Zielfernrohre und Anforderungsmethoden (z. B. POST-Aufrufe zum Hinzufügen neuer Informationen und PUT-Aufrufe zum Aktualisieren vorhandener Informationen)
- Zeigen Sie die authentifizierten Dokumente öffentlich an ORCID IDs. IDs sollten gemäß unserer angezeigt werden Marke und iD Anzeigerichtlinien.
- Unterlassen Sie Fordern Sie Benutzer auf, ihre Sichtbarkeitseinstellungen für Elemente auf ihrem zu ändern ORCID Datensatz, um Ihre Integration zu verwenden.
Sie müssen das ausfüllen Formular zur Registrierung einer Kundenanwendung. Nachfolgend finden Sie einen kurzen Überblick über die angeforderten Felder:
Name der Organisation: Ihre ORCID Name der Mitgliedsorganisation
Primäre Kontakt-E-Mail-Adresse für Anmeldeinformationen: Wir verwenden diese E-Mail-Adresse, um Ihnen die Anmeldeinformationen in einer verschlüsselten E-Mail zu senden und Sie zu kontaktieren, wenn bei Ihrer Integration Fragen oder Fehler auftreten.
Sekundäre E-Mail für Passwort: Eine E-Mail-Adresse, an die wir Ihr verschlüsseltes E-Mail-Passwort senden können.
Name Ihres Auftraggebers: Das wird dein ORCID Name der Mitgliedsorganisation. Wenn Sie mehr als eine Integration haben, hängen wir die Anwendung an den Namen an.
URL der Homepage Ihrer Anwendung: Wird als Link in der Liste der vertrauenswürdigen Organisationen innerhalb der Benutzer angezeigt ORCID Seite „Vertrauenswürdige Parteien“. Dies sollte ein Link zurück zu Ihrer Organisation oder zur Hauptseite Ihrer Bewerbung sein.
Kurze Beschreibung Ihrer Client-Anwendung: Dieser Text wird Ihren Integrationsbenutzern auf dem Autorisierungsbildschirm mit dem Fragezeichensymbol angezeigt. Eine kurze Beschreibung Ihrer Integration ist erforderlich
URIs umleiten: 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.
- Es werden nur HTTPS-URIs akzeptiert.
- Registrierte Domänen müssen exakt mit den verwendeten Domänen (einschließlich Subdomänen) übereinstimmen.
- Registrieren Sie nach Möglichkeit alle Weiterleitungs-URIs vollständig.
- Mehr als 5 Weiterleitungs-URIs erforderlich? Bitte geben Sie dies in den Anmerkungen an ORCID Mitarbeiter.
Hinweise für ORCID Personal: Verwenden Sie dieses Feld zum Zulassen ORCID Mitarbeiter weitere Informationen zu Ihrem Anliegen oder Ihrer Integration
Such- und Link-Assistenten sind Integrationen, mit denen Artikel (hauptsächlich Werke) in die importiert werden können ORCID Registrierung. Sie müssen zwischen dem Integrator und getestet werden ORCID bevor sie in der Produktionsregistrierungsumgebung freigegeben werden können.
Abhängig von Ihren Antworten auf die folgenden Fragen ist Ihre Integration möglicherweise ein geeigneter Kandidat für die Suche und Verknüpfung. Bitte kontaktieren Sie uns, um dies weiter zu besprechen, bevor Sie mit der Entwicklung eines Such- und Verknüpfungsassistenten beginnen:
- Was ist die Zielgruppe des Zauberers? Zum Beispiel Autoren, Gutachter oder Fördermittelantragsteller auf nationaler, disziplinärer oder globaler Ebene
- Wie groß ist ungefähr das erwartete Publikum?
- Wird es einer Bevölkerung dienen, die derzeit von bestehenden Zauberern unterversorgt ist? Zum Beispiel Forschungsbeiträge in einer bestimmten Sprache oder Disziplin oder neuartiger Art
- Wie stellen Sie sicher, dass der Assistent eine gute Benutzererfahrung bietet?
- Welchen Benutzersupport bieten Sie an?
- Gibt es – oder wird es eine geben? ORCID Welche Ansprechpartner in Ihrer Organisation, beispielsweise ein Produktmanager, für den Assistenten?
- Wie stellen Sie das sicher? ORCID IDs werden authentifiziert?
- Nehmen Sie – oder werden Sie – etwas auf und zeigen Sie es an? ORCID iDs auf Ihrer Plattform?
- Ist Ihre Plattformsuche durch iDs aktiviert?
Bitte beachten Sie unsere Such- und Link-Workflow für weitere Informationen an.
Anfrage der Mitgliedsorganisationen ORCID Mitglieds-API-Anmeldeinformationen auf dem Produktionsserver (Liveserver), indem Sie Folgendes ausfüllen Antragsformular für den Production Member API-Client. Vor der Ausgabe der API-Anmeldeinformationen für Produktionsmitglieder muss die ORCID Das Engagement-Team/der Konsortialleiter wird eine Demo Ihrer Integration im ORCID Sandbox. Dies gibt uns die Möglichkeit, die großartigen Integrationen zu sehen, die Sie erstellt haben, und Workflow-Verbesserungen anzubieten. Außerdem können wir prüfen, ob alle Integrationen unseren Best Practices und Mindestanforderungen für den Start entsprechen.
Um eine Demo Ihres Systems bereitzustellen, müssen Sie eine funktionierende Integration mit dem einrichten ORCID Sandbox, die die ORCID Das Team kann eine Vorschau anzeigen. Es gibt mehrere Möglichkeiten, Ihre funktionierende Sandbox-Integration zu teilen:
- Empfohlen: Live-Demo: Kontaktieren Sie uns, um eine Live-Demonstration zu vereinbaren. Wir stellen Ihnen eine Meeting-Software zur Verfügung, mit der Sie Ihren Bildschirm freigeben können, um Ihre Integration vorzuführen.
- Testseite: Wenn Ihre Entwicklungsseite öffentlich ist, Schicken Sie uns die URL zusammen mit Testanmeldeinformationen (falls erforderlich) für den Zugriff auf Ihr System und Anweisungen zur Verwendung Ihres Systems ORCID Merkmale. Stellen Sie zusätzliche Dokumentation bereit, um zu überprüfen, was wir vom Benutzer aus nicht sehen können, z. B. die verwendete API-Version, welche Daten von Ihrem System gespeichert werden usw.
- Screencast oder Screenshots:Senden Sie eine Aufnahme oder eine Reihe von Screenshots mit Beschreibungen, die klar erklären und demonstrieren, wie Ihre Integration in jedem Schritt funktioniert, einschließlich dessen, was passiert, wenn ein Benutzer den Zugriff verweigert oder seine iD trennt. Stellen Sie sicher, dass Sie zusätzliche Unterlagen bereitstellen, um alles zu verifizieren, was wir vom Benutzer aus nicht sehen können, z. B. die verwendete API-Version und wie Daten gespeichert werden
Webhooks ermöglichen Premium-Mitgliedern das „Zuschauen“ ORCID Aufzeichnungen und werden über alle Änderungen benachrichtigt.
Mithilfe der API und der Anmeldeinformationen des Premium-Mitglieds können Premium-Mitglieder für jede authentifizierte Person eine Rückruf-URL registrieren ORCID iD die sie verfolgen möchten. Der ORCID Der Datensatzinhaber muss der Organisation keine spezielle Erlaubnis zur Registrierung der URL erteilen, der tatsächliche Datenaustausch basiert jedoch auf den von der Organisation festgelegten Datenschutzniveaus ORCID iD Halter.
Damit ist alles vorhanden ORCID benachrichtigt die angegebene URL durch Senden einer Anfrage, wenn Änderungen an der vorgenommen werden ORCID Rekord.
Metadaten
Alle Zugehörigkeitsabschnitte verwenden denselben Metadatensatz in der API:
- Name der Organisation:* Der Name der Organisation auf höchster Ebene (z. B. „Boston University“ statt „Boston University School of Medicine“).
- Organisationsort:* Stadt, in der die Organisation ihren Sitz hat.
- Organisationsregion: Region, in der die Organisation ihren Sitz hat.
- Organisationsland* das Land der Organisation. Dies sollte mit dem ausgefüllt werden zweibuchstabiger ISO 3166 Alpha-2-Ländercode.
- Organisation ID (ROR, GRID, Ringgold** oder LEI):* Eine eindeutige Kennung für die Organisation und ihre Quelle. Wir empfehlen die Mutterorganisation ID wird innerhalb der Zugehörigkeit und nicht innerhalb der Abteilung oder Abteilung verwendet.
- Rolltitel: Die ausgeübte Position oder der verliehene oder zu verleihende Abschluss.
- Abteilung: Jede Unterteilung der Mutterorganisation.
- URL: Eine URL zu einer Ressource über die Zugehörigkeit
- Anfangsdatum: Das Datum, an dem die Beziehung zwischen dem Forscher und der Organisation begann (kann bis auf Jahr, Monat und Tag genau angegeben werden).
- Endtermin: Das Datum, an dem die Beziehung zwischen dem Forscher und der Organisation endete (kann bis auf Jahr, Monat und Tag genau angegeben werden)
- Eine externe dauerhafte Kennung, die die Zugehörigkeit beschreibt: Ein eindeutiger Bezeichner für die tatsächliche Zugehörigkeitsbehauptung
*Markiert eine notwendiges Feld.
**Obwohl Ringgold-Identifikatoren immer noch innerhalb der existieren ORCID Register, ab 1. August 2023, ORCID erhält keine Aktualisierungen der von unserem Register verwendeten RINGGOLD-Organisationsidentifikationsdatenbank mehr und wir können auch nach diesem Datum erstellte RINGGOLD-IDs nicht mehr verarbeiten oder nutzen. Sehen Sie sich unsere an FAQ for more info
Es gibt eine Reihe von Abschnitten unter dem Biografieteil einer ORCID Aufzeichnung:
Auch bekannt als: Dies kann einen abgekürzten Vornamen, Varianten einschließlich Initialen für einen oder mehrere Vornamen, Zweitnamen, frühere oder alternative Namen oder Namen in einem anderen Zeichensatz umfassen. Jeder Name sollte als einzelnes Element hinzugefügt werden. Dies ist ein Freitextfeld mit bis zu 255 Zeichen.
Webseiten: Dieser Abschnitt enthält eine Beschreibung (optional) und eine Website-URL (erforderlich).
Kanton: Der Abschnitt „Land“ eines ORCID Mit Record können Forscher und Mitgliedsorganisationen ein oder mehrere Länder hinzufügen, in denen sie forschen oder die Gegenstand ihrer Forschung sind. Die Elemente in der Länderliste stammen aus ISO 3166, dem internationalen Standard für Länder- und Regionscodes.
Externe Identifikatoren (andere IDs): Dieser Abschnitt kann nur von Mitgliedsorganisationen hinzugefügt werden. Bitte beachten Sie, dass viele Organisationen zwar andere externe Identifikatoren für ihre Forscher sammeln, z. B. Scopus-Autoren-IDs, diese jedoch nur vom Aussteller dieser Identifikatoren verbindlich geltend gemacht werden können. Wir empfehlen daher dringend, dass Ihre Organisation nur Identifikatoren hinzufügt, die Ihr(e) System(e) erstellt und zur Identifizierung von Forschern verwendet hat(en). Dieser Abschnitt enthält vier Komponenten (* kennzeichnet ein Pflichtfeld):
- ID-Typ*
- ID-Wert*
- ID-Beziehung*
- ID-URL
- Titel:* Der Titel der Arbeit
- Untertitel: Ein Untertitel zum Werk
- Übersetzter Titel: Der Titel, unter dem das Werk in einer anderen Sprache erscheint, die Sprache des übersetzten Titels wird als Attribut erfasst
- Zeitschriftentitel: Der Name einer größeren Sammlung, zu der das Werk gehört, beispielsweise „Journal“ für Zeitschriftenartikel oder „Book“ für Buchkapitel. Obwohl es sich um einen Zeitschriftentitel handelt, kann er für andere Werke verwendet werden
- Kurze Beschreibung: Eine kurze Beschreibung oder Zusammenfassung der Arbeit
- Zitattyp: Das Format, in dem das Zitat bereitgestellt wird. Dieses Feld wird aus einer Liste mit den folgenden Werten ausgewählt: APA, BIBTEX, CHICAGO, HARVARD, IEEE, MLA, RIS, UNSPECIFIED, VANCOUVER
- Zitatwert: Der Inhalt des Zitats
- Arbeitstyp: Die Art des Objekts, um das es sich bei der Arbeit handelt. Dieses Feld muss aus dem ausgewählt werden unterstützte Arbeitstypen
- Datum der Veröffentlichung: Das Datum, an dem das Werk veröffentlicht wurde. Wir empfehlen die Verwendung des frühesten Veröffentlichungsdatums
- Externer ID-Typ:* Der Typ der Kennung. Dieses Feld muss aus dem ausgewählt werden Unterstützte Werkkennungen
- Externer ID-Wert:* Der Bezeichner selbst
- Externe-ID-URL: Eine URL, in die der Bezeichner aufgelöst wird
- Externe-ID-Beziehung:* Kennungen, die nur für das hinzugefügte Werk gelten, werden als „Selbst“ gekennzeichnet. Bezeichner, die sich auf eine größere Sammlung beziehen, zu der dieses Werk gehört, werden auf „Teil davon“ gesetzt. Bezeichner, die für alternative Versionen des Werks gelten, werden auf „version-of“ gesetzt. Kennungen, die sich auf die Finanzierung der Arbeit beziehen, werden auf „gefördert durch“ gesetzt.
- Arbeits-URL: Eine URL, die auf die Arbeit verweist
- Mitwirkende: Informationen zu den Personen, die das Werk geschaffen haben
- Sprachcode: Die Sprache, die zur Beschreibung der Arbeit in den vorherigen Bereichen verwendet wird
- Kanton: Ein Land, in dem das Werk veröffentlicht wurde oder mit dem es anderweitig in Verbindung steht
* Zeigt ein Pflichtfeld an
Es gibt viele Arten von Forschungsressourcen, von Einwegreagenzien bis hin zu internationalen Kooperationen mit speziellen Einrichtungen. ORCID unterstützt ein High-Level-Modell, das für domänenspezifische Details auf andere Orte verweisen kann.
Es gibt vier übergeordnete Ressourcentypen:
Ressourcentyp | Definition | Beispiele |
Infrastruktur | Eine Einrichtung, ein Gebäude oder ein anderer physischer Raum, der zur Durchführung von Forschungsarbeiten genutzt wird | Neutronenspallationsquelle, Tieranlage, Datenenklave, archäologische Stätte, Teleskopanordnung. Schiffe, Flugzeuge, Bauernhöfe, Labore |
Sammlung | Ein Objekt oder eine Gruppe von Objekten, die zu Forschungszwecken verwendet werden; kann greifbar oder digital sein | Meeresmission, Feldkampagne, kollaborative Datensätze oder Ressourcen, Sammlung seltener Bücher; Museumssammlung, biologische Probensammlung |
Ausrüstung | Hardware für Forschungszwecke | Mikroskop, Computer, Glaswaren, Proben, Materialien |
Service | Für Forschungszwecke genutzte Dienste | Proteomik-Analyse, Computerdienstleistungen, Datenanalyse, logistische Unterstützung, juristische Dienstleistungen, Lektorat, Experten- oder Personalberatung |
Zusätzlich zum Ressourcentyp kann ein Forschungsressourcenelement innerhalb eines ORCID Der Datensatz enthält die folgenden Informationen. * kennzeichnet erforderliche Artikel
- Vorschlag/Registrierungstitel:* Dies ist das Hauptanzeigefeld für Forschungsressourcen, z. B. „Neutron Beam Award“ oder „Beam Time and Computing Resources“.
- Vorschlags-/Registrierungs-ID:* Dies ist die öffentliche Kennung (DOI, PURL usw.) für den Vorschlag oder die Anfrage zur Nutzung der Ressource. Idealerweise sollte diese Kennung dauerhaft sein und zu einer öffentlichen Zielseite mit Informationen über den Vorschlag oder die Anfrage führen, beispielsweise eine Auszeichnungsdatenbank oder ein Ressourcenbenutzerprotokoll.
- Gastgeber des Vorschlags:* Dies ist die Organisation, die Ressourcenvorschläge oder -anfragen entgegennimmt und bearbeitet. Der Vorschlagshost kann mit dem Ressourcenhost identisch sein
- ID der Aufnahmeorganisation des Vorschlags* Dies ist die öffentliche Kennung (eine von ROR, GRID, Open Funder ID, LEI) für die Organisation, die den Vorschlags- oder Anfrageprozess verwaltet
- Ressourcen):* (bis 100)
- Ressourcenname:* – zB „Neutronenspallationsquelle“
- Ressourcen-ID(s):* – aus einer erweiterbaren Liste akzeptabler PID-Typen (z. B. RRID, DOI, URI)
- Ressourcentyp:* – eine von „Infrastrukturen“, „Sammlungen“, „Ausrüstung“ oder „Dienste“
- Ressourcenhost(s):* Dabei handelt es sich um die Organisation, die die Ressource verwaltet oder betreibt, beispielsweise ein nationales Labor, eine Regierungsbehörde oder eine Forschungsuniversität
- ID der Ressourcenhostorganisation:* Dies ist die öffentliche Kennung (eine von ROR, GRID, Ringgold**, Open Funder ID, LEI) für die Organisation, die die Ressource hostet
- Angebots-URL: Ein Link zum Vorschlag
- Startdatum des Angebots: Das Datum, an dem der Zugriff begann
- Enddatum des Angebots: Das Datum, an dem der Zugriff endete oder enden wird
* Zeigt ein Pflichtfeld an
**Obwohl Ringgold-Identifikatoren immer noch innerhalb der existieren ORCID Register, ab 1. August 2023, ORCID erhält keine Aktualisierungen der von unserem Register verwendeten RINGGOLD-Organisationsidentifikationsdatenbank mehr und wir können auch nach diesem Datum erstellte RINGGOLD-IDs nicht mehr verarbeiten oder nutzen. Sehen Sie sich unsere an FAQ for more info
- Rolle:* Die Rolle der Person im Begutachtungsprozess, aus der ausgewählt werden kann: Vorsitzender, Herausgeber, Mitglied, Organisator, Gutachter
- Gruppenkennung:* Die Gruppe ID die für Aggregationszwecke verwendet wird – für Zeitschriftenartikel ist die Standardkennung die eISSN, die automatisch über eine Integration mit der ISSN-Datenbank ausgefüllt wird. Bitte beachten Sie, dass Sie dies tun müssen, wenn Sie eine andere Kennung als eine ISSN zuweisen müssen Erstellen Sie es vorher.
- Einberufende Organisation*: Die Organisation, die die Begutachtung organisiert hat – ein Zeitschriftenverlag, ein Konferenzorganisator, eine Finanzierungsagentur, eine Fakultät usw
- Organisationskennung: Die dauerhafte Kennung für die einberufende Organisation. Wir unterstützen derzeit ROR, Ringgold**, GRID, LEI oder Crossref Funder Registry Identifier. Bitte beachten Sie: Dies ist kein Pflichtfeld, wir empfehlen Ihnen jedoch, diese Daten zu veröffentlichen, sofern Sie darüber verfügen.
- Bewertungsdaten:* Diese Daten beziehen sich auf die Bewertungsaktivität und nicht darauf, was überprüft wurde
- Typ: Die Art der Überprüfungsaktivität: Überprüfung oder Bewertung
- Datum: Das Datum, an dem die Überprüfung abgeschlossen wurde. Dies kann allgemein (2008) oder spezifisch (2010) sein.
- Bewertungskennung: Ein einzigartiges, vorzugsweise lösbares Kennzeichnung bereitgestellt von der Quelle der Bewertung selbst. Sofern die Rezension nicht öffentlich zugänglich ist, empfehlen wir, dass diese keine identifizierbaren Daten enthält, die auf den Gegenstand der Rezension zurückgeführt werden können
- Rezensions-URL: Ein Link zu einer Online-Darstellung der Rezension oder des Rezensionsdatensatzes
- Informationen zum Bewertungsthema: Was auch immer der Rezensent bewertet hat
- Betrefftyp: Die Art des besprochenen Artikels, z. B. Zeitschriftenartikel, Konferenzbeitrag
- Dies beinhaltet die Liste der Arbeitsarten UND die Liste der Förderarten („Zuschuss“, „Vertrag“, „Preis“, „Gehaltspreis“) UND Forschung-„Ressourcenvorschlag“ UND „undefiniert“
- Subjekt Name: Der Name des überprüften Artikels
- Externe Betreff-ID: Die eindeutige Kennung des Betreffs der Rezension, z. B. ein Artikel-DOI
- Name des Betreffcontainers: Der Name des Objekts, zu dem der Begutachtungsgegenstand gehört, z. B. die Konferenz, für die der Beitrag begutachtet wurde
- Betreff-URL: Die URL des Betreffs, der überprüft wurde
- Betrefftyp: Die Art des besprochenen Artikels, z. B. Zeitschriftenartikel, Konferenzbeitrag
* Zeigt ein Pflichtfeld an
**Obwohl Ringgold-Identifikatoren immer noch innerhalb der existieren ORCID Register, ab 1. August 2023, ORCID erhält keine Aktualisierungen der von unserem Register verwendeten RINGGOLD-Organisationsidentifikationsdatenbank mehr und wir können auch nach diesem Datum erstellte RINGGOLD-IDs nicht mehr verarbeiten oder nutzen. Sehen Sie sich unsere an FAQ for more info
- Förderart:* Die Art der gewährten Finanzierung. Dieses Feld wird aus einer Liste ausgewählt, die die folgenden Werte enthält: Auszeichnung, Vertrag, Zuschuss, Gehaltszuschuss
- Fördertitel:* Der Titel des Finanzierungselements
- Untertitel: Ein Untertitel zum Finanzierungselement
- Übersetzter Titel: Der Titel, unter dem die Förderung in einer anderen Sprache erscheint, wird als Attribut in der Sprache des übersetzten Titels erfasst
- Beschreibung: Eine Beschreibung oder kurze Zusammenfassung des geförderten Projekts.
- Menge: Der Wert der Auszeichnung
- Eindeutige Finanzierungskennung: Fügen Sie so viele davon hinzu, wie Ihr System erkennt, da dies die Gruppierung erleichtert ORCID Records.
- Typ der Finanzierungskennung: Bewilligungsnummer, DOI, URI oder Vorschlags-ID verwenden
- Wert des Bezeichners
- Identifikations-URL (optional)
- Beziehung: Selbst/Teil-von
Damit soll die Beziehung des Finanzierungselements zum Identifikator angegeben werden. Wenn sich das Finanzierungselement beispielsweise auf eine Phase eines mehrteiligen Zuschusses bezieht und die Kennung für den mehrteiligen Zuschuss gilt, lautet die Beziehung „Teil von“; Wenn die Kennung für die einzelne Phase gilt, wäre die Beziehung „selbst“.
- Fördergeber (Organisation):* Informationen über die Organisation, die die Förderung vergeben hat
- Name der Agentur
- Adresse (Stadt und Land)
- Organisationskennung:
- Anfangsdatum: Das Datum, an dem die Finanzierung begann
- Endtermin: Das Datum, an dem die Finanzierung endete
- Informationen für Mitwirkende: Angaben zu den Personen, die die Förderung erhalten haben
- ORCID Ausweis: Die ORCID iD jedes Mitarbeiters des Förderprojekts; Dies sollte nur authentifiziert umfassen ORCID IDs
- Rolle: Die Art des Beitrags des Forschers
* Zeigt ein Pflichtfeld an
Alle Zugehörigkeitsabschnitte verwenden denselben Metadatensatz in der API:
- Name der Organisation:* Der Name der Organisation auf höchster Ebene (z. B. „Boston University“ statt „Boston University School of Medicine“).
- Organisationsort:* Stadt, in der die Organisation ihren Sitz hat.
- Organisationsregion: Region, in der die Organisation ihren Sitz hat.
- Organisationsland* das Land der Organisation. Dies sollte mit dem ausgefüllt werden zweibuchstabiger ISO 3166 Alpha-2-Ländercode.
- Organisation ID (ROR, GRID, Ringgold** oder LEI):* Eine eindeutige Kennung für die Organisation und ihre Quelle. Wir empfehlen die Mutterorganisation ID wird innerhalb der Zugehörigkeit und nicht innerhalb der Abteilung oder Abteilung verwendet.
- Rolltitel: Die ausgeübte Position oder der verliehene oder zu verleihende Abschluss.
- Abteilung: Jede Unterteilung der Mutterorganisation.
- URL: Eine URL zu einer Ressource über die Zugehörigkeit
- Anfangsdatum: Das Datum, an dem die Beziehung zwischen dem Forscher und der Organisation begann (kann bis auf Jahr, Monat und Tag genau angegeben werden).
- Endtermin: Das Datum, an dem die Beziehung zwischen dem Forscher und der Organisation endete (kann bis auf Jahr, Monat und Tag genau angegeben werden)
- Eine externe dauerhafte Kennung, die die Zugehörigkeit beschreibt: Ein eindeutiger Bezeichner für die tatsächliche Zugehörigkeitsbehauptung
*Markiert eine notwendiges Feld.
**Obwohl Ringgold-Identifikatoren immer noch innerhalb der existieren ORCID Register, ab 1. August 2023, ORCID erhält keine Aktualisierungen der von unserem Register verwendeten RINGGOLD-Organisationsidentifikationsdatenbank mehr und wir können auch nach diesem Datum erstellte RINGGOLD-IDs nicht mehr verarbeiten oder nutzen. Sehen Sie sich unsere an FAQ for more info
Alle Zugehörigkeitsabschnitte verwenden denselben Metadatensatz in der API:
- Name der Organisation:* Der Name der Organisation auf höchster Ebene (z. B. „Boston University“ statt „Boston University School of Medicine“).
- Organisationsort:* Stadt, in der die Organisation ihren Sitz hat.
- Organisationsregion: Region, in der die Organisation ihren Sitz hat.
- Organisationsland* das Land der Organisation. Dies sollte mit dem ausgefüllt werden zweibuchstabiger ISO 3166 Alpha-2-Ländercode.
- Organisation ID (ROR, GRID, Ringgold** oder LEI):* Eine eindeutige Kennung für die Organisation und ihre Quelle. Wir empfehlen die Mutterorganisation ID wird innerhalb der Zugehörigkeit und nicht innerhalb der Abteilung oder Abteilung verwendet.
- Rolltitel: Die ausgeübte Position oder der verliehene oder zu verleihende Abschluss.
- Abteilung: Jede Unterteilung der Mutterorganisation.
- URL: Eine URL zu einer Ressource über die Zugehörigkeit
- Anfangsdatum: Das Datum, an dem die Beziehung zwischen dem Forscher und der Organisation begann (kann bis auf Jahr, Monat und Tag genau angegeben werden).
- Endtermin: Das Datum, an dem die Beziehung zwischen dem Forscher und der Organisation endete (kann bis auf Jahr, Monat und Tag genau angegeben werden)
- Eine externe dauerhafte Kennung, die die Zugehörigkeit beschreibt: Ein eindeutiger Bezeichner für die tatsächliche Zugehörigkeitsbehauptung
*Markiert eine notwendiges Feld.
**Obwohl Ringgold-Identifikatoren immer noch innerhalb der existieren ORCID Register, ab 1. August 2023, ORCID erhält keine Aktualisierungen der von unserem Register verwendeten RINGGOLD-Organisationsidentifikationsdatenbank mehr und wir können auch nach diesem Datum erstellte RINGGOLD-IDs nicht mehr verarbeiten oder nutzen. Sehen Sie sich unsere an FAQ for more info
Alle Zugehörigkeitsabschnitte verwenden denselben Metadatensatz in der API:
- Name der Organisation:* Der Name der Organisation auf höchster Ebene (z. B. „Boston University“ statt „Boston University School of Medicine“).
- Organisationsort:* Stadt, in der die Organisation ihren Sitz hat.
- Organisationsregion: Region, in der die Organisation ihren Sitz hat.
- Organisationsland* das Land der Organisation. Dies sollte mit dem ausgefüllt werden zweibuchstabiger ISO 3166 Alpha-2-Ländercode.
- Organisation ID (ROR, Ringgold**, GRID oder LEI):* Eine eindeutige Kennung für die Organisation und ihre Quelle. Wir empfehlen die Mutterorganisation ID wird innerhalb der Zugehörigkeit und nicht innerhalb der Abteilung oder Abteilung verwendet.
- Rolltitel: Die ausgeübte Position oder der verliehene oder zu verleihende Abschluss.
- Abteilung: Jede Unterteilung der Mutterorganisation.
- URL: Eine URL zu einer Ressource über die Zugehörigkeit
- Anfangsdatum: Das Datum, an dem die Beziehung zwischen dem Forscher und der Organisation begann (kann bis auf Jahr, Monat und Tag genau angegeben werden).
- Endtermin: Das Datum, an dem die Beziehung zwischen dem Forscher und der Organisation endete (kann bis auf Jahr, Monat und Tag genau angegeben werden)
- Eine externe dauerhafte Kennung, die die Zugehörigkeit beschreibt: Ein eindeutiger Bezeichner für die tatsächliche Zugehörigkeitsbehauptung
*Markiert eine notwendiges Feld.
**Obwohl Ringgold-Identifikatoren immer noch innerhalb der existieren ORCID Register, ab 1. August 2023, ORCID erhält keine Aktualisierungen der von unserem Register verwendeten RINGGOLD-Organisationsidentifikationsdatenbank mehr und wir können auch nach diesem Datum erstellte RINGGOLD-IDs nicht mehr verarbeiten oder nutzen. Sehen Sie sich unsere an FAQ for more info
An ORCID Der Datensatz kann Informationen über die Arbeit, Zugehörigkeiten, Finanzierung, Peer-Review und mehr eines Forschers enthalten.
Artikel an ORCID Datensätze können unterteilt werden in Behauptungen die verbinden die ORCID iD-Inhaber mit einer Tätigkeit oder Zugehörigkeit. Diese Behauptungen können zu einer hinzugefügt werden ORCID Aufzeichnung durch den Forscher, der Eigentümer der Aufzeichnung ist, oder durch Systeme, denen der Forscher die Erlaubnis dazu erteilt hat. Wir nennen die Entität, die eine Behauptung zu einem hinzugefügt hat ORCID Nehmen Sie die auf Quelle.
Beispiele
Gemäß unseren Grundsätzen der Transparenz und Offenheit halten wir es für wichtig, die Quelle der Behauptung sehen zu können – wer diese Informationen in die Akte einfügt. So machen wir das:
- Wenn ein Forscher (oder sein Beauftragter vertrauenswürdige Person) fügt ihrem Datensatz eine Behauptung hinzu, ORCID zeichnet diese Person automatisch als Quelle auf
- Wenn ein vom Forscher genehmigtes System eine Behauptung zu einem Datensatz hinzufügt, ORCID erfasst automatisch den Anlageneigentümer (an ORCID Mitglied) als Quelle.
Wir zeigen den Quellnamen in der Benutzeroberfläche an und stellen ihn (mit seiner eindeutigen Kennung) in der API zur Verfügung:
Arbeitsabläufe bei der Recherche von Informationen können jedoch komplizierter sein, und die wahre Quelle einer Behauptung kann unbeabsichtigt verschleiert werden, indem ein System ein Element im Namen einer Person oder ein anderes System hinzufügt. Um Transparenz zu gewährleisten, müssen wir unterscheiden, wer die Verbindung zwischen der Person und dem Element hergestellt hat und wer das Element zum Datensatz hinzugefügt hat. Wie oben: Wer auch immer das Element hinzufügt ORCID Rekord ist der Quelle; wer auch immer die Verbindung zwischen den herstellt ORCID iD und der Artikel ist der Ursprung der Behauptung.
Beispielsweise:
- Ein Forscher importiert Daten in sein ORCID Datensatz aus einem System, z. B. einem Such- und Verknüpfungsassistenten. Der Forscher stellt die Behauptung auf, sie zu verbinden iD mit dem Artikel, also sind sie das Ursprung der Behauptung; während das System die Entität ist, die die Behauptung zum hinzufügt ORCID Rekord – der Quelle
- Ein Forscher interagiert mit System A (dem Behauptung origin), das zur Aktualisierung die von System B bereitgestellten Dienste nutzt ORCID Aufzeichnungen, was System B zum macht Quelle
Wir ermutigen unsere Community, Schritte zu unternehmen, um Informationen über den Ursprung der Behauptung zu bewahren und weiterzugeben, damit jeder von der Einsicht in die Quelle profitieren kann.
Weitere Informationen finden Sie unter:
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.
ORCID ermöglicht das Hinzufügen mehrerer Arten von Werken. Nachfolgend finden Sie eine Liste der derzeit unterstützten Arbeitstypen, die weitgehend mit dem CASRAI-Ausgabestandard übereinstimmt.
Publikationen
Arbeitstyp | Verwenden Sie die |
buchen | Bücher, die von einem einzelnen Autor oder in Zusammenarbeit geschrieben wurden und auf Forschungsergebnissen oder wissenschaftlichen Erkenntnissen basieren, die im Allgemeinen aus von Experten begutachteten Mitteln stammen. |
Buchkapitel | Texte, die von einem einzelnen Autor oder gemeinsam verfasst wurden und auf Forschung oder wissenschaftlichen Erkenntnissen und Fachwissen in einem Fachgebiet basieren. |
Buchrezension | Kritische Rezension von Werken der Belletristik oder Sachliteratur, wobei die Beiträge zu einer Kunst, einem Fachgebiet oder einer Disziplin hervorgehoben werden. |
Eintrag im Wörterbuch | Einträge neuer Wörter, neue Bedeutungen bestehender Wörter, Änderungen der Rechtschreibung und Silbentrennung über einen längeren Zeitraum sowie grammatikalische Änderungen. |
Dissertation | Abhandlung, die einen originellen, aus der Forschung hervorgegangenen Standpunkt vertritt: Voraussetzung für einen Doktorgrad. Dies ist nur mit API v2.x verfügbar |
Dissertation | Eine Arbeit, die in der Regel auf Originalforschung basiert und die Beherrschung des eigenen Fachs und der wissenschaftlichen Methode durch den Kandidaten nachweist. Dies ist nur mit API v3.0+ verfügbar |
Enzyklopädie-Eintrag | Verfasste Einträge in einem Nachschlagewerk oder einem Kompendium mit Schwerpunkt auf einem bestimmten Fachgebiet oder auf allen Wissensgebieten. |
bearbeitetes Buch | Bücher, die von einem einzelnen Autor oder gemeinsam zur Verbreitung von Forschungsergebnissen oder wissenschaftlichen Erkenntnissen herausgegeben wurden, die im Allgemeinen aus von Experten begutachteten Mitteln stammen. |
Zeitschriftenartikel | Artikel in peer-reviewten Veröffentlichungen, die die Ergebnisse origineller Forschung und Wissenschaft verbreiten. |
Zeitschriftenausgabe | Regelmäßige Veröffentlichungen zur Förderung der intellektuellen Debatte und Forschung. |
Magazin Artikel | Artikel in thematischen Publikationen, die in festgelegten Abständen veröffentlicht werden. |
manuell | Für Lehrzwecke erstellte Kurs- und Aufgabenmaterialien. |
Online-Ressource | Informationen, die nur über herkömmliche technische Methoden im Internet zugänglich sind |
Newsletter-Artikel | Artikel in Publikationen, die sich an Forscher, Entscheidungsträger, Fachleute und die Öffentlichkeit richten und über ein Forschungsprojekt oder über die Aktivitäten eines Forschungslehrstuhls oder eines Forschungszentrums berichten. |
Zeitungsartikel | Artikel in einer täglichen, wöchentlichen oder monatlichen Publikation, die über Nachrichten und gesellschaftliche Themen berichten und sich an die Öffentlichkeit richten. |
Preprint | Version eines Papiers, die vor der formellen Begutachtung und Veröffentlichung öffentlich zugänglich gemacht wird. Dies ist nur mit API v3.0+ verfügbar |
berichten | Berichte zur Verbreitung der Ergebnisse und Leistungen eines Forschungsauftrags. |
Überprüfen | Eine formelle Bewertung der Arbeit eines anderen. Dies ist nur mit API v3.0+ verfügbar |
Forschungs Werkzeug | Eine Reihe von Beobachtungen, Messungen oder Fakten, die sich aus der Forschung ergeben. |
betreute-studentische-publikation | Artikel über Forschungsergebnisse, die gemeinsam mit dem Betreuer der Abschlussarbeit veröffentlicht oder von ihm betreut werden. |
Test | Beurteilungen, die Tests umfassen, die für die allgemeine Universitätsauswahl, die Auswahl in bestimmte Kurse oder andere Bewertungszwecke konzipiert sind. |
Übersetzung | Übersetzungen von Büchern und Artikeln, die Änderungen an der Originalausgabe erkennen lassen, beispielsweise ein neues oder überarbeitetes Vorwort. |
Website | Eigenständige Orte im Web, an denen mehrere Arten von Informationen zu einem bestimmten Thema verfügbar sind. |
Arbeitspapier | Vorläufige Versionen von Artikeln, die keiner Überprüfung unterzogen wurden, aber zur Kommentierung geteilt werden können. |
Konferenz
Arbeitstyp | Verwenden Sie die |
Konferenz-Zusammenfassung | Texte einer bestimmten Länge, die das Thema angeben, das in einem vorgeschlagenen Konferenzpapier diskutiert werden soll. |
Konferenzpapier | Allein oder gemeinsam verfasste Aufsätze, die auf einer wissenschaftlichen Konferenz vorgestellt und im Tagungsband (nicht in Fachzeitschriften) veröffentlicht werden. |
Konferenzplakat | Poster, die im Rahmen einer Konferenz präsentiert werden und Forschungsschwerpunkte auf effiziente Weise durch überzeugende Grafiken vermitteln. |
Geistiges Eigentum
Arbeitstyp | Verwenden Sie die |
Bekanntgabe | Veröffentlichungen, die Erfindungen als Stand der Technik etablieren und dadurch andere daran hindern, dieselbe Erfindung oder dasselbe Konzept zu patentieren. |
Lizenz | Unterzeichnete Vereinbarungen zur Nutzung eines Teils des geistigen Eigentums wie eines Prozesses, Produkts, Daten oder einer Software. |
Patent | Eine Form des IP-Schutzes, die das ausschließliche gesetzliche Recht für Erfinder und Rechtsnachfolger festlegt, ihre Erfindungen, Produkte oder Verfahren für einen begrenzten Zeitraum zu nutzen und zu verwerten. |
eingetragenes Urheberrecht | Eingetragener Inhaber von Rechten im Rahmen eines Rechtssystems zur Förderung der Schaffung und des Zugangs zu künstlerischen, literarischen, musikalischen, dramatischen und anderen kreativen Werken. |
Warenzeichen | Marken wie ein Name, ein Wort, eine Phrase, ein Logo, ein Symbol, ein Design oder ein Bild eines Produkts oder einer Dienstleistung, die die Quelle angeben und das Recht einräumen, die Verwendung der Kennung zu kontrollieren. |
Andere
Arbeitstyp | Verwenden Sie die |
Anmerkung | Anmerkungen enthalten Kommentare oder Beschreibungen zu einer anderen Ressource. Dies ist nur mit API v3.0+ verfügbar |
künstlerische Darbietung | Sammlung von Informationsaufzeichnungen, die in Kombination eine vollständige und aktuelle Geschichte künstlerischer oder darstellerischer Leistungen darstellen, die aus der Forschung oder wissenschaftlichen Tätigkeit der Person resultieren oder damit in Zusammenhang stehen. |
Datenverwaltungsplan | Eine formelle Erklärung, die beschreibt, wie Forschungsdaten während eines Forschungsprojekts verwaltet und dokumentiert werden und welche Bedingungen für die anschließende Hinterlegung der Daten in einem Datenspeicher zur langfristigen Verwaltung und Aufbewahrung gelten. Dies ist nur mit API v3.0+ verfügbar |
Datensatz | Eine Reihe strukturierter Beobachtungen, Messungen oder aus der Forschung ermittelter Fakten, die in einem Datenbankmedium gespeichert werden können. |
Erfindung | Praktische und originelle Ergebnisse aus der Forschung. |
Vortrag-Rede | Ein informativer Vortrag zum Thema Forschung vor einem Publikum. |
physikalisches Objekt | Eine Probe, Probe oder ein anderes physisches Objekt, das zu Forschungszwecken verwendet wird; ein unbelebtes dreidimensionales Objekt oder eine unbelebte Substanz. Dies ist nur mit API v3.0+ verfügbar |
Forschungstechnik | Eine praktische Methode oder Fertigkeit, die auf bestimmte Aufgaben angewendet wird, die im Rahmen der Forschung identifiziert wurden. |
Software. | Ein Programm zum Betrieb eines Computers oder eines anderen technischen Geräts. |
Spin-off-Unternehmen | Ein von einer Forschungsorganisation gegründetes Unternehmen, um die Ergebnisse und Erkenntnisse des Forschungsprojekts kommerziell zu nutzen. |
Standards und Richtlinien | Die Entwicklung einer Regel oder eines Prinzips, das als Grundlage für die Beurteilung dient. |
technischer Standard | Technische Standards (industriell oder anderweitig), die aus Forschungsprojekten entstanden sind, in denen neue Protokolle, Methoden oder Materialien entwickelt werden können. |
mehr | Jede andere Art von Arbeit. |
Bitte beachten Sie unsere Liste der unterstützten Bezeichner für die V3.0-API. Auf Wunsch fügen wir gelegentlich neue Typen hinzu ORCID Mitglieder, die sie beim Hinzufügen von Elementen zur Registrierung verwenden möchten.
ORCID unterstützt die Verwendung von ROR-Kennungen, GRID-Bezeichner und Crossref-Förderregister Identifikatoren zur eindeutigen Unterscheidung von Organisationen ORCID Records.
Für weitere Informationen, siehe Arbeiten mit Organisationskennungen
Obwohl Ringgold-Identifikatoren immer noch innerhalb der existieren ORCID Register, ab 1. August 2023, ORCID erhält keine Aktualisierungen der von unserem Register verwendeten RINGGOLD-Organisationsidentifikationsdatenbank mehr und wir können auch nach diesem Datum erstellte RINGGOLD-IDs nicht mehr verarbeiten oder nutzen. Sehen Sie sich unsere an FAQ für weitere Infos
Wir haben ein neues, vom System generiertes Feld eingeführt, das externe Kennungen (DOIs, PMCID, PMID, ArXiv, Bibcode, ISSNs und ISBNs) zum Zweck des Abgleichs und der Gruppierung in einem normalisierten Format ausdrückt. Die Normalisierung erfolgt auf der Grundlage der Regeln des Bezeichnertyps und kann das Festlegen aller Alphazeichen in Kleinbuchstaben oder das Umwandeln von Leerzeichen, Bindestrichen, Punkten und anderen Zeichen umfassen, die als gleichwertig behandelt werden können. Außerdem werden gegebenenfalls Standardpräfixe und -suffixe hinzugefügt. Zum Beispiel, https://doi.org/10.1/123, 10.1/123 und https://dx.doi.org/10.1/123 werden alle in diesem Feld als angezeigt https://doi.org/10.1/123. Der vorhandene Bezeichnerwert bleibt unverändert.
- Vorname
- Zusätzliche
Rollen für Works API 2.0
Nachfolgend finden Sie die Liste der unterstützten Mitwirkendenrollen, die API 2.0 verwenden.- Autor
- Rechtsnachfolger
- Herausgeber
- Vorsitzender oder Übersetzer
- Co-Ermittler
- Miterfinder
- Doktorand
- anderer-Erfinder
- Hauptermittler
- Postdoktorand-Forscher
- Support-Mitarbeiter
Rollen für Works API 3.0
Mit API 3.0 können Sie die oben genannten Rollen sowie zusätzliche CRedIT-Rollen hinzufügen. Die CRediT-Taxonomie besteht aus 14 Beitragsarten zur wissenschaftlichen Arbeit, zusammen mit Richtlinien, wie diese Rollen zugewiesen werden können. Nachfolgend finden Sie die vollständige Liste mit dem UI-Wert und dem Metadatenwert. Der Metadatenwert ist die URL gemäß den NISO-Implementierungsempfehlungen.CRediT sollte in JATS XML v1.2 codiert werden, beschrieben über diesen Link: https://jats4r.org/credit-taxonomy.' Beim Hinzufügen von Rollen über die API wird nur die URL akzeptiert.Beispiel für Metadaten von Arbeitsmitarbeitern:
https://orcid.org/0000-0001-5109-3700 0000-0001-5109-3700 orcid.org Laure L. Haak first author
Rollen für die Finanzierung
- führen
- Co-Leiter
- unterstützt durch
- Anderer Beitrag
ORCID bietet ein Freitext-Zitatfeld, damit Forscher Informationen einfach im Textformat eingeben können. Wir empfehlen jedoch allen API-Benutzern dringend, Zitate in BibTeX hinzuzufügen, das maschinenlesbar ist. Das ehrwürdige Format kann, obwohl es vor dem Internet existiert, durch Integrationen und Autoren in das gewünschte Format umgewandelt werden. Es wird von den meisten Referenzmanagern und Veröffentlichungsplattformen unterstützt
Weitere Informationen zu BibTeX finden Sie unter https://www.bibtex.org.
Jeder Autor, dessen Verlag Crossref für die DOI-Registrierung verwendet, kann von der automatischen Update-Integration von Crossref profitieren.
Herausgeber müssen die authentifizierte Datei angeben ORCID IDs für ihre Autoren in den Metadaten, die bei der DOI-Registrierung an Crossref gesendet werden.
Crossref wird dann den Autor per Benachrichtigung an ihn um Erlaubnis bitten ORCID Posteingang, um ihre zu aktualisieren ORCID mit dieser Veröffentlichung und allen neuen Veröffentlichungen eines Verlags aufzeichnen.
Weitere Informationen finden Sie unter: https://www.crossref.org/community/orcid/
Jedes Element in der ORCID iD wird ein Put-Code zugewiesen, der es eindeutig identifiziert. Beim Lesen eines gesamten Datensatzes oder Abschnitts kann der Put-Code als Attribut des Elements gefunden werden. Wenn Aufrufen eines bestimmten Elements in einem Datensatz, wird der Put-Code zur Identifizierung des Artikels verwendet. Put-Codes sind innerhalb des Artikeltyps, auf den sie sich beziehen, eindeutig. Anhand dieses Beispiels funktioniert nur eine Arbeit in der ORCID Das Register hat den Put-Code 733535, obwohl 733535 auch als Put-Code für einen Finanzierungsartikel oder ein Schlüsselwort verwendet werden kann
Als Vorteil von ORCID Mitgliedschaft können Organisationen erfragen ORCID um zusätzliche PID-Typen im zu unterstützen ORCID Registrierung. Beispielsweise könnte ein Mitglied verlangen, dass wir Unterstützung für die PIDs hinzufügen, die es zur Identifizierung von Proben oder Datensätzen in seiner Geologiedatenbank verwendet. Dies ermöglicht Verbindungen zwischen den Proben und den Personen, die sie gesammelt haben. Und da alle neuen PID-Typen, die wir hinzufügen, mindestens auflösbar und vorzugsweise FAIR sein müssen, sind diese Verknüpfungen eindeutig, dauerhaft und umsetzbar – was dem Forscher, der Mitgliedsorganisation und der breiteren Gemeinschaft zugute kommt.
Hinzufügen Ihrer PID!
Als Gemeinschaftsorganisation wollen wir das sicherstellen ORCID unterstützt die von unseren Mitgliedern verwendeten PIDs. Wir pflegen eine vollständige Liste der vorhandenen Bezeichner, die in der Registry unterstützt werden und einladen ORCID Mitglieder zu verwenden kannst du dich über dieses Formular um zusätzliche PIDs anzufordern. Wir sind bestrebt, Ihre Anfrage so schnell wie möglich zu beantworten.
ORCID hat einen separaten Abschnitt in der ORCID Record zum Aufzeichnen von Informationen zu Qualifikationen, Akkreditierungen, Zertifikaten und Abzeichen.
Jedes Qualifikationselement enthält immer:
- Der Qualifikationstitel
- Die Organisation des Anbieters ID (z. B. ROR-ID)
- Das Datum, an dem es hinzugefügt wurde ORCID Rekord
- Wer hat die Qualifikation hinzugefügt (die Quelle)?
Sie können enthalten:
- Das Gültigkeitsdatum, einschließlich eines Enddatums, falls die Qualifikation abläuft
- Die persistente Qualifikations-ID, die die Art der erworbenen Qualifikation identifiziert.
- Die Qualifikations-URL, die eine für Menschen lesbare Beschreibung der Art der erworbenen Qualifikation enthält.
- Die persistente Qualifizierungs-ID. Dies sollte auf eine Online-Version des Qualifikationszertifikats verweisen. Dabei könnte es sich um ein bestehendes Unikat handeln ID oder einfach eine URI.
Authentifizierung und OAuth
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 den Client Ihrer API-Anmeldeinformationen angeben ID und zugehörige Zielseite (Umleitungs-URI). Sie wählen durch die Einstellung aus, nach welchen Berechtigungen Sie fragen möchten 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.
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.
Dreibeinige Zielfernrohre (Autorisierungscode).
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.
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.
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 |
Es können einzelne oder alle Parameter verwendet werden:
Parameter | Feld | Notizen |
Vornamen | Vorname | Die 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 | Die 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. |
Die 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 an der orcid Parameters. | ||
orcid | ORCID iD | Die 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
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
Implizites OAuth ist eine leichtere Version von OAuth, die für die Verwendung durch Systeme entwickelt wurde, die keine serverseitigen Komponenten haben oder nicht verwenden möchten. Implizites OAuth kann allein mit Javascript vollständig im Browser implementiert werden. Es steht Mitgliedern und Nichtmitgliedern zur Verfügung und funktioniert wie folgt:
- Sie erstellen einen speziellen Link
- Beim Anklicken wird der Benutzer weitergeleitet ORCID
- ORCID fordert den Benutzer auf, i zu unterschreiben
- ORCID fordert den Benutzer auf, Ihrer Anwendung die Erlaubnis zu erteilen
- ORCID schickt den Benutzer mit seinem zurück zu Ihrem System ORCID iD, ein Zugriffstoken und ein id Token
- Ihr System extrahiert und speichert die authentifizierten Daten ORCID iD aus der Antwort.
Aus Sicherheitsgründen gilt bei der Verwendung von implizitem OAuth: ORCID gibt keine Zugriffstoken mit Aktualisierungsberechtigungen zurück.
Impliziter Fluss
Der implizite Fluss ist so konzipiert, dass Clients zum Initiieren nicht ihren geheimen Schlüssel verwenden müssen ORCID Anmelden. Die Sicherheit wird durch die Beschränkung der Clients auf ihre registrierten Redirect_URLs gewährleistet. Dieses niedrigere Sicherheitsniveau bedeutet dies ORCID Unterstützt nur die Bereiche /authenticate und openid, wenn der implizite Fluss verwendet wird. Token sind mit einer Lebensdauer von 10 Minuten ebenfalls kurzlebig. Dieser Ablauf wird für clientseitige Anwendungen empfohlen, die keinen Zugriff auf einen Back-End-Server haben, beispielsweise Telefonanwendungen oder einseitige Javascript-Webanwendungen.
https://localhost/#access_token=24c11342-f5da-4cf9-94a4-f8a72a30da00&token_type=bearer&expires_in=599&tokenVersion=1&persistent=false&id_token=eyJraWQiOiJxYS1vcmNpZC1vcmctcjlhZmw3cWY2aG2c5bmdzenU1bnQ3Z3pmMGVhNmkiLCJhbGciOiJSUzI1NiJ9.eyJhdF9oYXNoIjoiMW52bXZBbVdwaVd0Z3ZKZW1DQmVYUSIsImF1ZCI6IkFQUC02TEtJSjNJNUIxQzRZSVFQIiwic3ViIjoiMDAwMC0wMDAyLTUwNjItMjIwOSIsImF1dGhfdGltZSI6MTUwNTk4Nzg2MiwiaXNzIjoiaHR0cHM6XC9cL29yY2lkLm9yZyIsIm5hbWUiOiJNciBDcmVkaXQgTmFtZSIsImV4cCI6MTUwNTk4ODQ2MywiZ2l2ZW5fbmFtZSI6IlRvbSIsImlhdCI6MTUwNTk4Nzg2Mywibm9uY2UiOiJ3aGF0ZXZlciIsImZhbWlseV9uYW1lIjoiRGVtIiwianRpIjoiY2U0YzlmNWUtNTBkNC00ZjhiLTliYzItMmViMTI0ZDVkNmNhIn0.hhhts2-4-ibjXPW6wEsFRaNqV_A-vTz2JFloYn7mS1jzQt3xuHiSaSIiXg3rpnt1RojF_yhcvE9Xe4SOtYimxxVycpjcm8yT_-7lUSrc46UCt9qW6gV7L7KQyKDjNl23wVwIifpRD2JSnx6WbuC0GhAxB5-2ynj6EbeEEcYjAy2tNwG-wcVlnfJLyddYDe8AI_RFhq7HrY4OByA91hiYvHzZ8VzoRW1s4CTCFurA7DoyQfCbeSxdfBuDQbjAzXuZB5-jD1k3WnjqVHrof1LHEPTFV4GQV-pDRmkUwspsPYxsJyKpKWSG_ONk57E_Ba--RqEcE1ZNNDUYHXAtiRnM3w
Sie finden weitere Information unter den jeweiligen Technische Dokumentation um mehr zu erfahren.
Was sind Weiterleitungs-URIs und wie werden sie verwendet?
Umleitungs-URIs werden von unserem OAuth-Authentifizierungsdienst als Sicherheitsmaßnahme verwendet. ORCID sendet authentifizierende Benutzer nur an URIs, die vom Client registriert wurden, der die Authentifizierung anfordert. Dadurch wird verhindert, dass Dienste sich gegenseitig verkörpern.
Bitte beachten Sie, dass nur HTTPS-URIs werden in die Produktion übernommen. Sie können die Verwendung von HTTP-URIs testen, müssen sich jedoch registrieren HTTPS-URIs wenn Sie API-Anmeldeinformationen für Produktionsmitglieder beantragen.
Wie gleichen wir Weiterleitungs-URIs ab?
- Sie MÜSSEN Subdomains als separate URIs registrieren. https://anythingelse.thirdparty.com wird nicht funktionieren.
- Es wird empfohlen, alle Umleitungs-URIs vollständig zu registrieren, einschließlich des Pfads, ist das, was die meisten Drittanbieter tun und die sicherste Option ist.
- Wenn die Client-App mit einem Umleitungs-URI registriert ist, der nur der Hostname ist, kann jeder Umleitungs-URI auf diesem Host verwendet werden. Wenn also beispielsweise die folgende Weiterleitungs-URI registriert ist: https://thirdparty.com dann funktionieren alle folgenden „redirect_uris“:
- https://thirdparty.com/oauth/callback1
- https://thirdparty.com/callback2
- https://thirdparty.com/anything-else-as-long-as-the-host-is-the-same
Allerdings https://anythingelse.thirdparty.com wird nicht funktionieren. Du MUST macht Registrieren Sie Subdomains als separate URIs.
Was passiert, wenn mein Weiterleitungs-URI falsch ist?
Benutzer, die zur Authentifizierung an gesendet wurden ORCID Bei falschen Umleitungs-URIs wird eine Fehlermeldung ähnlich dieser angezeigt:
Verwalten von Umleitungs-URIs für Mitglieder
Wenn Sie die Mitglieder-API verwenden und Änderungen an Ihren Weiterleitungs-URIs benötigen, wenden Sie sich bitte an unser Engagement-Team
Verwalten von Umleitungs-URIs für öffentliche Clients
Wenn Sie die öffentliche API verwenden, müssen Sie die folgenden Schritte ausführen, um Ihre Liste der Umleitungs-URIs zu aktualisieren, die mit Ihrem verknüpft sind ORCID öffentliche API-Client-ID. Sie können dies tun, indem Sie die folgenden Schritte ausführen:
- Melde dich bei dir an ORCID Rekord
- Klicken Sie in der rechten Ecke auf Ihren Namen
- Wählen Sie Entwicklertools aus
- Klicken Sie auf den Bearbeitungsstift neben dem Kundennamen
- Bearbeiten Sie einen vorhandenen Umleitungs-URI oder klicken Sie auf „Weiteren Umleitungs-URI hinzufügen“ und bearbeiten Sie einen vorhandenen
- Sobald Sie Ihre Änderungen vorgenommen haben, müssen Sie auf das Speichern-Symbol klicken
Nur HTTPS-URIs werden in die Produktion übernommen. Sie können die Verwendung von HTTP-URIs testen, müssen jedoch HTTPS-URIs registrieren, wenn Sie API-Anmeldeinformationen für Produktionsmitglieder beantragen.
OpenID Connect 1.0 ist eine einfache Identitätsschicht auf dem OAuth 2.0-Protokoll. Es ergänzt bestehende OAuth-Authentifizierungsabläufe und stellt Clients auf gut beschriebene Weise Informationen über Benutzer bereit.
OpenID Connect ist eine standardisierte Methode zur Implementierung von OAuth und zum Austausch von Informationen über authentifizierte Benutzer. Es ist nun möglich, die zu verwendenden Dienste zu konfigurieren ORCID „out of the box“ neben anderen standardkonformen OpenID-Connect-Anbietern. OpenID Connect bietet auch gemeinsam nutzbare Funktionen ID Token, bei denen es sich um signierte Objekte handelt, mit denen die Authentifizierung eines Benutzers nachgewiesen werden kann ORCID zu einem bestimmten Zeitpunkt. Diese Token können von Elementen der Benutzeroberfläche verwendet werden, um Benutzersitzungen aufrechtzuerhalten.
ORCID unterstützt das Basic OpenID Provider-Konformitätsprofil, das eine Erweiterung des OAuth-Autorisierungscodeflusses ist. ORCID Unterstützt auch den impliziten Tokenfluss für die Bereiche „/authenticate“ und „openid“.
Dies bedeutet, dass ORCID:
- Einbettungen signiert id Token in Token-Antworten für Autorisierungscodes, die mit dem Bereich „openid“ generiert wurden
- Unterstützt den impliziten Fluss bei Verwendung der Antworttypen „token“ oder „token id_token“ und des Bereichs „openid“.
- Unterstützt die Parameter „prompt“, „nonce“ und „max_age“ für Autorisierungsanfragen, die den Bereich „openid“ umfassen.
- Unterstützt Openid Connect-Erkennungs- und Benutzerinfo-Endpunkte
- Unterstützt das Feld „amr“ für Integratoren, die die Mitglieds-API für Autorisierungsanfragen verwenden, die den Bereich „openid“ umfassen. Dies kann verwendet werden, um herauszufinden, ob sich ein Benutzer mithilfe der Zwei-Faktor-Authentifizierung authentifiziert hat.
Das Initiieren einer OpenID Connect-Authentifizierung funktioniert auf die gleiche Weise wie eine reguläre OAuth-Authentifizierung. Alles, was erforderlich ist, ist, dass der Client den Bereich „openid“ anfordert. Wenn Sie den Bereich „/authenticate“ verwenden, ersetzen Sie ihn durch „openid“, da „authenticate“ und „openid“ dieselbe Berechtigung haben, sollte nur das eine oder das andere verwendet werden. Wenn Sie andere Bereiche verwenden, fügen Sie openid zur Liste der angeforderten Bereiche hinzu. 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.
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.
Sie finden weitere Information unter den jeweiligen Technische Dokumentation um mehr zu erfahren.
ORCID Ermöglicht Benutzern die Aktivierung Zwei-Faktor-Authentifizierung (2FA) auf ihrem ORCID Konto. 2FA ist eine sekundäre Sicherheitsprüfung, die während des Anmeldevorgangs durchgeführt wird. Es bietet eine zusätzliche Bestätigung, dass der Benutzer tatsächlich die Person ist, die sich bei einem anmeldet ORCID Konto. Weitere Informationen dazu, wie dies für Benutzer konfiguriert werden kann, finden Sie in unserer KB-Artikel.
OpenID Connect-Integratoren können mithilfe der Mitglieder-API überprüfen, ob sich der Benutzer bei ihnen angemeldet hat ORCID Konto mit aktivierter 2FA als Teil des OAuth-Prozesses. Dadurch können Mitgliedsintegratoren ihren Forschern Zugriff auf Systeme mit höherer Sicherheit gewähren.
In Übereinstimmung mit Unser Engagement für die Kontrolle der Forscher über ihre ORCID Rekord, kann der Datensatzinhaber jedes Zugriffstoken jederzeit widerrufen, indem er es aus den Berechtigungen in der löscht Vertrauenswürdige Organisationn-Liste auf der Seite „Vertrauenswürdige Parteien“.
Ab 2018 können Forscher nur noch langlebige Zugriffstoken mit einer Gültigkeitsdauer von 20 Jahren vergeben, es sei denn, der Benutzer widerruft die Erlaubnis.
ORCID bietet eine einfache Java-Script-Widget mit dem man sich authentifizieren kann ORCID iDs mit OAuth mit OpenID Connect.
Bitte beachten Sie, dass das Widget implizites OAuth verwendet und daher keine Schreibberechtigungen sammelt. Dies bedeutet, dass es nicht für Mitgliederintegrationen geeignet ist, die Datensätze aktualisieren möchten. Bitte sehen Sie sich unser Tutorial an Hinzufügen und Aktualisieren von Daten zu ORCID Records.
ORCID API
Anmeldeinformationen für öffentliche Kunden werden Einzelpersonen und nicht Organisationen gewährt. Anmeldeinformationen können nicht von einer Person auf eine andere übertragen werden, sie können jedoch in API-Anmeldeinformationen für Mitglieder umgewandelt werden, wenn alle Parteien zustimmen und die Organisation ein aktives Mitglied ist ORCID.
Den Kunden verschieben ID Die Verbindung mit der Mitglieder-API ändert nicht die Client-ID, sondern nur das Client-Geheimnis, und Sie behalten die Anzahl der verbundenen iDs mit Ihrer schreibgeschützten Berechtigung.
Bei der Konvertierung des Public API-Clients in einen Member API-Client wird der Nutzungsbedingungen für öffentliche Kunden gelten nicht mehr und werden durch die Bedingungen der Mitgliedsvereinbarung ersetzt.
Für die Überweisung benötigen wir:
- Bestätigung des öffentlichen API-Clients ID umgewandelt werden.
- Das ist der Hauptkontakt der Organisation und der Datensatzinhaber des aktuellen öffentlichen API-Clients ID stimmen Sie der Änderung der Nutzungsbedingungen zu. (Der Inhaber der Aufzeichnungen muss ein Mitarbeiter, Auftragnehmer oder leitender Angestellter der Mitgliedsorganisation sein.) Wir werden die Zustimmung beider Parteien protokollieren.
- Ein Datum/eine Uhrzeit für die Migration. Im Rahmen dieser Migration werden wir den Client aktualisieren ID und senden Ihnen ein neues Client-Geheimnis in einer verschlüsselten E-Mail. Bitte beachten Sie, dass Ihre Integration nach der Aktualisierung des Clients erst dann funktioniert, wenn Sie das Client-Geheimnis aktualisieren. Aus diesem Grund müssen wir ein Datum und eine Uhrzeit dafür festlegen, um Unannehmlichkeiten für die Benutzer zu vermeiden.
Damit die Konvertierung abgeschlossen werden kann, müssen Sie Folgendes aktualisieren:
- Das alte Client-Geheimnis zum neuen Client-Geheimnis.
- Der API-Host von Kneipe.orcid.org €XNUMX zu api.orcid.org €XNUMX.
Mit Ihrer konvertierten Member API-Client-ID können Sie die hinzuzufügenden Bereiche aktualisieren Mitglieder-API-Bereiche. Dies erfordert eine Autorisierung durch die Benutzer und es werden neue Zugriffstoken generiert, um die neuen Bereiche/Berechtigungen einzuschließen.
Bitte beachten Sie, dass wir die Anmeldeinformationen von Mitglieds-API-Clients nicht in Anmeldeinformationen für die öffentliche API umwandeln können.
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.
Die 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.
Endpunkt | Beschreibung |
/Aufzeichnung | Zusammenfassende Ansicht des Vollständigen ORCID Rekord |
/Person | Biografischer Teil des ORCID Datensatz, auch über /researcher-urls unten |
/Zusammenfassung | Zusammenfassende Ansicht der validierten und selbstbehaupteten Elemente auf der ORCID Datensatz (nur mit der Member-API verfügbar) |
/Adresse | Die Länder oder Regionen des Forschers |
Die mit dem Datensatz verknüpften E-Mail-Adressen | |
/externe-Identifikatoren | Verknüpfte externe Identifikatoren in anderen Systemen |
/Schlüsselwörter | Schlüsselwörter im Zusammenhang mit dem Forscher und seiner Arbeit |
/andere Namen | Andere Namen, unter denen der Forscher bekannt ist |
/persönliche Daten | Persönliche Daten: Name des Forschers, (veröffentlichter) Kreditname und Biografie |
/researcher-urls | Links zu den persönlichen Seiten oder Profilseiten des Forschers |
/Aktivitäten | Zusammenfassung des Aktivitätenabschnitts des ORCID aufzeichnen, auch über /works unten. |
/Bildungen | Bildungszugehörigkeiten |
/Beschäftigungen | Beschäftigungszugehörigkeiten |
/Finanzierungen | Zusammenfassung der Förderaktivitäten |
/peer-reviews | Zusammenfassung der Peer-Review-Aktivitäten |
/funktioniert | Zusammenfassung der Forschungsarbeiten |
/ Forschungsressourcen | Zusammenfassung der Forschungsressourcen |
/Dienstleistungen | Zusammenfassung der Dienstleistungen |
/Qualifikationen | Zusammenfassung der Qualifikationen |
/Mitgliedschaften | Zusammenfassung der Mitgliedschaften |
/Unterscheidungen | Zusammenfassung der Unterscheidungen |
/eingeladene-positionen | Zusammenfassung der eingeladenen Stellen |
Elemente (Arbeiten, Beschäftigung, Finanzierung, Peer-Review usw.) können zu einem hinzugefügt werden ORCID entweder manuell oder mit dem aufzeichnen ORCID Mitglieds-API. Wenn Sie eine Einzelperson sind und Ihre Akte aktualisieren möchten, schauen Sie sich unsere an Hilfebereich dazu finden Sie hier. Wenn Sie Mitglied sind und Elemente zu einem hinzufügen möchten ORCID Für die Aufnahme benötigen Sie Folgendes:
- Die Erlaubnis der Forscher
- Anmeldeinformationen für die Mitglieds-API
- Und entweder:
- Ein Anbietersystem, das sich in das integrieren lässt ORCID Mitglieder-API
- Ihr eigenes System, das sich in das integrieren lässt ORCID Mitglieder-API
Eine vollständige Anleitung für Mitglieder, die die API verwenden, um Elemente in einen Datensatz aufzunehmen, finden Sie in unserem API-Tutorial-Link unten:
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.
Zur Unterstützung der sozialen Komponente bieten wir ein Toolkit an Outreach-Ressourcen um Ihnen bei der Entwicklung einer Kampagne zur Unterstützung Ihrer Integration und der Kommunikation mit Ihren Forschern zu helfen:
- Was ORCID ist.
- Warum Ihr System IDs sammelt und wie Ihr System Aufgaben ausführt, z. B. die Aktualisierung ihrer Datensätze.
- Warum Ihre Forscher von der Erstellung einer ORCID iD und ihre IDs mit Ihrem System verbinden.
- Wie ORCID kommt der breiteren, globalen Forschungsgemeinschaft zugute.
Wir werden diese „Bibliothek“ an Ressourcen basierend auf dem Feedback der Community kontinuierlich erweitern. Wenn Sie eine Idee für etwas haben, das Ihnen gefallen könnte, können Sie sich gerne an uns wenden.
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.
Frühere Version des ORCID Die API hatte zusätzliche Bereiche. Diese Bereiche wurden mit der 2.0-API schrittweise eingestellt. Wir empfehlen, bei allen Integrationen nur die empfohlenen Bereiche zu verwenden. Als Referenz sind unten die früheren Bereiche aufgeführt, wobei stattdessen der aktuelle Bereich verwendet werden sollte
- /orcid-profile/read-limited stattdessen verwenden /read-limited
- /orcid-funktioniert/lesebegrenzt stattdessen verwenden /read-limited
- /orcid-bio/read-limiteIch würde stattdessen verwenden /read-limited
- /orcid-funktioniert/erstellen stattdessen verwenden /Aktivitäten/Update
- /orcid-funktioniert/aktualisiert stattdessen verwenden /Aktivitäten/Update
- /zugehörigkeiten/erstellen stattdessen verwenden /Aktivitäten/Update
- /zugehörigkeiten/update stattdessen verwenden /Aktivitäten/Update
- /Finanzierung/Erstellen stattdessen verwenden /Aktivitäten/Update
- /funding/update verwenden Sie stattdessen /activities/update
- /orcid-bio/update stattdessen verwenden /person/update
- /orcid-bio/external-identifiers/create stattdessen verwenden /person/update
Aktualisierungstoken werden verwendet, um zusätzliche Zugriffstoken zu generieren. Beim Austausch eines Autorisierungscodes im Rahmen des Zugriffstokens wird ein Aktualisierungstoken zurückgegeben dreistufige OAuth-Prozesseund kann verwendet werden, solange das Zugriffstoken aktiv bleibt.
Die neuen Zugriffstoken können denselben Ablauf und dieselben Gültigkeitsbereiche wie das ursprüngliche Zugriffstoken haben oder so festgelegt werden, dass sie eine kürzere Lebensdauer sowie eine kleinere Teilmenge von Gültigkeitsbereichen als das ursprüngliche Zugriffstoken haben. Neue Zugriffstoken können generiert werden, um den ursprünglichen Token zu ersetzen, oder als zusätzlicher Token generiert werden. Sie können Aktualisierungstokenaufrufe auch verwenden, um die ursprünglichen Zugriffs- und Aktualisierungstoken sowie alle vom Benutzer gewährten Berechtigungen vollständig ablaufen zu lassen.
Wir empfehlen die Verwendung von Aktualisierungstokens unter den folgenden Bedingungen:
- Ersetzen von Zugriffstokens, die möglicherweise kompromittiert wurden (Stellen Sie sicher, dass Sie anschließend das ursprüngliche Zugriffstoken widerrufen)
- Geben Sie einem Dritten, der ebenfalls Teil Ihres ist ORCID Integration eingeschränkterer Zugang und/oder Zugang für eine begrenzte Zeit.
Entnehmen Sie bitte unserem Technische Dokumentation Informationen zum Erstellen neuer Zugriffstokens aus Aktualisierungstokens.
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 |
Verwenden Sie Ihre Client-ID, Ihr Geheimnis und entweder das aktive Token oder das zugehörige Aktualisierungstoken, um das Tokenpaar zu widerrufen. Sie können Token-Paare widerrufen, die sowohl im Two-Legged- als auch im Two-Legged-Modus erstellt wurden dreistufige OAuth-Prozesse. Wenn Sie über mehrere Token-Sets verfügen, z. B. für unterschiedliche Bereiche, werden nur das angegebene Zugriffstoken und das entsprechende Aktualisierungstoken widerrufen.
Wir empfehlen, Token unter den folgenden Bedingungen zu widerrufen:
- Um nach Beendigung einer Beziehung an einen Drittanbieter ausgegebene Token zu widerrufen;
- Um Token zu widerrufen, wenn Benutzer ihre Verbindung trennen ORCID iD von Ihrem System;
- Damit Benutzer Token aus Ihrem System heraus widerrufen können.
Wir empfehlen die Verwendung der Token aktualisieren um den Umfang oder die Dauer eines vorhandenen Zugriffstokens zu begrenzen oder ein Token zu aktualisieren, wenn es kompromittiert wurde.
Der Widerruf-API-Aufruf
https://sandbox.orcid.org/oauth/revoke (or https://orcid.org/oauth/revoke)
METHOD: POST
HEADER: accept:application/json
CONTENT-TYPE: application/x-www-form-urlencoded
DATA:
client_id=[Your client ID]
client_secret=[Your client secret]
token=[access token or refresh token for token pair to be revoked]
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:
Endpunkt | Beschreibung |
/address/[Code eingeben] | Ein einzelnes Land oder eine einzelne Region |
/Biografie | Das Biografiefeld: ein freier Textbereich, der nur vom Forscher bearbeitet werden kann |
/education/[Code eingeben] | Ein individuelles Bildungszugehörigkeitselement |
/email/[Code eingeben] | Eine individuelle E-Mail-Adresse, die dem Datensatz zugeordnet ist |
/employment/[Code eingeben] | Ein individuelles Beschäftigungszugehörigkeitselement |
/external-identifier/[Code eingeben] | Eine einzelne verknüpfte externe Kennung in einem anderen System |
/funding/[Put-Code] | Eine individuelle Fördermaßnahme |
/keywords/[Code eingeben] | Ein individuelles Schlüsselwort, das sich auf den Forscher und seine Arbeit bezieht |
/andere-namen/[Code eingeben] | Ein individueller Zusatzname, unter dem der Forscher bekannt ist |
/peer-review/[Code eingeben] | Eine individuelle Peer-Review-Aktivität |
/researcher-urls/[Code eingeben] | Ein individueller externer Link zur persönlichen Seite oder Profilseite des Forschers |
/work/[Code eingeben] | Eine individuelle Forschungsarbeit |
/works/[Put-Code1],[Put-Code2],[Put-Code3] | Einzelne Forschungsarbeiten in großen Mengen (bis zu 100) |
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
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.
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.
ORCID Mitglieder können Informationen aktualisieren, die sie zuvor zu einem hinzugefügt haben ORCID aufzeichnen. Es kann jeweils nur ein Element aktualisiert werden, und zwar nur mit den Client-Anmeldeinformationen, mit denen es ursprünglich erstellt wurde.
Um die Aktualisierung zu erleichtern, stellen Sie sicher, dass Sie Speichern Sie den Put-Code und das Zugriffstoken beim Erstellen von Artikeln.
Formatieren Sie das aktualisierte Element in ORCID Nachrichtenschema mit den geänderten Informationen und schließen die gespeicherten ein Code eingeben.
<?xml version="1.0" encoding="UTF-8"?> <employment:employment put-code="739288" [...]> [...] </employment:employment>
Rufen Sie die API auf:
Method: PUT Content-type: application/vnd.orcid+xml or application/vnd.orcid+jsonnAuthorization type and Access token: Bearer [stored access token]Data: link to file or text of affiliation to update URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment/739288
Die API gibt eine 200 OK-Meldung zurück, um anzuzeigen, dass das Element korrekt aktualisiert wurde. Schauen Sie auf unserer Fehlerbehebungsseite nach, wenn eine andere Meldung zurückgegeben wird.
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.
Elemente (Arbeiten, Beschäftigung, Finanzierung, Peer-Review usw.) können zu einem hinzugefügt werden ORCID Aufnahme mit dem ORCID Mitglieds-API. Dazu müssen Sie zunächst Holen Sie mithilfe von OAuth die Erlaubnis des Forschers ein und Formatieren Sie die Elementmetadaten Verwendung der ORCID Nachrichtenschema.
Sobald Sie die Daten formatiert und gesammelt haben ORCID iD und Zugriffstoken erstellen Sie eine API-Anfrage mit HTTP POST und geben dabei an relevanten Endpunkt.
Method: POST
Content-type: application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]data: link to file or text of single employment item to add
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment
Der folgende Aufruf fügt eine neue hinzu Beschäftigung Zugehörigkeit zu einem Datensatz auf dem Sandbox-Testserver:
<?xml version="1.0" encoding="UTF-8"?>
<employment:employment [...]>
[...]
</employment:employment>
Die API gibt eine 201-Nachricht zurück, um anzuzeigen, dass der Artikel zusammen mit dem Artikel korrekt gepostet wurde Code eingeben. Ihr Kunde wird als aufgeführt Quelle des Artikels.
Schauen Sie sich unsere Fehlersuche Seite, wenn eine andere Nachricht zurückgegeben wird. Sie müssen das speichern Speichern Sie den Put-Code und das Zugriffstoken um Aktualisierungen vorzunehmen oder das Element zu entfernen.
Die ORCID Die Such-API verwendet die SOLR-Syntax. Alle in SOLR 3.6 verfügbaren Abfragesyntaxen werden unterstützt, einschließlich Lucene mit Solr-Erweiterungen (Default), DisMax und Extended Dismax.
Zur Nutzung benötigen Sie ein „/read-public“-Zugriffstoken. Sobald Sie Ihr Suchtoken erhalten haben, erstellen Sie Ihre Basissuch-URL:
Art der Anmeldeinformationen: | Öffentliche API | Mitglieder-API |
Ressourcen-URL: | Sandbox: https://pub.sandbox.orcid.org €XNUMX Produktion: https://pub.orcid.org €XNUMX | Sandbox: https://api.sandbox.orcid.org €XNUMX Produktion: https://api.orcid.org €XNUMX |
API-Version: | v3.0 | |
Endpunkt suchen | /search/?=[Abfrage] |
Ein Beispielaufruf zur Suche nach „orcid” mit dem Token auf der öffentlichen Sandbox-API mit den im XML-Format zurückgegebenen Ergebnissen ist:
Method: GET Content-type: application/vnd.orcid+xmlnAuthorization type and Access token: Bearer [stored access token]URL: https://pub.sandbox.orcid.org/v3.0/search/?q=orcid
Die Ergebnisse geben die Anzahl der gefundenen Ergebnisse an (num-found) und zeigen standardmäßig die ersten 1000 Ergebnisse an:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<search:search num-found="385" xmlns:search="https://www.orcid.org/ns/search" xmlns:common="https://www.orcid.org/ns/common">
<search:result>
<common:orcid-identifier>
<common:uri>https://sandbox.orcid.org/0000-0001-2345-6789</common:uri>
<common:path>/0000-0001-2345-6789</common:path>
<common:host>sandbox.orcid.org</common:host>
</common:orcid-identifier>
</search:result>
[...]
</search:search>
Ein Beispiel für eine einfache Suche in der öffentlichen Sandbox-API mit Ergebnissen, die im JSON-Format zurückgegeben werden:
Method: GET
Content-type: application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.sandbox.orcid.org/v3.0/search/?q=newman
Die Suche gibt nur die Einzelperson zurück ORCID IDs von Datensätzen mit öffentlichen Daten, die mit der Suche übereinstimmen. Um weitere Informationen über das Ergebnis zu erhalten, rufen Sie an, um die zu lesen ORCID direkt aufnehmen.
Weitere Informationen finden Sie auf unserer Tutorial zur Such-API.
Wenn Sie Daten hinzugefügt haben, die gelöscht werden müssen, z. B. wenn diese mit einem Unrecht verknüpft wurden ORCID iD, dann können Sie eine HTTP-DELETE-Anfrage unter Angabe der stellen relevanten Endpunkt, zusammen mit ORCID Ich würde, gespeicherter Zugriffstoken und gespeicherter Put-Code. Es kann jeweils nur ein Element gelöscht werden, und Sie können nur von Ihrem Kunden hinzugefügte Elemente löschen. Sie können Elemente auch dann löschen, wenn der Benutzer die Berechtigung widerrufen hat.
Dieser Beispielaufruf löscht das Beschäftigungselement mit dem Put-Code „739288“ aus einem Datensatz.
Method: DELETE
Content-type: application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment/739288
Die ORCID Die Such-API verwendet die SOLR-Syntax. Alle in SOLR 3.6 verfügbaren Abfragesyntaxen werden unterstützt, einschließlich Lucene mit Solr-Erweiterungen (Default), DisMax und Extended Dismax.
Sie können eine Feldsuche verwenden, wenn Sie einen bestimmten Abschnitt des durchsuchen müssen ORCID aufzeichnen. Die aktuelle Liste der in der API-Suche erkannten Felder zusammen mit den entsprechenden Datensatzstrukturelementen lautet wie folgt:
Suchfeld | Beschreibung |
Biografische Daten | |
Vornamen | Der oder die Vornamen des Benutzers. |
Nachname | Der Familienname (Nachname) des Benutzers. |
Kreditname | Der „veröffentlichte Name“ auf der ORCID Benutzeroberfläche, der Name, der normalerweise in Veröffentlichungen des Benutzers erscheint |
andere Namen | Alternative Namen, die möglicherweise in Veröffentlichungen des Benutzers aufgetaucht sind. |
Die E-Mail-Adresse des Benutzers. | |
Stichwort | Alle mit dem Benutzer verknüpften Schlüsselwörter. |
externe-id-referenz | Den Benutzern hinzugefügte Kennungen aus anderen Systemen ORCID Aufzeichnung über die API. |
Zugehörigkeitsdaten | |
Name der Zugehörigkeitsorganisation | Der Name einer beliebigen Organisation in einem Bildungs- oder Beschäftigungselement im Datensatz des Benutzers. |
Grid-org-id | Die GRID-ID einer Organisation im Abschnitt „Aktivitäten“ des Benutzerdatensatzes. Im Allgemeinen ist dies mit einer Ausbildung oder Beschäftigung verbunden. |
ror-org-id | Die ROR-ID einer Organisation im Abschnitt „Aktivitäten“ des Benutzerdatensatzes. Im Allgemeinen ist dies mit einer Ausbildung oder Beschäftigung verbunden. |
ringgold-org-id | Die Ringgold-ID* einer beliebigen Organisation im Abschnitt „Aktivitäten“ des Benutzerdatensatzes. Im Allgemeinen ist dies mit einer Ausbildung oder Beschäftigung verbunden. |
Finanzierungsdaten | |
Fördertitel | Der Titel eines beliebigen Finanzierungselements im Benutzerdatensatz. |
fundref-org-id | Die Crossref-Förderer-Registrierungs-ID einer Organisation im Abschnitt „Aktivitäten“ eines Benutzerdatensatzes. Im Allgemeinen ist dies mit einem Finanzierungsposten verknüpft, kann aber auch mit einer Zugehörigkeit verknüpft sein. |
Fördernummern | Fördernummer (Kennung) eines beliebigen Finanzierungselements im Datensatz des Benutzers. |
Daten zu Forschungsaktivitäten | |
Werktitel | Die Titel aller Werke im Datensatz des Benutzers. |
digitale-objekt-ids | Eine externe Arbeitskennung vom Typ doi |
doi-selbst | Ein externer Arbeitsbezeichner mit dem Typ „doi“ und der externen Bezeichnerbeziehung, die auf „self“ festgelegt ist |
[Typ der externen Kennung]* | Ein externer Arbeitsbezeichner mit dem angegebenen Typ |
[externer Bezeichnertyp]*-self | Ein externer Arbeitsbezeichner mit dem angegebenen Typ und der auf self gesetzten externen Bezeichnerbeziehung |
[externer Bezeichnertyp]*-Teil von | Ein externer Arbeitsbezeichner mit dem angegebenen Typ und der externen Bezeichnerbeziehung, die auf Teil von festgelegt ist |
[Typ der externen Kennung]*-Version-von | Ein externer Arbeitsbezeichner mit dem angegebenen Typ und der externen Bezeichnerbeziehung, die auf „Version von“ festgelegt ist * Eine vollständige Liste der externen Identifikatoren finden Sie im Liste der Bezeichner. Einige Bezeichner erfordern möglicherweise „-self“, „-part-of“ oder „-version-of“, um Ergebnisse zurückzugeben |
ORCID Daten aufzeichnen | |
orcid | Die 16-stellige ORCID Kennung des Benutzers im Format 0000-0001-2345-6789. |
Profil-Einreichungsdatum | Das Datum und die Uhrzeit, zu der der Datensatz erstellt wurde. |
Datum der letzten Änderung des Profils | Datum und Uhrzeit der letzten Änderung des Datensatzes. |
Alle Daten | |
Text | Alle oben genannten Felder. Dies ist auch das Standardfeld für Lucene-Syntaxabfragen. |
Sie finden weitere Information unter den jeweiligen Such-API-Tutorial um mehr zu erfahren.
*Obwohl Ringgold-Identifikatoren immer noch innerhalb der existieren ORCID Register, ab 1. August 2023, ORCID erhält keine Aktualisierungen der von unserem Register verwendeten RINGGOLD-Organisationsidentifikationsdatenbank mehr und wir können auch nach diesem Datum erstellte RINGGOLD-IDs nicht mehr verarbeiten oder nutzen. Sehen Sie sich unsere an FAQ für weitere Infos
In realen Situationen werden API-Interaktionen von Ihrem System mithilfe einer Programmiersprache wie PHP, Java oder Ruby on Rails durchgeführt. Zum Üben und Testen können Sie mit dem interagieren ORCID APIs, die eine Reihe von Tools verwenden, die HTTP-Anfragen stellen und empfangen können. Die meisten Desktop-HTTP-Tools werden in der Befehlszeile ausgeführt. Für diejenigen, die eine grafische Oberfläche bevorzugen, sind webbasierte Tools eine sinnvolle Alternative.
XML/XSD-VERIFIZIERUNG
Es gibt viele Tools, die Ihr XML für Sie überprüfen. Es ist eine gute Idee, eines zu adoptieren. Bei vielen API-Aufrufen arbeiten Sie mit XML-formatierten Informationen. Besonders bei der Arbeit mit ORCID Bei der API-Nachricht ist es wichtig, dass das von Ihnen verwendete XML gegenüber der XSD gültig ist. (Siehe unsere Dokumentation auf GitHub für die ORCID Nachrichtenschema XSD.)
ORCID SANDBOX-TESTSERVER
Die Sandbox-Testserver ist eine Kopie von ORCID Registrierungssoftware und enthält nur Testdaten. Es soll einen Ort bieten, an dem man Dinge ausprobieren kann, ohne die Realität zu beeinträchtigen ORCID iDs, insbesondere wenn Sie mit dem arbeiten ORCID API und benötigen einen Ort zum Testen Ihrer Arbeit. Sie können Benutzerkonten erstellen und API-Aufrufe in der Sandbox testen, ohne sich Sorgen machen zu müssen, dass Produktionsdaten beeinträchtigt werden oder Forscher versehentlich Spam erhalten.
Sie müssen nicht einmal ein sein ORCID Mitglied, um die Mitglieds-API in der Sandbox auszuprobieren. Alle sind herzlich eingeladen, Anmeldeinformationen für die Sandbox-Mitglieds-API anzufordern und alle für die Mitglieds-API verfügbaren Funktionen auszuprobieren.
Die Site und die APIs werden nicht so zuverlässig sein wie bei den Produktionsservern. Wir geben keine Garantien für die Daten in der Sandbox. Sie werden nicht gesichert und können gelöscht werden. Die Sandbox enthält möglicherweise auch einige experimentelle Funktionen, die noch nicht auf den Produktionsservern vorhanden sind, sodass Sie Dinge ausprobieren können, bevor sie in der Registrierung vorhanden sind. Mehr erfahren über den Sandbox-Testserver bzw Kundenanmeldeinformationen anfordern.
HTTP-TOOLS
Es stehen viele Tools zum Ausführen von HTTP-Anfragen zur Verfügung. Einige verwenden wir:
Webhooks können von Premium-Mitgliedern gegen jeden registriert werden ORCID im Register eintragen. Die Schritte sind:
Verschlüsseln Sie die URL
URL-kodieren Sie die gewünschte URL ORCID Wird aufgerufen, wenn der Benutzerdatensatz aktualisiert wird. Zum Beispiel die folgende URL:
https://nowhere2.com/0000-0002-7465-2162/updated
wird
https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
Erstellen Sie die URL
Erstellen Sie die vollständige URL für ORCID API-Aufruf beginnend mit der URL des ORCID Nehmen Sie den Eintrag auf und fügen Sie dann ‚√∫/webhook‚√π und die URL hinzu, die Sie aufrufen möchten. Es sollte also wie https://api.sandbox aussehen.orcid.org/{ORCID}/webhook/{URL-ENCODED-WEBHOOK-URL}
Verwenden Sie beispielsweise die obige Webhook-URL und die ORCID iD 0000-0002-7465-2162, die vollständige URL lautet:
https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
Registrieren Sie den Webhook
Verwenden Sie das Zugriffstoken Ihres Webhooks, um Ihren Webhook beim Benutzer zu registrieren ORCID aufzeichnen. Sie müssen eine HTTP-PUT-Anfrage verwenden, sollten jedoch nichts in den Hauptteil der Anfrage einfügen.
URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdatedn HEADER: Accept: application/json HEADER: Authorization: Bearer [Your access token]n HEADER: Content-Length: 0n METHOD: PUT
Die Antwort sollte 201 sein. Wenn der Rückruf jedoch bereits vorhanden war, lautet die Antwort 204.
HTTP/1.1 201nServer: nginx/1.1.19nConnection: keep-alive Location: https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Frequestb.in%2Fz57lzcz5
Die URL zum Aufheben der Registrierung eines Webhooks ist dieselbe wie für die Registrierung. Sie müssen jedoch die HTTP-DELETE-Methode verwenden.
URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
HEADER: Authorization: Bearer [Your access token]
HEADER: Content-Length: 0
METHOD: DELETE
Die Antwort sollte sein 204 No Content
.
HTTP/1.1 204 No Content
Server: Apache-Coyote/1.1
Date: Fri, 05 Apr 2013 12:49:17 GMT
Die ORCID Die Registrierung führt den folgenden HTTP-Aufruf aus, wenn ein Datensatz aktualisiert wird. Die Anfrage verwendet die HTTP-POST-Methode, aber der Hauptteil der Anfrage ist leer.
curl -v -X POST https://nowhere2.com/0000-0002-7253-3645/updated
Ihr Server sollte mit Standard-HTTP-Antwortcodes antworten. Wenn der Anruf erfolgreich war, sollten Sie also 204 No Content zurückgeben.
HTTP/1.1 204 No Content
Jeder 2xx-Antwortcode bedeutet, dass der Anruf erfolgreich war. Wenn Sie einen Code zurücksenden, der kein 2xx ist, werden wir den Anruf fünf Minuten später erneut versuchen.
In realen Situationen werden API-Interaktionen von Ihrem System mithilfe einer Programmiersprache wie PHP, Java oder Ruby on Rails durchgeführt. Zum Üben und Testen können Sie jedoch mit dem interagieren ORCID API, die eine Reihe von Tools verwendet, die HTTP-Anfragen stellen und empfangen können. Die meisten Desktop-HTTP-Tools (z. B cURL) werden in der Befehlszeile ausgeführt; Für diejenigen, die eine grafische Oberfläche bevorzugen, sind webbasierte Tools eine sinnvolle Alternative.
Ein beliebtes Tool ist Googles OAuth 2.0 Playground, ein kostenloses, webbasiertes Tool, das von Google entwickelt und verwaltet wird.
Bitte sehen Sie sich unser praktisches API-Tutorial unter https://info an.orcid.org/hands-on-with-the-orcid-api/
Hinweis: ORCID pflegt den OAuth 2.0 Playground nicht – dieses Tool wurde von Google erstellt, das ausschließlich seinen Code pflegt. Obwohl wir diese Dokumentation regelmäßig aktualisieren, kann es von Zeit zu Zeit zu Ungenauigkeiten kommen, da uns Änderungen am OAuth 2.0 Playground möglicherweise nicht sofort bekannt sind.
Für unsere API-Version 2.0 und höher gelten folgende Grenzwerte:
- Fordern Sie eine Sekunde an – 24
- Burst – 40
Eine Sekunde anfordern – Anzahl der Anfragen, die pro Sekunde gestellt werden können.
Burst – Anzahl der Anfragen, die in die Warteschlange gestellt werden, bevor sie abgelehnt werden. Anfragen in der Warteschlange werden auf die Anzahl der Anfragen pro Sekunde verlangsamt. Wenn Sie den Burst überschreiten, erhalten Sie eine 503-Antwort.
Wenn Sie Probleme mit den Grenzwerten haben, wenden Sie sich bitte an Ihren Engagement-Teamleiter, um Unterstützung zu erhalten.
Die Kontrolle der Forscher ist ein Kernstück ORCID Prinzip Also E-Mail-Adressen registriert und dem hinzugefügt ORCID Datensatz sind standardmäßig so eingestellt, dass sie nur für den Datensatzinhaber sichtbar sind. Nicht verifizierte E-Mails werden nicht in der öffentlichen Ansicht des Datensatzes angezeigt und nur verifizierte E-Mail-Adressen werden in den API-Ergebnissen angezeigt.
Sobald Forscher ihre E-Mail-Adresse verifiziert haben, müssen sie entscheiden, ob sie diese für jedermann sichtbar (z. B. öffentlich) oder für vertrauenswürdige Parteien (z. B. eingeschränkter Zugriff) machen soll, damit die E-Mail-Adresse von Drittorganisationen gelesen werden kann.
Wenn der Forscher seine E-Mail-Adresse auf „Vertrauenswürdige Parteien“ eingestellt hat, wird diese mit der Aufzeichnung zurückgegeben, sofern der Forscher Ihnen die Erlaubnis erteilt hat lesebeschränkter Zugriff. Weitere Informationen finden Sie unter ORCID Sichtbarkeitseinstellungen.
API 3.0 ist die Standard-API-Version und wir empfehlen, diese Version beim Erstellen neuer Integrationen zu verwenden. Wir werden API 2.0 und 2.1 auf absehbare Zeit weiterhin unterstützen und die Abschaltung dieser Versionen mindestens 12 Monate im Voraus benachrichtigen.
Wir haben beim Übergang von API 1.2 zu API 2 viel gelernt. Dieses Mal haben wir die Verwaltung des Upgrades erheblich vereinfacht. API 3.0 fügt neue Funktionen hinzu und ändert bestehende Funktionen nur, wenn dies unbedingt erforderlich ist. Das bedeutet, dass Integratoren mit minimalem Aufwand auf die neue API umsteigen können sollten. Das bedeutet auch, dass wir Ihnen zwar empfehlen, so bald wie möglich mit der Planung Ihres Upgrades zu beginnen, damit Ihre Organisation und Ihre Forscher von den neuen Funktionen profitieren können, Sie jedoch viel Flexibilität bei der Entscheidung haben, wann Sie auf 3.0 aktualisieren.
Die kleine Liste potenziell bahnbrechender Änderungen finden Sie in unseren API-Versionshinweisen Hier und Hier . Es gibt einige Änderungen an optionalen/obligatorischen Feldern, JSON-Aufzählungen wurden leicht geändert und wir haben auch eine kleine Umgestaltung unserer XML-Schemas vorgenommen und einige neue Felder hinzugefügt, um die für die neue Funktionalität erforderlichen Metadaten zu enthalten.
Bitte beachten Sie die ORCID Seite „Anbieterfähige Systeme“ für Verlage für die aktuellsten Informationen
Jedes Premium-Mitglied kann ein „/webhook“-Zugriffstoken erhalten. Mit einem einzigen Token können Webhooks für mehrere Datensätze registriert werden. 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.
Unten finden Sie einen Beispielaufruf zum Abrufen des Zugriffstokens. Ersetzen Sie die Platzhalter durch Ihre Anmeldeinformationen (entfernen Sie unbedingt die Klammern).
curl -i -L -H "Accept: application/json"
-d "client_id=(your client ID)"
-d "client_secret=(your client secret)"
-d "scope=/webhook"
-d "grant_type=client_credentials"
"https://sandbox.orcid.org/oauth/token"
Sie erhalten dann ein Zugriffstoken ähnlich dem folgenden zurück.
{"access_token":"5eb23750-1e19-47a3-b6f6-26635c34e8ee",
"token_type":"bearer",
"refresh_token":"c7d3d5fd-e4c0-4825-89f2-7cfb4a1cf01e",
"expires_in":631138518,
"scope":"/webhook"}
Ja das tun wir! Mehr über unsere API-Versionierung, die dahinter stehenden Gründe und vieles mehr können Sie hier bei uns lesen API-Versionsrichtlinie.
Während wir unsere Produkte weiterentwickeln, gibt es eine Reihe von Funktionen, die nur mit API 3.0 verfügbar sind, unserer neuesten und standardmäßigen API-Version.
Die folgende Tabelle enthält eine kurze Beschreibung der einzelnen Funktionen. Wenn Sie Fragen zu den Funktionen oder zum Upgrade auf 3.0 haben, wenden Sie sich bitte an Ihren Engagement Lead oder Ihren Konsortialleiter.
Fähigkeit zum Lesen und Schreiben aller Zugehörigkeitstypen (Mitgliedschaft, Dienst, eingeladene Positionen, Auszeichnungen und Qualifikationen sind in früheren Versionen der API nicht verfügbar) |
Fähigkeit, Forschungsressourcen zu lesen und zu schreiben. |
Fähigkeit, Arbeitskennungen mit dem Beziehungstyp „Gefördert von“ zu lesen und zu schreiben. Dies wird verwendet, um Grant- oder Proposal-IDs mit Arbeitsmetadaten zu verknüpfen. |
Fähigkeit zum Lesen und Schreiben von Arbeitskennungen mit dem Beziehungstyp „Version von“. Dies wird verwendet, um andere Versionen des Werks miteinander zu verknüpfen. Ein Beispielanwendungsfall wäre die Verknüpfung des Preprints und des veröffentlichten Artikels. |
Fähigkeit, CRediT-Rollen in Werkmetadaten zu lesen und zu schreiben. |
Möglichkeit, die zusätzlichen Quellfelder zu lesen common:assertion-origin-client-id und common:assertion-origin-name für von der hinzugefügte Zugehörigkeiten ORCID Mitgliederportal und über Such- und Linkassistenten hinzugefügte Werke. |
Lese- und Schreibfähigkeit bei Arbeiten mit folgender Arbeitsart: Anmerkung Datenverwaltungspläne Dissertation Preprint physikalisches Objekt Überprüfen |
Möglichkeit, externe IDs für Zugehörigkeiten zu lesen und zu schreiben. |
Für das Hinzufügen von Zugehörigkeiten und Finanzierung sind Organisations-IDs erforderlich ORCID Records. |
Formalisierung von Identifikatoren – Wir haben ein neues vom System generiertes Feld eingeführt, das externe Identifikatoren (DOIs, PMCID, PMID, ArXiv, Bibcode, ISSNs und ISBNs) zum Zwecke des Abgleichs und der Gruppierung in einem normalisierten Format ausdrückt. Die Normalisierung erfolgt auf der Grundlage der Regeln des Bezeichnertyps und kann das Festlegen aller Buchstaben in Kleinbuchstaben oder das Umwandeln von Leerzeichen, Bindestrichen, Punkten und anderen Zeichen umfassen, die als gleichwertig behandelt werden können. Außerdem werden gegebenenfalls Standardpräfixe und -suffixe hinzugefügt. Zum Beispiel, https://doi.org/10.1/123, 10.1/123 und https://dx.doi.org/10.1/123 werden alle in diesem Feld als angezeigt https://doi.org/10.1/123. Der vorhandene Bezeichnerwert bleibt unverändert. |
Nähere Informationen finden Sie hier Hier .
Andere
Sie erhalten eine Benachrichtigung in ihrem ORCID Posteingang. Immer wenn sich die Daten ändern ORCID Datensatz erhält der Benutzer eine Benachrichtigung mit grundlegenden Informationen über die Änderung, einschließlich des Namens des Clients, der die Aktualisierung durchführt, des Änderungsdatums und des Elements im ORCID Datensatz, der aktualisiert wurde. Sehen Sie sich unsere an Weitere Informationen zu Benachrichtigungen finden Sie in der Benutzer-Wissensdatenbank.
ORCID Datensätze auf der Sandbox haben auch funktionierende Posteingänge. Wir empfehlen Ihnen, die Posteingänge Ihrer Tests regelmäßig durchzusehen ORCID Aufzeichnungen, wenn Sie planen, wie Ihre Systeme Datenaktualisierungen planen.
Updates und andere Ankündigungen für API-Benutzer werden über geteilt ORCID API-Benutzergruppe. Sie können auch allgemeine Nachrichten und Updates über die abonnieren ORCID Blog.
ORCID Mitglieder erhalten außerdem die ORCID Mitglieder-Newsletter, in dem diese Informationen enthalten sind. Zum Schluss noch der technische Ansprechpartner für alle ORCID Mitglieder mit einer aktiven, benutzerdefinierten Integration erhalten außerdem E-Mail-Nachrichten über alle wichtigen Aktualisierungen der ORCID Registrierung. Wenn Sie als technischer Ansprechpartner für Ihre Organisation aufgeführt werden möchten, wenden Sie sich bitte an uns kontaktiere uns.
ORCID verpflichtet sich zu Offenheit und Transparenz. Damit ist unsere gemeint Produkt-Roadmap ist für jedermann einsehbar, ebenso wie die Arbeit, die sich derzeit in der Entwicklung befindet.
Die Produkt-Roadmap ist von zentraler Bedeutung ORCID Produktentwicklungsprozess. Die Anforderungen wandern von den vom Team verwalteten Trello-Boards über das Trello-Board „Produkt-Roadmap“ zum Trello-Board „Aktuelle Entwicklung“, wo sie implementiert und in unsere Produktionssysteme verschoben werden.
Dieses Board enthält klar definierte Anforderungen, deren Umsetzung geplant ist irgendwannsowie eine Liste priorisierter Anforderungen, deren Umsetzung in naher Zukunft geplant ist.
Woher kommen Anforderungen?
Anforderungen werden aus vielen Quellen gesammelt von ORCID Mitarbeiter. Sie können unter anderem aus Mitgliedsanfragen, Konsortium-Feedback, Benutzertests, strategischen Projekten und Fehlerberichten stammen. Darüber hinaus alle ORCID Teams generieren ihre eigenen internen Anforderungen, wie z. B. Website-Änderungen, Infrastruktur-Upgrades und Betriebssystem-Updates. Jede Karte ist mit dem Team gekennzeichnet, das die Anforderung erstellt hat – Kommunikation, Strategie, Technik, Engagement oder Betrieb.
Wie sieht es mit der Roadmap aus?
ORCID strebt einen ausgewogenen Produktentwicklungszyklus an und führt regelmäßige teamübergreifende Treffen durch, um kurz- und langfristige Prioritäten zu besprechen. Wir versuchen unser Bestes, um Fehler, neue Funktionen, technische Schulden, Website-Updates und strategische Punkte gleichermaßen zu beheben.
Wie kann ich zur Roadmap beitragen?
Wir freuen uns über Verbesserungsvorschläge ORCID Registrierung. Bitte senden Sie Ihr Feedback an unser Team.
Zudem hat auch Frau ORCID ist ein Open-Source-Projekt und wir freuen uns über Beiträge zu unserem Quellcode sowie über alle anderen unsere Repositories.
Ein Preprint ist ein vollständiges wissenschaftliches Manuskript, das von den Autoren auf einen öffentlichen Server hochgeladen wird. Der Vorabdruck enthält vollständige Daten und Methoden; Oft wird dasselbe Manuskript bei einer Zeitschrift eingereicht. Nach einer kurzen Qualitätskontrolle, um sicherzustellen, dass die Arbeit wissenschaftlicher Natur ist, wird das Manuskript des Autors innerhalb von etwa einem Tag ohne Peer-Review im Internet veröffentlicht und kann von jedem auf der Welt kostenlos eingesehen werden. Basierend auf Rückmeldungen und/oder neuen Daten können neue Versionen Ihres Vorabdrucks eingereicht werden; Allerdings bleiben auch frühere Preprint-Versionen erhalten. Mit Preprint-Servern können Wissenschaftler die Verbreitung ihrer Arbeit an die weltweite wissenschaftliche Gemeinschaft direkt steuern. In den meisten Fällen wird die gleiche Arbeit, die als Vorabdruck veröffentlicht wurde, auch zur Begutachtung durch Fachzeitschriften bei einer Zeitschrift eingereicht. Somit funktionieren Preprints (schnell, aber nicht durch Peer-Review validiert) und Zeitschriftenveröffentlichungen (langsam, aber mit Validierung durch Peer-Review) parallel als Kommunikationssystem für die wissenschaftliche Forschung.
Sehen Sie sich das Video auf YouTube an
Hinweis: Dieser Inhalt und dieses Video erschienen ursprünglich auf der ASAPBio-Website Vielen Dank an ASAPBio für die Bereitstellung unter einer CC-BY-Lizenz!
Der Mitglieder-Newsletter wird monatlich verschickt von ORCID enthielt zuvor einen Link zu einem Google Drive-Ordner, in dem alle Ihre Mitgliederberichte gespeichert waren. Dies wurde nun durch neue Berichte ersetzt, die allen Mitgliedern im zur Verfügung stehen Mitgliederportal.
Frühere Berichte:
- Premium-Mitglieder mit aktiven Integrationen Sie erhalten einen eindeutigen Link zu einem Ordner mit separaten, benutzerdefinierten Berichten mit Daten für jede Integration im Vormonat.
- Premium-Mitglieder, die noch keine aktive Integration haben Sie erhalten einen eindeutigen Link zu einem Ordner mit benutzerdefinierten Berichten mit E-Mail-Statistiken für ihre Institution sowie einen Link zu einem Ordner, der allgemeine Berichte mit aggregierten Daten für alle aktiven Mitgliederintegrationen enthält.
- Grundlegende Mitglieder Sie erhalten einen Link zu einem Ordner mit allgemeinen Berichten, die zweimal jährlich mit aggregierten Daten für alle aktiven Mitgliederintegrationen im vorangegangenen Halbjahr herausgegeben werden. Der Halbjahresbericht wird veröffentlicht Juli (Daten von Januar bis Juni), der zweite Halbjahresbericht, veröffentlicht in Januar (Juli-Dezember des Folgejahres).
Wenn Sie sind ORCID Wenn Sie Mitglied sind und den monatlichen Mitglieder-Newsletter derzeit nicht erhalten, wenden Sie sich bitte an [E-Mail geschützt]
Premium-Mitglieder mit aktiven Integrationen
Der Google Drive-Ordner enthält einen Mitgliedsbericht für jede der Ihnen ausgestellten Produktions-Client-IDs. Die Dateinamen enthalten den Anzeigenamen des Clients iD und das Datum des Berichts; Bitte sortieren Sie nach Änderungsdatum, um den neuesten Bericht zu finden. Außerdem gibt es einen Ordner „raw_data“, der die zur Erstellung des Berichts verwendeten Daten enthält und bei Bedarf für weitere Analysen zur Verfügung steht.
Premium-Mitglieder, die noch keine aktive Integration haben
Der Google Drive-Ordner enthält einen Mitgliederbericht nur mit E-Mail-Statistikdaten sowie einen Link zu einem Google Drive-Ordner mit allgemeinen monatlichen Berichten mit aggregierten Daten für alle aktiven Mitgliederintegrationen für das aktuelle und frühere Jahr. Für diese Berichte sind keine Rohdaten verfügbar.
E-Mail-Domain zählt
In diesem Abschnitt werden die Anzahl angegeben ORCID iDs hat derzeit die E-Mail-Domäne(n) Ihrer Institution über alle Zeiträume hinweg registriert. Um diese Zählungen zu generieren, suchen wir nach Domains, die mit der Website-URL übereinstimmen, die wir für Ihre Organisation gespeichert haben (z. B. wenn Ihre Website-URL www.universitycollege.edu lautet, suchen wir nach E-Mails, die auf @universitycollege enden). Wenn wir keine Website-URL gespeichert haben, wird in diesem Abschnitt „√∫Keine E-Mail-Domänen angegeben“ angezeigt. Wenn wir Ihre E-Mail-Domain nicht ganz richtig verstanden haben oder Sie weitere Domains hinzufügen möchten, wenden Sie sich bitte an uns kontaktiere uns.
- Datensätze, die für Ihre E-Mail-Domänen registriert sind¬¨‚Anzahl der eindeutigen ORCID IDs, die eine Adresse innerhalb der E-Mail-Domäne(n) Ihrer Institution enthalten
- Datensätze, die für Ihre E-Mail-Domänen registriert UND mit Ihrer Kunden-ID verknüpft sind¬¨‚Anzahl der eindeutigen ORCID IDs, die eine Adresse innerhalb der E-Mail-Domäne(n) Ihrer Institution enthalten UND die Ihre Institution als vertrauenswürdige Partei enthalten (d. h. Datensätze, für die Ihre Institution über ein gültiges Zugriffstoken verfügt)
Datensätze erstellt und beansprucht
(Hinweis: Die meisten Kunden haben diesen Abschnitt nicht in ihren Berichten.)
Wenn Sie einen institutionellen Kunden haben, der zur Erstellung von Datensätzen im Auftrag von Forschern über die API verwendet wurde, erhalten Sie einen Abschnitt mit der Bezeichnung „Registrierungsstatistik“. Dazu gehören Informationen über die Anzahl der von Ihnen erstellten Datensätze und wie viele beansprucht wurden (die Datei „raw_data“ enthält weitere Informationen über die spezifischen Datensätze, die zur Generierung dieser Zahlen verwendet wurden).
Nutzer
Dieser Abschnitt des Berichts enthält die Gesamtzahl der Forscher, die Ihre Integration für die Verbindung verwendet haben ORCID iD in Ihrem System im Laufe des Monats der Berichterstattung. Darüber hinaus wird die Gesamtzahl der Forscher angegeben, die sich für eine neue Studie angemeldet haben ORCID iD als Teil der iD Verbindungsprozess.
Die Grafik mit der Bezeichnung „Gesamtintegrationsereignisse“ zeigt die Anzahl der Forscher pro Tag, die Ihre Integration im letzten Monat genutzt haben
Veranstaltungen
Der Bericht enthält auch Veranstaltungen Informationen, die Aktionen, die der Forscher beim Verbinden durchgeführt hat ORCID im Berichtsmonat mit Ihrem System erfassen. Jedes Ereignis stellt einen beliebigen Zugriff dar, den der Benutzer gewährt hat, oder eine Aktion, die er darauf ausgeführt hat ORCID Website (z. B. Anmelden oder Gewähren von eingeschränktem Lesezugriff). Mit den meisten Forschern ist mehr als ein Ereignis verbunden.
Wenn an ein Ereignis ein ‚√∫√π angehängt ist, bedeutet dies, dass der Forscher ein langlebiges (PPersistenter) Token, im Vergleich zu einem kurzlebigen Token, der in einer Stunde abläuft. Seit März 2018 werden auf dem nur noch langlebige Token unterstützt ORCID Register; Ihr integriertes System oder der Benutzer können das Token jederzeit widerrufen.
Benutzer nach Land
Der letzte Abschnitt der Berichte enthält Informationen über die Forscher, die Ihre Integration genutzt haben, aufgeschlüsselt nach dem Land, von dem aus sie auf Ihre Integration zugegriffen haben. Diese Daten werden aus der IP-Adresse eines Forschers oder seinem geografischen Standort abgeleitet ID (von Google selbst anhand der IP-Adresse des Forschers ermittelt).
Probennahme
Weil so viele Forscher das verwenden ORCID Registry ist es nicht möglich, Berichte über den gesamten Datensatz der Forscher zu erstellen. Stattdessen werden die hier bereitgestellten Zahlen anhand von Trends aus einer Stichproben- und Nicht-Stichprobenmenge ermittelt. Die aus Stichprobendaten abgeleiteten Abschnitte des Berichts sind mit einem Sternchen gekennzeichnet, und die Stichprobengröße und der Platz werden auf der Registerkarte „Analytics-Daten“ angegeben. Die Zahlen im Google Analytics-Abschnitt des Berichts stimmen möglicherweise nicht vollständig mit den von Ihnen geführten lokalen Statistiken überein, und es kann zu geringfügigen Abweichungen bei der Zählung zwischen den Abschnitten des Berichts kommen.
Die unter „Integration Analytics“ aufgeführten Stichprobenparameter gelten für alle mit einem Sternchen gekennzeichneten Abschnitte. Der Prozentsatz der von den Analysedaten erfassten Sitzungen beträgt (Stichprobengröße)/(Stichprobenbereich) * 100 %. Weitere Informationen zur Probenahme finden Sie unter Google Entwickler.
Leere Berichte
Die Abschnitte „Benutzer“ und „Ereignisse“ des Berichts enthalten nur Daten des letzten Monats. Wenn im letzten Monat kein Forscher Ihre Integration genutzt hat, werden keine Daten zurückgegeben.
Fragen
Wenn Sie Fragen zu Ihren Mitgliedsberichten haben, wenden Sie sich bitte an uns kontaktiere uns.
Die ORCID Die Registrierung ist so konzipiert, dass Benutzer ihre IDs mithilfe von OAuth an Organisationen weitergeben können, wodurch sichergestellt wird, dass sie korrekt sind iD wird für jeden Forscher erhoben. Wir raten Organisationen davon ab, etwas hinzuzufügen ORCID iDs zu ihren Systemen basierend auf einer Suche nach Forschern nach Namen. Es kann jedoch hilfreich sein herauszufinden, wie viele Forscher es in Ihrer Organisation gibt ORCID iDs, die über die API erfolgen können. Nachfolgend finden Sie Vorschläge für die Suche nach Organisation.
Eine Einführung in die Suche, wie Sie ein Zugriffstoken erhalten, wie Sie Ihre Suchergebnisse verstehen und Einzelheiten zu anderen Feldern, die durchsucht werden können, finden Sie in unserem Durchsuchen des Registrierungs-API-Tutorials
Suche nach Name und DOI
Bei der Überprüfung, ob eine Person eine hat ORCID Wir empfehlen Ihnen, sowohl nach ihrem Namen als auch nach dem DOI eines oder mehrerer ihrer jüngsten Werke zu suchen. Das Ergebnis sollte nur der Eintrag des Forschers sein, nach dem Sie suchen, und nicht der Eintrag einer anderen Person mit demselben Namen.
Ein Beispielaufruf zur Suche nach allen Datensätzen mit dem Namen „Laurel Haak“ und entweder dem DOI 10.1087/20120404 oder dem DOI 10.6084/M9.FIGSHARE.1115124:
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search?q=family-name:Haak+AND+given-names:Laurel+AND+digital-object-ids:%2210.1087/20120404%22+OR+digital-object-ids:%2210.6084/M9.FIGSHARE.1115124’%22
Suche nach Zugehörigkeit
Die Zugehörigkeitsfelder können entweder nach dem Namen der Zugehörigkeit oder nach dem eindeutigen ROR der Organisation durchsucht werden ID oder GRID-ID. (Sie finden das GRID Ihrer Organisation ID in GRID oder Ihr ROR ID an der ROR-Registrierung)
Suche nach Organisationsnamen
Method: GET Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=affiliation-org-name:"University+of+Johannesburg"
Oder für eine exakte Übereinstimmung
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=affiliation-org-name:(%22Boston%20University%22)
Suche nach GRID-ID
Ein Beispielaufruf zur Suche nach allen Datensätzen mit dem GRID ID Grid.5509.9 (Universität Tampere):
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=grid-org-id:grid.5509.9
Suche nach ROR-ID
Ein Beispielaufruf zur Suche nach allen Datensätzen mit der ROR-ID 04fa4r544 (ORCID):
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=ror-org-id:"https://ror.org/04fa4r544"
Suche nach E-Mail-Domäne
Sie können die API verwenden, um nach Forschern anhand der E-Mail-Domäne zu suchen. Bedenken Sie, dass etwa 97 % der E-Mail-Adressen in ORCID sind privat und alle Datensätze mit einer privaten oder vertrauenswürdigen E-Mail-Adresse werden bei dieser Suche nicht zurückgegeben.
Ein Beispielaufruf zur Suche nach allen Datensätzen mit einem @orcid.org-E-Mail-Adresse:
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=email:*@orcid.org
Suchergebnisse werden im CSV-Format zurückgegeben
Suchergebnisse können auch im CSV-Format zurückgegeben werden. Im Rahmen des Aufrufs können Sie die Ausgabespalten aus einer Liste verfügbarer Felder unten angeben:
orcid
E-Mail
Vorname
Nachname
Vor- und Nachnamen
Kreditname
anderer Name
Name der aktuellen-Institution-Zugehörigkeit
Name der früheren-Institution-Zugehörigkeit
Mit Ihren Anmeldeinformationen müssen Sie den Header wie folgt angeben:text/csv'. Im Rahmen des Suchaufrufs müssen Sie der Abfrage auch die Felder hinzufügen, die Sie in der Ausgabe benötigen.
Suchen Sie nur mit Ihrem Browser
Sie können die Suche auch über Ihren Browser abschließen. Die URL ist auf die gleiche Weise aufgebaut, Sie müssen jedoch keine API-Anmeldeinformationen verwenden. Bitte beachten Sie, dass dies nur über die öffentliche API erfolgen kann.
Unten sehen Sie einen Beispielaufruf mit der öffentlichen API, bei der nach Organisationsnamen gesucht wird ORCID, Vornamen, Familiennamen, aktueller Institutionszugehörigkeitsname und früherer Institutionszugehörigkeitsname als gewünschte Ausgabe.
https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:ORCID&fl=orcid,given-names,family-name,current-institution-affiliation-name,past-institution-affiliation-name
Unten sehen Sie einen weiteren Beispielaufruf, bei dem die öffentliche API verwendet wird, um nach verschiedenen Variationen des Organisationsnamens zu suchen.
https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:("University of Plymouth" OR "Plymouth University")
Das eduPerson-Schema hat Folgendes hinzugefügt: eduPersonOrcid Attribut in seinem Februar 2016 Update.
Gemäß der eduPerson-Spezifikation:
RFC4512 definition
( 1.3.6.1.4.1.5923.1.1.1.16
NAME 'eduPersonOrcid'
DESC 'ORCID researcher identifiers belonging to the principal'
EQUALITY caseIgnoreMatch
SYNTAX '1.3.6.1.4.1.1466.115.121.1.15' )
Beachten Sie, dass das Format für dieses Feld das ist ORCID-bevorzugte URI-Darstellung der iD, Ie https://orcid.org/0000-0001-5727-2427.
Weitere Informationen zum Format des ORCID iD kann gefunden werden in Struktur der ORCID Kennzeichnung.
ORCID wurde gegründet auf der Prinzip dass Forscher die Kontrolle über ihre Informationen haben sollten. Um diesem Grundsatz gerecht zu werden, haben wir eine starke Datenschutz, das darauf ausgelegt ist, lokale Unterschiede in den Datenschutzbestimmungen zu berücksichtigen, und wir konzentrieren uns bei der Entwicklung von Richtlinien und Funktionen auf die Perspektive des Forschers.
Passend zu unserem Kernprinzip der Forscherkontrolle, ORCID Aufzeichnungen können nur von Forschern selbst erstellt werden ORCID Webseite.
Im Rahmen Ihres Integrationsworkflows können sich Ihre Forscher für ein neues registrieren ORCID iD oder melden Sie sich bei ihrem bestehenden Datensatz an, damit Sie ihre Authentifizierung abholen können ORCID Ausweis. Bitte sehen Sie sich unsere an API-Tutorials um mehr zu erfahren.
Wenn Sie glauben, dass die in Ihrem Bericht angezeigten Daten ungenau sind, dann bitte kontaktiere uns so detailliert wie möglich und unser Engagement-Team wird der Sache nachgehen.
Wenn Ihre Organisation eine ist ORCID Mitglied, dann müssen Sie sich an das wenden ORCID Wenden Sie sich an Ihre Organisation, die Ihnen Zugriff darauf gewähren kann ORCID Mitgliederportal. Wenn Sie Ihre Organisationen nicht identifizieren können ORCID Kontaktieren Sie dann bitte Ihren Konsortiumsleiter oder Ihren Engagement-Team-Vertreter.
Wir freuen uns über Feedback aus unserer Community. Teilen Sie uns daher bitte mit, wenn Sie Feedback zu den Mitgliedsberichten haben, indem Sie uns unter kontaktieren https://support.orcid.org/hc/en-us/requests/new
Die Daten, die zur Erstellung der Mitglieder- und Integrationsberichte verwendet werden, werden täglich aktualisiert.