Registrieren eines öffentlichen API-Clients

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.

ORCID unterstützt je nach verwendeter API unterschiedliche API-Nutzungskontingente und Ratenbegrenzungen. 

Fordert eine zweite sind die Anzahl der Anfragen, die pro Sekunde gestellt werden können. 

Bursts ist die Anzahl der Anfragen, die wir in die Warteschlange stellen, bevor wir sie ablehnen. Anfragen in der Warteschlange werden auf die Rate der Anfragen pro Sekunde verlangsamt. Wenn Sie den Burst überschreiten, erhalten Sie eine 503-Antwort. 

Bei Überschreiten des Nutzungskontingents werden weitere Anfragen innerhalb des angegebenen Zeitraums für Sie gesperrt. 

Bitte denken Sie daran, dass die ORCID Die öffentliche API ist für die nichtkommerzielle Nutzung durch Einzelpersonen kostenlos, wie in der Nutzungsbedingungen für öffentliche APIs. Mit „nicht kommerziell“ meinen wir, dass Sie für die öffentliche API keine Wiederverwendungsgebühren verlangen dürfen und dass Sie die öffentliche API nicht in Verbindung mit umsatzgenerierenden Produkten oder Dienstleistungen nutzen dürfen. 

Wenn Sie die öffentliche API mit Client-Anmeldeinformationen verwenden, kann Ihre Integration ein höheres Nutzungskontingent erreichen als die anonyme API. Bitte beachten Sie unsere Integrationsanleitung zur Registrierung eines öffentlichen API-Clients. 

Wenn Sie regelmäßig das API-Nutzungskontingent für die öffentliche API überschreiten, empfehlen wir Ihnen, ein ORCID Mitglied für den Zugang zu unserem Mitglieder-API. Sie erhalten damit nicht nur Zugriff auf eine höhere Ratenbegrenzung und ein uneingeschränktes Nutzungskontingent, sondern können auch auf Trusted Party-Daten zugreifen in ORCID Aufzeichnungen und Daten beitragen zu ORCID Datensätze aus Ihren institutionellen Systemen mit der Erlaubnis der Benutzer.