Zum Hauptinhalt springen

SDK-Setup

Veraltet ab Release FitConnect v4.0.0 – gilt für alle vorherigen Versionen.​

Ü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. Es bietet 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.

.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 installieren​

Das FitConnect-Paket ist auf nuget.org verfügbar.

Über die IDE-Paketverwaltung: Suchen Sie in der NuGet-Paket­verwaltung nach "FitConnect" und installieren Sie die gewünschte Version.

Über die Befehlszeile:

dotnet add package FitConnect --version 1.0.0

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 auf der Seite SDKs - Übersicht.

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 auf der Seite Betriebs-Umgebungen der FIT-Connect-Infrastruktur.

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, Destination 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 "Öffentliche Test-Umgebung", die "Stage-Umgebung" oder für die "Produktiv-Umgebung" aus. Legen Sie dann einen Client für einen Sender oder Subscriber an, und Sie erhalten unter "Zugangsdaten" die Credentials. Auf der Seite Accountregistrierung und Client-Verwaltung finden Sie eine ausführliche Beschreibung, wie Sie Client-ID und Client-Secret erhalten.

Optionale Konfiguration​

URN Schema​

Um Fachdaten nach einem Schema mit einer URI beginnend mit urn: zu validieren, muss das entsprechende Schema dem SDK bekannt gemacht werden. Dazu muss zum einen das Schema in das Schema-Verzeichnis kopiert werden und dann in der Konfiguration registriert werden.

FitConnect.ClientSettings.SchemaStoragePath = "<PATH_TO_SCHEMAS>";
FitConnect.ClientSettings.AddUrnSchema("urn:simple:schema", "simpleSchema.json");

Damit können Sender und Empfänger das Schema finden und gegen dieses Validieren.

Wird der SchemaStoragePath nicht angegeben, dann sucht das SDK im Verzeichnis ./schema zur Laufzeit nach den Schemata.