Elektronische Schnittstelle
Elektronische Schnittstellen, in der Fachsprache als Application programming interface (API) bezeichnet, sind zentral für die Vernetzung von isolierten Systemen. Die I14Y-Interoperabilitätsplattform ist das zentrale Verzeichnis der APIs der Schweizer Behörden.
Was ist eine API?
Ein so genanntes Application Programming Interface (API) ist eine technische Schnittstelle. Dank dieser können Software-Anwendungen miteinander kommunizieren und Daten austauschen. Und dies, ohne dass sie direkt miteinander verknüpft werden müssen. Dank APIs können Entwickler etwa Kernfunktionen des Betriebssystems benutzen, ohne diese selber schreiben zu müssen. Webserver beziehen über solche Schnittstellen die Daten vom Backend oder sogar von fremden Systemen, die sie dann anzeigen. Und Fachanwendungen holen stets aktualisierte Auswahllisten. APIs sind in der modernen Software-Entwicklung unabdinglich.Die Beschreibungen zu elektronischen Schnittstellen lassen sich bequem über die Weboberfläche der I14Y-Interoperabilitätsplattform erfassen. Loggen Sie sich dazu ein, klicken Sie auf die Kachel “Katalog pflegen” und wählen Sie unter “Erstellen” den Eintrag “Neue API erstellen”.
Nun öffnet sich die Eingabemaske für APIs. Setzen Sie einen Titel in mindestens einer Sprache. Tragen Sie zudem eine Beschreibung Ihres Datenangebots ein. Zwingend nötig sind ausserdem Angaben dazu, wer die elektronische Schnittstelle verantwortet (Herausgeber). Wählen Sie dabei aus den Ihnen zugeordneten Organisationen die richtige aus. Sollte die Organisation nicht aufgeführt sein, wenden Sie sich ans I14Y-Team.
Geben Sie unter Zugriffsrechte an, ob die API öffentlich ist, unter bestimmten Bedingungen genutzt werden kann oder aber nicht öffentlich verfügbar ist. Ergänzen Sie die zur Verfügung stehenden Endpunkte Ihrer API. Oder setzen Sie unter Endpunkte-Beschreibung einen Link auf die Online-Dokumentation (zum Beispiel eine Swagger-Oberfläche).
Zusätzlich zu diesen Pflichtfeldern, wie sie auch vom DCAT-Standard weitgehend vorgeschrieben sind, gibt es zahlreiche weitere Möglichkeiten, mit denen Sie Ihr Datenangebot beschreiben und damit einfach auffindbar machen können. Bei dem meisten handelt es sich um optionale Felder aus DCAT. Einzelne Felder sind plattformspezifisch. In Anhang dieses Handbuchs finden Sie detaillierte Informationen zu den einzelnen Eingabefelder.
Auf der I14Y-Interoperabilitätsplattform werden vorab APIs dokumentiert, über die Daten abgefragt werden können. In der Regel liegen diese als Datensammlung vor, etwa gespeichert in einer Datenbank. Oftmals besteht also eine direkte Verbindung zwischen einer elektronischen Schnittstelle und einer Datensammlung. Deshalb lasse sich die Beschreibungen dieser Inhalte auf der I14Y-Interoperabilitätsplattform verknüpfen. Elektronische Schnittstellen sollten, wenn immer möglich, mit Datensammlungen verknüpft werden. Fügen Sie dazu unter Liefert Datensammlung den entsprechenden Eintrag hinzu. Bei einem Klick auf das Plus-Symbol öffnet sich eine Auswahl. Suchen Sie in diesem Formular die bereits erfasste Datensammlung und erstellen Sie die Verknüpfung. Falls die Datensammlung noch nicht erfasst wurde, kann der Schritt später nachgeholt werden.
Sobald alle gewünschten Informationen erfasst sind, klicken Sie auf “Speichern und schliessen”. Der neue Eintrag ist nun an Ende der Liste zu finden. Zudem ist er über die Suchfunktion auffindbar. Er hat nun den Status “Inital” und ist innerhalb der Organisation sichtbar, nicht aber öffentlich. Der Einträg lässt sich für die weitere Bearbeitung wieder öffnen.
Um den Eintrag den lokalen Datenverantwortlichen zur Prüfung vorzulegen, klicken Sie auf “Registrierungsstatus vorschlagen” und wählen Sie “Kandidat” aus. Weitere Informationen zum Arbeitsablauf sind im Kapitel Rollen und Prozesse zu finden.