Zum Hauptinhalt springen

Überblick

FIT-Connect 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​

Das .NET-SDK unterstützt .NET 10. 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 auf der Seite FIT-Connect .NET SDK verfügbar.

::: Hinweis: Bitte verwenden Sie ausschließlich die offiziell von FIT-Connect bereitgestellten Download-Links für die SDKs und zugehörigen Artefakte.:::

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/meta-sdk-dotnet.git auf.

Weitere Versionen des SDKs​

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

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 Verwaltungssystem (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-Rechnern 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 Umgebungsvariable 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=$(brew --prefix openssl)/lib

Allgemeines​

Environments​

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

  • TEST
  • STAGE
  • PROD
  • LOCAL (Entwicklung auf localhost, http://127.0.0.1:8080)
  • CI (Continuous Integration mit Docker, http://docker:8080)

Hinweis: LOCAL und CI sind interne Entwicklungsumgebungen. Bei Angabe eines unbekannten EnvironmentTag-Werts wird automatisch auf LOCAL zurückgegriffen.

Eine Beschreibung der Umgebungen finden Sie auf der Seite Betriebs-Umgebungen der FIT-Connect-Infrastruktur.

FIT-Connect-Umgebung auswählen​

Die gewünschte Umgebung wird über den Konfigurationswert FitConnect:EnvironmentTag in der appsettings.json gesetzt. Gültige Werte sind TEST, STAGE, PROD, LOCAL und CI. Bei Angabe eines unbekannten Wertes wird standardmäßig LOCAL verwendet.

Einbindung via Dependency Injection​

Das SDK wird über Microsoft.Extensions.DependencyInjection in Ihre Anwendung eingebunden. Die Konfiguration erfolgt über appsettings.json (oder jede andere IConfiguration-Quelle) — eine separate YAML-Konfigurationsdatei ist nicht mehr erforderlich.

Minimales Setup​

using Fitko.FitConnect.Sdk.Client;
using Fitko.FitConnect.Sdk.DependencyInjection;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;

var configuration = new ConfigurationBuilder()
    .AddJsonFile("appsettings.json")
    .Build();

var client = new ServiceCollection()
    .AddSingleton<IConfiguration>(configuration)
    .AddFitConnect()                  // bindet die Sektion "FitConnect" aus appsettings.json
    .BuildServiceProvider()
    .GetRequiredService<IFitConnectClient>();

In ASP.NET Core- oder Generic-Host-Anwendungen reicht es, AddFitConnect() in Program.cs aufzurufen und IFitConnectClient per Konstruktor-Injektion zu beziehen:

// Program.cs
builder.Services.AddFitConnect();

// MyService.cs
public class MyService(IFitConnectClient fitConnect) { ... }

Programmatische Konfiguration (ohne Konfigurationsdatei)​

var client = new ServiceCollection()
    .AddFitConnect(cfg =>
    {
        cfg.EnvironmentTag = "TEST";
        cfg.Sender = new SenderConfig { ClientId = "...", ClientSecret = "..." };
    })
    .BuildServiceProvider()
    .GetRequiredService<IFitConnectClient>();

Eine vollständige Beschreibung aller Konfigurationsoptionen finden Sie auf der Seite Konfiguration.