ORCID bietet eine öffentliche API, die Organisationen ermöglicht, die dies nicht tun ORCID Mitglieder können ihre Systeme und Anwendungen mit dem verbinden ORCID Registrierung mit Maschine-zu-Maschine-Kommunikation. Die API ist eine Restful-API und unterstützt sowohl XML als auch JSON.
Die öffentliche API kann für folgende Funktionen verwendet werden:
- Melden Sie sich mit bei Ihrem System an ORCID
- Sammeln Sie validierte Benutzer ORCID IDs
- Rufen Sie öffentliche Daten von einem Benutzer ab ORCID Rekord
- Öffentlich suchen ORCID Registrierungsdaten
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 APIs
- Klicken Sie auf „Registrieren für“. ORCID Schaltfläche „Öffentliche API-Anmeldeinformationen“.
Ausfüllen des Formulars mit den Bewerbungsdetails
- Sobald Sie sich für Ihre öffentlichen API-Anmeldeinformationen registriert haben, werden Sie zurück zu den Entwicklertools weitergeleitet (https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
- Sie müssen das Formular mit den Bewerbungsdetails ausfüllen, um eine neue Bewerbung zu registrieren.
- Name: Der Name Ihrer Anwendung. Dies wird den Benutzern angezeigt, wenn sie Ihrer Anwendung die Erlaubnis erteilen, ihre zu erhalten ORCID iD, und es wird in ihrem angezeigt Liste vertrauenswürdiger Organisationen. Wir empfehlen, den Namen Ihrer Organisation oder Ihres Dienstes zu verwenden (z. B. den Namen einer Zeitschrift).
- Anwendungs-URL: Die Website, die der Benutzer besuchen kann, um mehr über Ihre Anwendung zu erfahren. Dies wird auch in ihrem angezeigt Liste vertrauenswürdiger Organisationen.
- Anwendungsbeschreibung: Informationen über die Anwendung, die Sie entwickeln, und wie Sie die des Benutzers verwenden werden ORCID Ausweis. Dies wird den Benutzern auf dem OAuth-Bildschirm angezeigt.
Hinzufügen Umleitungs-URIs
Sobald der Benutzer Ihre Anwendung autorisiert hat, werden sie an einen von Ihnen angegebenen URI zurückgegeben. Sie müssen diese URIs im Voraus bereitstellen, da sonst bei Ihren Integrationsbenutzern ein Fehler auftritt.
- Geben Sie Ihren Weiterleitungs-URI in das dafür vorgesehene Feld ein
- Wenn Sie mehr als einen Umleitungs-URI eingeben müssen, klicken Sie auf „Weiteren Umleitungs-URI hinzufügen“.
Bitte beachte:
- Nur HTTPS-URIs werden in die Produktion übernommen
- Domains registriert MUST macht exakt mit den verwendeten Domains, inklusive Subdomains, übereinstimmen
- Registrieren Sie nach Möglichkeit alle Weiterleitungs-URIs vollständig. Dies ist die sicherste Option und wird von uns empfohlen. Weitere Informationen zu Weiterleitungs-URIs finden Sie in unserem FAQ zur Umleitungs-URI
Speichern Ihrer Bewerbung
Sobald Sie das Bewerbungsformular ausgefüllt und Ihre Weiterleitungs-URIs hinzugefügt haben, können Sie Ihre Bewerbung speichern.
- Klicken Sie auf „Meine Anwendung speichern und meine Client-ID und mein Geheimnis generieren“.
Sie werden zurück zur Entwicklertools-Seite weitergeleitet, die nun Ihre Anmeldeinformationen für den öffentlichen API-Client enthält
Aktualisieren Ihrer Anmeldeinformationen
Eine Änderung Ihrer Bewerbungsinformationen ist sehr einfach.
- Bearbeiten Sie die relevanten Informationen und klicken Sie dann auf „Antrag speichern“.
Nutzen Sie Ihre Anmeldedaten
Da Sie nun über Ihre Anmeldeinformationen verfügen, ist es an der Zeit, mit der Nutzung zu beginnen ORCID Öffentliche API!
Bitte beachten Sie, dass wir Ihre Zugangsdaten an die Mitglieder-API übertragen können, wenn Sie Mitglied werden ORCID Mitglied in der Zukunft.
Durchsuchen Sie unsere API-Benutzergruppe Weitere Informationen zum Einrichten einer Integration mit der öffentlichen API finden Sie in den Themen. Um jedoch die Vorteile zu maximieren ORCID, wir empfehlen euch join ORCID als Organisationsmitglied, das Zugang zu zusätzlichen Funktionen bietet, persönliche Unterstützung durch unser Integrationsteam bietet und natürlich unsere Arbeit unterstützt.