In diesem Interview Rob Peters, ORCID's Direktor für Technologie stellt vor ORCID's neue API – gestartet am 14. Februar 2017
Bevor wir über die neue API sprechen, können Sie uns etwas darüber erzählen ORCID's technisches Team und Ihre Rolle als Direktor?
Auf den ersten Blick die ORCID Das Team sieht wie jedes andere technische Team aus. Wir haben fünf Entwickler, einen Serveradministrator, einen Qualitätssicherungsanalysten und natürlich einen Manager (ich). Was jedoch interessant wird, sind unsere unterschiedlichen geografischen, kulturellen und beruflichen Hintergründe. Drei von uns sind in den USA ansässig, drei in Costa Rica und zwei im Vereinigten Königreich, sodass wir geografisch viele Perspektiven haben. Darüber hinaus kommen einige von uns aus der klassischen Softwareberatung, andere kommen aus der Verlagsbranche, „Silicon Valley“-Startups und der Bibliothekswissenschaft.
Meine persönliche Rolle als Director of Technology besteht darin, die tägliche Softwareentwicklung zu verwalten. Das läuft darauf hinaus, meinem Team bei der Kommunikation untereinander und mit dem Rest der Organisation zu helfen und zu verwalten, welche Aufgaben das Team übernimmt (und welche aufgeschoben werden). Außerdem habe ich die Möglichkeit, viel Einfluss auf übergeordnete strategische Entscheidungen zu nehmen ORCID macht.
Übergang zur API-Version 2.0 – warum tun wir – ORCIDSowie das ORCID Community – benötigen Sie dieses Upgrade?
Der Erste ORCID API, das im Oktober 2012 eingeführt wurde, basierte zwangsläufig auf vielen Annahmen, die sich später als falsch erwiesen und/oder einer Verfeinerung bedurften. Um der Forschungsgemeinschaft besser dienen zu können, müssen wir diese Annahmen kontinuierlich überprüfen. Die Nutzung von Feedback, das Stellen von Fragen und die Betrachtung von Beweisen, die vor unserer Einführung nicht verfügbar waren, haben uns neue Einblicke in die Funktionsweise gegeben ORCID API sollte und sollte nicht sein. Wie Sie meiner Antwort auf die nächste Frage entnehmen können, stellt Version 2.0 einen großen Bruch mit den Annahmen dar, auf denen 1.0 aufbaute, ist aber dennoch pragmatisch genug, um Kontinuität zwischen den beiden APIs zu gewährleisten.
Was sind die Hauptunterschiede zwischen 1.2 und 2.0 und welche Vorteile werden sie den Mitgliedern bieten?
Bei der Entwicklung von 2.0 wollten wir sowohl die Hindernisse beseitigen, auf die Mitglieder mit 1.2 gestoßen sind, als auch neue Funktionen einführen, von denen wir wissen, dass die Community sie wünscht.
Neben der Behebung bekannter Probleme wie der Skalierbarkeit bei der Verwaltung von Hyper-Authoring-Publikationen und Herausforderungen mit implizitem Verhalten, die bei den Mitgliedern Verwirrung stifteten, haben wir auch neue Funktionen zur Unterstützung der Peer-Review-Erkennung, verbesserte Benachrichtigungen für Benutzer und die Möglichkeit dazu hinzugefügt Unterstützen Sie fast alle persistente Kennung.
Um zu erklären, warum einige dieser Änderungen erforderlich waren, werde ich etwas technischer vorgehen. Bevor wir uns daran machten, eine einzige neue Zeile zu programmieren, erstellten wir eine Liste der Dinge, die wir verbessern wollten, mit dem folgenden „Manifest“:
- Hör auf, darüber nachzudenken ORCID als monolithisches (großes einzelnes) Dokument aufzeichnen. Mehrere Institutionen schreiben an eine ORCID Datensatz bedeutet, dass der Datensatz erkannt wird mandantenfähig. Darüber hinaus produzieren Forscher oft so große Forschungsmengen, dass selbst Zusammenfassungen davon nicht in ein monolithisches Dokument passen.
- Vereinfachte Bereiche. Die Granularität der Berechtigungsbereiche in der 1.0-API ist für alle Beteiligten überwältigend; Ihre Vereinfachung wird das Leben für Entwickler und Benutzer gleichermaßen erleichtern.
- Explicit RESTful Verhalten. Implizites Verhalten ist für Implementierer schlecht, da es zu unerwartetem Verhalten führt, das wiederum Endbenutzer verwirrt. Durch die Verwendung von RESTful-Verhalten vermeidet unsere neue API diese Probleme.
- Kürzeste sinnvolle URLs. Ein gutes Beispiel wäre /works/1234 ist besser als /orcid-Werke/1234.
- Bei Listenaufrufen werden nur Zusammenfassungen zurückgegeben. Um den Aufruf eines Datensatzes zu beschleunigen, gibt API 2.0 nur Zusammenfassungen für Listen zurück. Für alle Informationen über einen Forscher einen einzigen Aufruf durchzuführen, funktioniert bei Artikeln mit vielen Autoren, bei denen es Dutzende, Hunderte oder sogar Tausende von Autoren gibt, nicht.
- Allgemeine Namen und Strukturen für gemeinsame Elemente. Mit 2.0 können wir sicherstellen, dass gemeinsame Elemente im XML/JSON dieselben Namen haben.
- Fehlercodes. Wir fügen jetzt Fehlercodes in den Antworttext ein, wenn der Fehler nicht vollständig durch einen Standard-HTTP-Code beschrieben wird.
Und was sind die Vorteile für Anwender?
Letztendlich sollte eine API für Benutzer nahtlos sein. Unerwartetes 1.0-Verhalten entsteht und beeinträchtigt die Benutzererfahrung, während es gleichzeitig die Entwickler frustriert, die die API implementieren. Auf praktischer Ebene ermöglicht die neue API die Optimierung jedes Abschnitts im ORCID Aufzeichnen, um die Anwendung der Sichtbarkeitseinstellungen, der Quelle und des Erstellungsdatums für Elemente in jedem Abschnitt konsistent bereitzustellen.
Wird sich dies auch auf die öffentliche API auswirken? Wie?
Ja. Änderungen an der Member API und der Public API erfolgen immer im Gleichschritt. Obwohl wir die Unterstützung unserer Mitglieder schätzen und auf sie angewiesen sind, fühlen wir uns auch unserer größeren Vision „einer Welt verpflichtet, in der alle, die sich an Forschung, Wissenschaft und Innovation beteiligen, eindeutig identifiziert und mit ihren Beiträgen über Disziplinen, Grenzen und Zeit hinweg verbunden sind.“ Wir sehen in der Public API ein Mittel, dieses Ziel zu erreichen.
Was werden Ihrer Meinung nach die größten Herausforderungen bei der Einführung der neuen Version sein und welche Unterstützung wird es geben? ORCID bereitstellen?
Das schwierigste Problem besteht darin, Ressourcen für die Arbeit bereitzustellen mehr Stunden. Bei einigen Organisationen kann es nur ein paar Tage dauern, bei anderen kann es einen ganzen Monat dauern. Scheuen Sie sich unabhängig vom Zeitrahmen nicht davor, Kontakt aufzunehmen und um Hilfe zu bitten, auch wenn es sich um ein kleines Detail handelt, das Ihren Fortschritt behindert. Vollständige Dokumentation ist ab sofort für Mitglieder verfügbar.orcid.org und ORCID Mitgliedsorganisationen können dies auch kontaktieren Sie uns. Veröffentlichung im API-Benutzerforum Es kann nützlich sein, Kommentare aus der ganzen Welt einzubringen ORCID Gemeinschaft. Ich bin außerdem fest davon überzeugt, dass ich direkt erreichbar sein muss, also fühlen Sie sich wohl mailen Sie mir direkt.
Wer nutzt derzeit API 2.0 und welches Feedback haben sie gegeben?
Wir geben uns viel Mühe, Release-Kandidaten zur Verfügung zu stellen, um Feedback zu erhalten. CrossRef, Datacite, CERN und PTCRIS sind nur einige davon ORCID Mitglieder, die einen Release Candidate implementiert und Feedback gegeben haben. Darüber hinaus haben mehrere Organisationen die Peer-Review-Funktionalität mit 2.0 implementiert, darunter Early Adopters, die American Geophysical Union, F1000 und Publons. Zu den Rückmeldungen gehörten die üblichen „Technikfreaks“-Vorschläge, etwa zur Verwendung von Namen im Schema, zur Benennung von Endpunkten oder zu Debatten über Effizienz. Solche Details können große Auswirkungen auf die Mitglieder haben. Allerdings geben die Implementierer von Release-Kandidaten auch Feedback aus der Perspektive des Forschers, was für uns von unschätzbarem Wert ist.
Wie lange wird ORCID weiterhin die alte API unterstützen?
Wir streben den Sonnenuntergang 1.2 Ende 2017 an. Unabhängig vom Sonnenuntergangsdatum, wenn Sie damit einverstanden sind ORCIDMission von und kümmern sich darum, dass Forscher mit ihnen interagieren ORCID Sie möchten jetzt auf 2.0 umsteigen.
Gibt es sonst noch etwas, was wir über diese Änderung wissen sollten?
Wir hoffen, dass sich Version 2.0 als langlebig erweist und wir uns auf andere Teile konzentrieren können ORCID Technologie-Stack für eine Weile!
Eine unterhaltsame und praktische Zusammenfassung der API 2.0-Funktionen finden Sie hier Rutsche Deck!