Beginnen Sie mit Ihrer Integration

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.

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.

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.

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:

1. 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. 
2. 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.
3. 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

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

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.