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 (Öffentliche API); andere stehen nur zur Verfügung ORCID Mitgliedsorganisationen (API für Mitglieder und Premium-Mitglieder). Es steht jedem frei, jede unserer APIs auf unserem Sandbox-Testserver zu testen.
Bevor Sie beginnen
Wenn Sie mit Ihrer Integrationsplanung beginnen, sollten Sie Folgendes berücksichtigen:
- Was Sie damit machen möchten ORCID API – besuchen Sie bitte unsere Workflows.
- Ob Ihre Organisation ist schon ein ORCID Mitglied oder ist planen, einer zu werden. Nur ORCID Mitglieder können Elemente hinzufügen ORCID Records.
- Ob Sie ein System verwenden, das bereits unterstützt ORCID. Wenn ja, ist es möglicherweise so einfach, Ihr System so zu konfigurieren, dass es funktioniert ORCID.
- Wie Sie mit Ihren Forschern über die umgesetzten Änderungen kommunizieren, was Sie von ihnen erwarten, welche Vorteile sie für sie haben und was sie tun müssen. Besuchen Sie unser Outreach-Ressourcen Auf dieser Seite finden Sie Ideen zum Aufbau einer Kommunikationskampagne rund um Ihre neue Integration.
Registrieren Sie sich für Sandbox-Anmeldeinformationen und erstellen Sie einen Test ORCID iD
Wir verlangen von Ihnen, dass Sie zunächst Tools erstellen, die mit interagieren ORCID Sandkasten um zu verhindern, dass während des Tests Daten in der Produktionsregistrierung oder auf Ihren eigenen Systemen beeinträchtigt werden.
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-Mitglieds-API zum Lesen, Schreiben und Aktualisieren durchführen 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 ein Drittanbietersystem verwenden, das bereits unterstützt ORCID, müssen Sie sich möglicherweise nicht für Sandbox-API-Anmeldeinformationen registrieren.
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 Benachrichtigungs-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.
Bestimmen Sie die Benutzerberechtigungen, die Sie benötigen
Das ORCID Die Mitglieder-API kann zum Lesen, Hinzufügen oder Aktualisieren von Informationen zu einem Benutzer verwendet werden ORCID Aufzeichnung – Sie müssen lediglich die Erlaubnis Ihrer Forscher einholen. Die von Ihnen benötigten Bereiche haben großen Einfluss darauf, welche API am besten zu Ihrem System passt.
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.
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 Elementen in den Abschnitten Zugehörigkeit, Finanzierung, Werke und Forschungsressourcen sowie Peer-Review-Abschnitte eines verwendet 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 oder nach ORCID Aufzeichnungen. Dieser Bereich ist in der Member- oder Public-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 kein Premium-Mitglied sind, diese Funktion aber in der Developer's Sandbox testen möchten, wenden Sie sich bitte an uns Kontakt ORCID Gemeinschaft.
- In der Vergangenheit ORCID unterstützte andere Bereiche, die jetzt waren auslaufen.
- Du kannst herausfinden Welche Bereiche erforderlich sind, um bestimmte Abschnitte hier hinzuzufügen oder zu aktualisieren.
Stellen Sie sicher, dass Sie die Daten sicher speichern können
Es ist wichtig, dass Ihr System Informationen speichern kann auf sichere Weise.
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 zum Aktualisieren. Bewahren Sie es zusammen mit den Informationen des Forschers auf. Unsere Empfehlung ist, den vollständigen 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. Persistente Token sind etwa 20 Jahre lang gültig oder bis der Benutzer sie widerruft. Aktualisierungstoken können verwendet werden, um neue Zugriffstoken mit demselben oder eingeschränktem Geltungsbereich zu erstellen. Bewahren Sie die Token zusammen mit den Informationen des Forschers auf. Wir empfehlen Ihnen außerdem, das aufzubewahren Token-Bereich, und das,Token-Ablauf.
- Akzeptieren und speichern Codes eingeben (bei Aktualisierung ORCID Datensätze): Jedes Element, das Sie dem hinzufügen ORCID Die Registrierung wird von der mit einem Put-Code zurückgegeben ORCID API. Speichern Sie diesen Put-Code zusammen mit dem Artikel in Ihrem System. So können Sie erkennen, welcher Artikel gelesen oder aktualisiert werden muss.
- Interaktionen protokollieren: Ihr System sollte beide Anrufe aufzeichnen ORCID API und erhaltene Antworten. Das ist also notwendig ORCID kann helfen, wenn später ein Problem auftritt.
- Geben Sie Fehlermeldungen und einen Support-Kontakt an, wenn eine Interaktion nicht wie erwartet verläuft.
Melden Sie sich bei der ORCID Team, um zu demonstrieren, wie Ihre Anwendung funktioniert
Bevor Ihre Integration online gehen kann ORCID In der Produktionsregistrierung überprüft unser Engagement-Team noch einmal, ob alles, was Sie in der Sandbox erstellt haben, auch in der Produktion funktioniert. Wenn Sie ein System mit eingebautem verwenden ORCID Support kann dieser Schritt möglicherweise übersprungen werden.
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 wird eine Demo Ihrer Integration in überprüfen ORCID Sandkasten. Dies gibt uns die Möglichkeit, die großartigen Integrationen zu sehen, die Sie erstellt haben, Workflow-Verbesserungen anzubieten und zu überprüfen, ob alle Integrationen unseren Best Practices 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 zu demonstrieren. Dies gibt uns auch die Möglichkeit, mehr über die Funktionsweise Ihres Systems zu erfahren und wie Sie die Vorteile Ihres Systems erläutern ORCID Integration, damit wir Sie und Ihre Benutzer besser unterstützen können.
- 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 (empfohlen für ORCID-fähige Systeme, die eine Demonstration erfordern): Senden Sie eine Aufnahme oder eine Reihe von Screenshots mit Beschreibungen, die klar erklären und demonstrieren, wie Ihre Integration bei jedem Schritt funktioniert, einschließlich der Folgen, wenn ein Benutzer den Zugriff verweigert oder die Verbindung zu seiner iD trennt. Stellen Sie sicher, dass Sie zusätzliche Dokumentation bereitstellen, um alles zu überprüfen, was wir vom Benutzer aus nicht sehen können, z. B. die verwendete API-Version und die Art und Weise, wie Daten gespeichert werden.
Wenn Sie eines der verwenden ORCID-fähige Systeme, für die keine Demonstration erforderlich ist, können Sie direkt durchführen Fordern Sie API-Anmeldeinformationen für Produktionsmitglieder an. Geben Sie in den Notizen unbedingt an, welches System (und ggf. welche Version) Sie verwenden.
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.)
- Fügen Sie ein ORCID gebrandeter Button oder Link auf Ihrer Website, um die Authentifizierung der iD einzuleiten.
- Präsentieren Sie den OAuth-Autorisierungsbildschirm gemäß unserem Richtlinien
- 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.
Fordern Sie Anmeldeinformationen auf dem Produktionsserver an
Sie können Mitglieds-API-Anmeldeinformationen beantragen, sobald Ihre Integration von überprüft wurde ORCID Team oder wenn Sie ein Dienstanbietersystem verwenden, das über eine integrierte Funktion verfügt ORCID Integration.
Sie müssen das ausfüllen Formular zur Registrierung einer Kundenanwendung. Nachfolgend finden Sie einen kurzen Überblick über die angeforderten Felder:
Hinweise für ORCID Personal: Verwenden Sie dieses Feld zum Zulassen ORCID Erfahren Sie, ob Sie ein Anbietersystem verwenden, ob Integrationen überprüft wurden usw.
Kontakt Email-Adresse: Wir senden die Zugangsdaten an diese Adresse. Dies sollte der Kontakt sein, mit dem wir an der Integration gearbeitet haben, oder der technische Kontakt, den wir für Ihre Organisation haben.
Kontakt für den Erhalt der PIN für den Zugriff auf Anmeldeinformationen: Wir senden Ihnen die vollständigen Anmeldeinformationen auf sicherem Weg zu. Wir senden diesem Kontakt einen Passcode für den Zugriff auf Ihre API-Anmeldeinformationen. Dabei muss es sich um einen anderen Kontakt als den zuvor aufgeführten Kontakt handeln.
Kurze Beschreibung Ihrer Client-Anwendung: Dieser Text wird Ihren Integrationsbenutzern auf dem Autorisierungsbildschirm mit einem Fragezeichensymbol angezeigt. Eine kurze Beschreibung Ihrer Integration ist erforderlich.
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.
OAuth2-Umleitungs-URIs oder Rückruf-URLs für den Client: Zulässige URL(s) in Ihrer Webanwendung, zu der Benutzer zurückgeleitet werden, nachdem sie den Zugriff darauf autorisiert haben ORCID Daten aufzeichnen. Alle Umleitungs-URIs müssen HTTPS für Produktions-(Live-)Server-Clients sein.
Sobald Sie Ihre Anfrage gestellt haben, werden Ihnen in einem manuellen Prozess Anmeldeinformationen ausgestellt und Sie erhalten eine E-Mail an Ihren Kunden iD und Kundengeheimnis. Normalerweise werden diese Anfragen in weniger als 48 Stunden bearbeitet.
Übermitteln Sie Ihre Bewerbung an die ORCID Produktionsregister
Sobald Sie Ihre Anmeldeinformationen haben, können Sie es live schalten. Wenn Sie Ihre Integration testen möchten, bevor sie der Öffentlichkeit zugänglich gemacht wird, verwenden Sie bitte die eigene Version des Testers ORCID Aufzeichnung oder die eines Kollegen ORCID Rekord.
Starten Sie – und lassen Sie es alle wissen
Die Liveschaltung einer Anwendung ist nicht der letzte Schritt – Sie müssen weiterhin mit Ihren Benutzern kommunizieren, damit diese wissen, dass sie ihre Verbindung herstellen müssen ORCID iD schnell und einfach in Ihr System integrieren. Effektive Integrationen enthalten sowohl eine technische Komponente (die in diesem Leitfaden behandelt wird) als auch eine soziale Komponente. Forscher müssen darüber informiert werden, was ORCID Aus diesem Grund fordern Sie Zugriff auf sie an ORCID aufzeichnen und was Sie mit ihren Daten tun werden.
- Erstellen Sie einen Kommunikationszeitplan: Stellen Sie sicher, dass die Stakeholder davon Kenntnis haben ORCID Projekt rechtzeitig vor dem Start.
- Nutzen Sie eine Kombination aus Top-Down- und Bottom-Up-Kommunikation.
- Fördern Sie Ihre ORCID Integration häufig und für unterschiedliche Zielgruppen.
- Erstellen Sie lokale Ressourcen zur Unterstützung Ihrer Benutzer, z. B. FAQs, Libguides, Webseiten, Tutorials und Videos.
- Benennen Sie einen lokalen Ansprechpartner für ORCID-bezogene Fragen.
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.
- Ultraschall 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.