Für die Digitalisierung von Behördendienstleistungen sind elektronische Schnittstellen (APIs) besonders wichtig. Denn nur wenn die gesammelten Daten nicht in einem einsamen Silo landen, sondern mit anderen Behörden geteilt werden, setzen die gewünschten Effizienzpotenziale ein. Aus diesem Grund hat der Bundesrat in der "Digitalisierungsstrategie des Bundes 2020 – 2023" eine "API Architektur Bund" vorgesehen.

Diese behandelt neben allgemeinen Architekturprinzipien, Daten- und Applikationsarchitektur auch notwendige Fähigkeiten und Gestaltungs­empfehlungen zur Geschäftsarchitektur. Darin spielt die Dokumentation von Schnittstellen eine wichtige Rolle. Sie ist schlussendlich die Grundlage für Endnutzer und Implementierende, um mehr über eine API und deren Funktionsweise zu erfahren.

"Eine detaillierte und leicht verständliche Dokumentation führt zu einer höheren Akzeptanz und einem besseren Nutzererlebnis bei der Im­ple­men­tierung und der Anwendung der Schnittstelle", schreibt die Digitale Trans­for­mation und IKT-Lenkung (DTI). Dies zeige auch eine Umfrage von Smartbear, wonach eine gut verständliche Dokumentation wichtiger ist als etwa die Performance oder die Uptime. Noch wichtiger sei nur die Bedienbarkeit.

Representational State Transferful Application Programming Interfaces (RESTful-APIs) folgen den Grundsätzen und Beschränkungen der REST-Architektur. Sie wurden entwickelt, um die Kommunikation und den Daten­aus­tausch zwischen verschiedenen Softwaresystemen über das Internet zu erleichtern. Dafür hat der Bund jetzt Richtlinien für die Verwendung auf Github veröffentlicht.

Die Guidelines sollen dort ansetzen, wo die API-Architektur des Bundes aufhört, heisst es in der Einführung. Die Richtlinien sollen dabei helfen, die Behördendienste über alle elektronischen Mittel nutzbar zu machen. Zudem soll sichergestellt werden, dass die Schnittstellen leicht zu verstehen, allgemein gehalten, von spezifischen Implementierungen und Anwendungs­fällen abstrahiert, robust und einfach zu benutzen sowie mit anderen APIs konsistent sind.

Die Richtlinien basieren auf den "RESTful API and Event Guidelines" von Zalando. Sie wurden vom Bundesamt für Informatik und Telekommunikation (BIT) gemeinsam mit dem Bundesamt für Landestopografie Swisstopo, dem Informatik Service Center (ISC-EJPD) und dem Eidgenössischen Departement für auswärtige Angelegenheiten (EDA) erarbeitet.