Zum Hauptinhalt springen

SDKs für FIT-Connect

Diese Seite gibt einen Überblick über die Software Development Kits (SDKs), die Entwickler:innen nutzen können, um sendende und empfangende Systeme schneller, effizienter und einfacher an FIT-Connect anzubinden.

Was sind SDKs?​

Die SDKs für FIT-Connect sind Software-Bibliotheken, die Entwickler:innen einen vereinfachten Zugang auf die Funktionen von FIT-Connect ermöglichen. Folgende SDKs stehen zur Verfügung:

  • SDK für .NET
  • SDK für Java
  • SDK für JavaScript

Vorteile durch SDKs​

Mit den SDKs für FIT-Connect entfällt für Softwareentwickler:innen die Notwendigkeit, die gesamte Funktionalität eigenständig zu implementieren, um über FIT-Connect Nachrichten (Einreichungen) an einen Empfänger – etwa ein Verwaltungssystem – zu senden oder um solche Nachrichten zu empfangen.

Zudem müssen zum Beispiel die Entwickler:innen von sendenden Systemen nicht selbst die Metadaten zu den Einreichungen erstellen und verschlüsseln (und empfangende System müssen nicht selbst diese Metadaten entschlüsseln und prüfen). Stattdessen binden Entwickler:innen das SDK ein und rufen dessen Funktionen in ihrer eigenen Software auf.

Das SDK kapselt die RestAPI von FIT-Connect und kümmert sich intern um viele sicherheitsrelevante und notwendige Aufgaben, die sonst von der nutzenden Software erledigt werden müssten.

SDKs für verschiedene Programmiersprachen​

Die SDKs für den Zugriff auf FIT-Connect werden in den Programmiersprachen Java, C# und JavaScript angeboten, sodass viele Entwickler:innen in ihrer gewohnten Entwicklungsumgebung mit der bevorzugten Programmiersprache arbeiten können.

JavaScript-SDK für Onlinedienste​

Das JavaScript-SDK unterstützt Software-Entwickler:innen bei der Anbindung eines Onlinedienstes an FIT-Connect. Unter einem "Onlinedienst" wird hier eine Webseite oder App verstanden, die es den Anwender:innen erlaubt, Einreichungen (Submissions) über FIT-Connect an ein Verwaltungssystem zu senden.

Software-Entwickler:innen, die einen solchen Onlinedienst erstellen, können das JavaScript-SDK verwenden, um zum Beispiel die zu sendenden Anträge zu verschlüsseln.

Das JavaScript-SDK alleine kann keine Einreichungen an FIT-Connect senden. Hierzu ist zusätzlich eine Backend-Applikation auf einem Server nötig. Zur Implementierung des Backends kann das Java-SDK oder das .NET-SDK verwendet werden.

Sonderstellung des JavaScript-SDKs​

Ein entscheidender Vorteil des JavaScript-SDKs ist die Möglichkeit, die Antragsdaten bereits im Browser der beantragenden Person zu verschlüsseln. Wird hingegen nur das .NET-SDK (oder nur das Java-SDK) verwendet, können die Antragsdaten erst im Backend verschlüsselt werden.

Sequenzdiagramm: JavaScript-SDK und Backend​

Das folgende Diagramm verdeutlicht den Ablauf einer Submission (Einreichung) von einer Webseite oder App:

Das JavaScript-SDK wird genutzt, um eine Einreichung zu verschlüsseln. Anschließend sendet der Onlinedienst (Webseite oder App) die verschlüsselte Einreichung über ein Backend an FIT-Connect. Das adressierte Verwaltungssystem holt anschließend die Einreichung von FIT-Connect ab (im Diagramm nicht dargestellt). Der Onlinedienst sendet Anfragen zum Status einer Einreichung über das Backend an FIT-Connect.

Onlinedienste und Verwaltungssysteme​

Sie können mit dem .NET- und dem Java-SDK sowohl Onlinedienste als auch Verwaltungssysteme implementieren. Die SDKs erleichtern Entwickler:innen den Zugriff auf die Dienste, die die FITKO bereitstellt, etwa den Zugriff auf den Zustelldienst oder auf den Routingdienst.

Wenn Sie ein SDK für den Zugriff auf diese Dienste einsetzen, rufen Sie nicht selbst die Schnittstellen (WebAPIs) der Dienste in Ihrem Programmcode auf, sondern erzeugen stattdessen Objekte (Sender, Subscriber) und rufen an diesen Objekten Methoden auf. Diese Methoden führen intern alle erforderlichen Aufrufe der Dienste durch. Darüber hinaus prüfen die Methoden auch die Werte, die von den aufgerufenen Diensten zurückgeliefert werden.

Dies entlastet Entwickler:innen von vielen Details rund um den Aufruf von Diensten.

Voraussetzungen für den Zugang zu FIT-Connect​

Für den Zugang zu FIT-Connect ist es erforderlich, dass Sie für sendende Systeme (zum Beispiel für einen Onlinedienst) Zugangsdaten des Typs "Onlinedienst" anlegen. Für empfangende Systeme (Verwaltungssysteme) müssen Sie Zugangsdaten des Typs "Verwaltungssystem" und einen Zustellpunkt anlegen.

Beide Voraussetzungen müssen für den Zugang zu FIT-Connect erfüllt sein. Und zwar unabhängig davon, ob Sie ein SDK verwenden oder nicht.

Verfügbarkeit der SDKs​

FIT-Connect entwickelt und pflegt die SDKs. Den aktuellen Stand der Verfügbarkeit entnehmen Sie den einzelnen Changelog-Seiten der SDK-Dokumentationen.

Lizenz und rechtliche Hinweise​

Der Quellcode ist lizenziert unter EUPL.

Dieses Software Development Kit (SDK) ist dazu bestimmt, die Anbindung einer Software an die FIT-Connect-Infrastruktur zu ermöglichen. Hierfür kann das SDK in die anzubindenden Software integriert werden. Erfolgt die Integration des SDK in unveränderter Form, liegt keine Bearbeitung im Sinne der EUPL bzw. des deutschen Urheberrechts vor. Die Art und Weise der Verlinkung des SDK führt insbesondere nicht zur Schaffung eines abgeleiteten Werkes. Die unveränderte Übernahme des SDK in eine anzubindende Software führt damit nicht dazu, dass die anzubindende Software unter den Bedingungen der EUPL zu lizenzieren ist. Für die Weitergabe des SDK selbst - in unveränderter oder bearbeiteter Form, als Quellcode oder ausführbares Programm - gelten die Lizenzbedingungen der EUPL in unveränderter Weise.