Zum Hauptinhalt springen

.NET-SDK

Überblick​

Die Föderale IT-Kooperation (FITKO) stellt Entwickler:innen ein Software Development Kit (SDK) für die Anbindung von .NET-Anwendungen an FIT-Connect zur Verfügung. Das .NET-SDK ist eine .NET-Bibliothek (Klassenbibliothek) für die API von FIT-Connect.

.NET-Framework​

Das .NET-SDK basiert auf .NET und verwendet die Dotnet-Version .NET 6.0 (TargetFramework = net6.0). Mit .NET können Entwickler:innen Anwendungen entwickeln, die sowohl auf Windows-Rechnern ausgeführt werden können, als auch auf Mac- oder Linux-Rechnern.

Nuget-Paket​

Das .NET-SDK kann als Nuget-Paket in .NET-Projekte eingefügt werden. Das Nuget-Paket ist hier verfügbar.

Einfügen des Nuget-Pakets in Visual Studio 2022​

Zum Einfügen des SDKs klicken Sie im Projektmappen-Explorer auf das Projekt, dann im Kontextmenü auf "NuGet-Pakete verwalten...". Anschließend suchen Sie im Textfeld unter "Durchsuchen" nach "FitConnect". Die verfügbaren Versionen des SDKs werden angezeigt. Wählen Sie eine Version aus und klicken Sie auf die Schaltfläche "Installieren".

Einfügen des Nuget-Pakets in Visual Studio Code​

Zum Einfügen des SDKs klicken Sie in Visual Studio Code auf den Menüpunkt "Terminal", dann auf "New Terminal". Im Terminal fügen Sie den folgenden Befehl ein: dotnet add package FitConnect --version 1.0.0. In diesem Beispiel fügt Visual Studio Code die Version 1.0.0. des SDKs ein. Falls eine andere Version verfügbar ist und Sie diese Version verwenden wollen, dann ändern Sie die Versionsnummer im Befehl entsprechend ab, etwa dotnet add package FitConnect --version 0.9.1-beta.4.

GIT-Repository​

Als Alternative zum Nuget-Paket können Sie den Quellcode des .NET-SDKs verwenden, der in einem Git-Repository zur Verfügung steht. Dazu rufen Sie in der Konsole (Terminal) den Kommandozeilenbefehl: git clone https://git.fitko.de/fit-connect/sdk-dotnet.git auf.

Weitere Versionen des SDKs​

Zusätzlich zum .NET-SDK stellt die FITKO auch ein SDKs für Java und SDK für JavaScript zur Verfügung. Eine Übersicht zu den SDKs finden Sie hier.

Aufgabe des .NET-SDKs​

Das .NET-SDK bietet eine einfache Möglichkeit, ein .NET-Programm zu entwickeln, das über FIT-Connect Anträge (Einreichungen) an das zuständige Fachverfahren (Subscriber) sendet. Zudem können Sie mit dem .NET-SDK ein .NET-Programm entwickeln, das solche Anträge über FIT-Connect empfangen kann.

OpenSSL erforderlich für Mac OS​

Wenn Sie eine .NET-Anwendung entwickeln, die auf Mac-Rechner ausgeführt werden soll, dann müssen Sie Ihrem Projekt OpenSSL hinzufügen. Für Windows- und Linux-Rechner ist OpenSSL nicht erforderlich.
Für die Installation von OpenSSL auf Mac-Rechnern können Sie die Paketverwaltung Homebrew verwenden. Sollte Homebrew noch nicht auf Ihrem Mac-Rechner installiert sein, müssen Sie zunächst Homebrew installieren.

Homebrew installieren​

Sie installieren die Paketverwaltung Homebrew mit dem folgenden Befehl:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

OpenSSL installieren​

Sie installieren OpenSSL mit dem folgenden Befehl:

brew install OpenSSL

Pfad setzen​

Zudem muss bei Mac-Rechnern die Umgebungs-Variable DYLD_LIBRARY_PATH auf den Pfad zu OpenSSL verweisen. Dazu können Sie den folgenden Befehl verwenden, der den Pfad automatisch setzt:

export DYLD_LIBRARY_PATH=$(which OpenSSL)

Allgemeines​

Environments​

Für FIT-Connect stehen die folgenden Umgebungen zur Verfügung:

  • Test
  • Stage
  • Prod

Eine Beschreibung der Umgebungen finden Sie hier.

FIT-Connect-Umgebung auswählen​

Um auf eine Umgebung zuzugreifen, verwenden Sie in Ihrem Programm die Variablen "FitConnectEnvironment.Test", "FitConnectEnvironment.Stage" oder "FitConnectEnvironment.Prod", die im .NET-SDK bereits angelegt sind. Oder übergeben Sie in Methodenaufrufen einen eigenen Environment-Parameter.

Credentials (Zugangsdaten)​

FIT-Connect verwendet die Credentials "ClientId" und "ClientSecret".
Mit diesen Zugangsdaten erfragen Sie beim OAuth-Server ein Token, das Ihnen den Zugriff auf die FIT-Connect-Schnittstellen erlaubt (Submission API, Routing API, Self-Service API).

Credentials erhalten​

Sie erhalten die Credentials "ClientId" und "ClientSecret" im Self-Service-Portal (SSP) von FIT-Connect.
Das SSP erreichen Sie über die Startseite dieser Dokumentation: Wählen Sie rechts oben auf der Startseite bei "Self-Service-Portal" das SSP für die "Offentliche Testumgebung", die "Stage-Umbebung" oder für die "Produktivumgebung" aus. Legen Sie dann einen Client für einen Sender oder Subscriber an, und Sie erhalten unter "Zugangsdaten" die Credentials. Hier finden Sie eine ausführliche Beschreibung, wie Sie ClientId und ClientSecret erhalten.