FIT-Connect .NET SDK

Für ein kurzes Beispiel zu Implementierung kann der DemoRunner herangezogen werden.

!! IN DEVELOPMENT NOT FOR PRODUCTION USE !!

FIT-Connect .NET SDK ist eine .NET library for the FIT-Connect API.

Das SDK ist als NuGet Package verfügbar.

Einleitung

Das FIT-Connect .NET SDK bietet eine einfache Möglichkeit, sowohl einen Antragsteller (Sender) als auch einen Antragsempfänger (Subscriber) an FIT-Connect anzubinden.

Voraussetzungen

OSX

Auf OSX wird das SDK nur dann unterstützt, wenn OpenSSL auf dem System installiert ist. Zum Installieren von OpenSSL können Sie Homebrew verwenden:

brew install openssl@1.1

Die Environment-Variable DYLD_LIBRARY_PATH muss auf den Pfad zu OpenSSL verweisen.

Beispiele:

export DYLD_LIBRARY_PATH=/usr/local/opt/openssl/lib
export DYLD_LIBRARY_PATH=/usr/local/opt/openssl@1.1/lib

Weitere Informationen zu FIT-Connect finden Sie hier:

• SDK-Dokumentation
• FIT-Connect Dokumentation
• FIT-Connect Dokumentation

Allgemeines

Environment

Das FIT-Connect SDK kann an die folgenden Umgebungen angeschlossen werden:

• Testing: FitConnectEnvironment.Testing
• Staging: FitConnectEnvironment.Staging
• Production: FitConnectEnvironment.Production

FIT Connect Umgebungen

Hierfür muss der Client die Environment auswählen oder einen eigenen Environment-Parameter übergeben.

Credentials

ClientId und ClientSecret sind die Grundlage, um einen Token vom OAuth-Server abfragen zu können. Die beiden Werte sind im Self-Service Portal der Testumgebung von FIT-Connect zu erstellen.

Sender

Um einen Antrag mit dem SDK versenden zu können, werden eine ClientID und ein ClientSecret benötigt. Hier ist beschrieben, wie Sie eine ClientID und ein ClientSecret erhalten.

Offizelle Dokumentation von FIT-Connect zum Versenden von Einreichungen (Anträgen)

Beispiel

Das folgende Beispiel zeigt, wie Sie das SDK in einem sendenden System nutzen, um eine Submission (eine Einreichung) zu erzeugen und zu senden:

var submission = SubmissionBuilder
            .WithDestination(destinationId)
            .WithServiceType("FIT Connect Demo", leikaKey)
            .WithAttachments(new Attachment("Test.pdf", "Test Attachment"))
            .WithData("{\"message\":\"Hello World\"}")
            .Build(); 

await Client.GetSender(FitConnectEnvironment.Testing, clientId, clientSecret, logger).SendAsync(submission);

Im Beispiel oben stellt das Argument "FitConnectEnvironment.Testing" die FIT-Connect-Endpunkte zur Verfügung, die aufgerufen werden sollen. Das Argument 'destinationId" enthält die eindeutige Adresse des empfangenden Systems (Fachverfahrens), das die Antragsdaten über FIT-Connect erhalten soll. Das Argument "leikaKey" stellt die ID der beantragten Leistung bereit. "Leika" ist die Abkürzung für "Leistungskatalog".

Um async/await Aufrufe zu umgehen kann auch mit .Result gearbeitet werden.

var submission = SubmissionBuilder
            .WithDestination(destinationId)
            .WithServiceType("FIT Connect Demo", leikaKey)
            .WithAttachments(new Attachment("Test.pdf", "Test Attachment"))
            .WithData("{\"message\":\"Hello World\"}")
            .Build(); 

Client.GetSender(FitConnectEnvironment.Testing, clientId, clientSecret, logger).SendAsync(submission).Result;

Details

flowchart LR
    start([SubmissionBuilder])
    destination(WithDestination)
    service(WithServiceType)
    attachments(WithAttachments)
    data(WithData)
    build([Build])
    
    sender([GetSender])
    sendAsync([SendAsync])
    
    start-->destination-->service-->attachments-->data-->build
    
    sender-->sendAsync
    

Das SDK verhindert durch die FluentAPI, dass die Methoden in der falschen Reihenfolge aufgerufen werden können.

SubmissionBuilder

Der SubmissionBuilder ist für die Erstellung einer Submission zuständig. Das Senden der Submission an FIT-Connect übernimmt dann der Sender. Nachfolgend werden die einzelnen Methoden des SubmissionBuilders erklärt.

.WithDestination(destinationId)

Die destinationId des Zustellpunktes, an den die Submission geschickt werden soll, muss an dieser Stelle übergeben werden.

Noch nicht vollständig getestet!
Eine Möglichkeit, die Destination ID zu ermitteln, geht über die Methode FindDestinationId() des Senders.

.WithServiceType("FIT Connect Demo", leikaKey)

Der Service Type muss an dieser Stelle übergeben werden. Hierfür wird ein Leistungsschlüssel (LeiKa-Schlüssel) benötigt. Leistungsschlüssel haben diese Form urn:de:fim:leika:leistung:99400048079000

.WithAttachments(new Attachment("Test.pdf", "Test Attachment"))

Die Anhänge zum Antrag werden mit .WithAttachments übergeben. Diese Methode erwartet ein Array von Attachment-Objekten, die als params übergeben werden können.

Ein Attachment kann mit den folgenden Parametern erstellt werden:

• Metadaten und byte[] content
• Dateiname und Beschreibung

Dazu werden zwei Konstruktoren bereitgestellt:

• Attachment(Api.Metadata.Attachment metadata, byte[] content)
• Attachment(string fileName, string description,)

.WithData("{"message":"Hello World"}")

Die Fachdaten werden als JSON-String übergeben.

.Build()

Die Build-Methode erzeugt eine SendableSubmission, die dann an den Sender übergeben werden kann.

GetSender(FitConnectEnvironment.Testing, clientId, clientSecret, logger)

Hier werden die FIT Connect Environment ausgewählt und die Credentials übergeben. Der Parameter logger ist optional und muss das Interface Microsoft.Extensions.Logging.ILogger implementieren.

.SendAsync(submission)

Das Abschicken der Submission erfolgt mit diesem Aufruf.

Subscriber

Das folgende Beispiel zeigt, wie Sie das SDK in einem empfangenden System nutzen, um einen Subscriber zu erzeugen, der Einreichungen von sendenden Systemen erhält.

Beispiel

var subscriber = Client.GetSubscriber(FitConnectEnvironment.Testing, clientId,
    clientSecret,
    privateKeyDecryption,
    privateKeySigning,
    publicKeyEncryption,
    publicKeySignatureVerification,
    logger);

Im Beispiel oben stellt das Argument "privateKeyDecryption" den JSON Web Key (JWK) für den privaten Schlüssel zum Entschlüsseln bereit. Das Argument 'privateKeySigning" enthält den JWK des privaten Schlüssels zum Signieren. Das Argument 'publicKeyEncryption" liefert den JWK des öffentlichen Schlüssels zum Verschlüsseln. Das Argument 'publicKeySignatureVerification" enthält den JWK des öffentlichen Schlüssels zum Überprüfen der Signatur.

Abrufen der verfügbaren Submissions

Das folgende Beispiel zeigt, wie Sie das SDK in einem empfangenden System nutzen, um beim Server (dem Zustelldienst von FIT-Connect) nachzufragen, welche Einreichungen (Submissions) zur Abholung bereitliegen.

var submissions = await subscriber.GetAvailableSubmissions();

Das folgende Beispiel zeigt, wie Sie das SDK in einem empfangenden System nutzen, um bereitliegende Einreichungen mit ihren Anhängen vom Server (Zustelldienst) abzurufen.

Abrufen der Submissions mit den Anhängen

foreach (var submission in submissions) {
    var requestedSubmission = await subscriber.RequestSubmission(submission.SubmissionId);
    var attachments = await requestedSubmission.GetAttachments();
    var data = requestedSubmission.GetDataJson();
    
    // Additional custom checks
    var ok = AdditionalCustomChecksOutsideSDK(requestedSubmission, attachments, data);
    
    if (ok){
        // Submission accept
        await requestedSubmission.AcceptSubmission();
    } else {
        // or submission reject
       await requestedSubmission.RejectSubmission();
   }
}

Details

flowchart LR

    start([GetSubscriber])
    availableSub(GetAvailableSubmission)
    requestSub(RequestSubmission)
    subscriberWithSub([SubscriberWithSubmission])
    subscriberWithSub_([SubscriberWithSubmission])
    data(GetDataJson)
    attachments(GetAttachments)
    accept(AcceptSubmission)
    reject(RejectSubmission)
    forward(ForwardSumbission)
    finished{{Abgeschlossen}}
    rejected{{Zurueckgewiesen}}
    
    start-->availableSub-->requestSub-->subscriberWithSub
    
    subscriberWithSub_-->data-->attachments
    attachments-->accept-->finished
    attachments-->reject-->rejected
    attachments-->forward

        

.GetSubscriber(...)

Hier werden die FIT-Connect-Environment, die Keys und die Credentials übergeben. Der Parameter logger ist optional und muss das Interface Microsoft.Extensions.Logging.ILogger implementieren.

.GetAvailableSubmissions()

Liefert eine Liste der verfügbaren Submissions zurück.

.RequestSubmission(submissionId)

Hiermit wird die Submission abgerufen und im Subscriber gespeichert. Der Rückgabewert der Funktion ist also Subscriber mit einer Submission

.GetDataJson()

Liefert die Fachdaten als JSON-String zurück.

.GetAttachments()

Gibt eine Liste mit den Attachments der Submission zurück. Die Attachments können so geprüft werden.

.AcceptSubmission()

Akzeptiert die Submission und löscht die Submission, die auf dem Server gespeichert ist.

.RejectSubmission()

Weist die Submission zurück.

.ForwardSubmission()

Beispiel

        var subscriber = Client.GetSubscriber(FitConnectEnvironment.Testing, clientId,
            clientSecret,
            privateKeyDecryption,
            privateKeySigning,
            publicKeyEncryption,
            publicKeySignatureVerification,
            logger);

        var submissions = subscriber.GetAvailableSubmissions();

        // Alle verfügbaren Submissions laden
        foreach (var submission in submissions) {
            var subscriberWithSubmission = subscriber.RequestSubmission(submission.SubmissionId);
            
            // Laden der Anhänge
            var attachments = subscriberWithSubmission
                .GetAttachments();

            // Ausgabe der Fachdaten auf der Konsole
            logger.LogInformation("Fachdaten: {Data}", subscriberWithSubmission.GetDataJson());
            
            // Submission akzeptieren und abschließen
            subscriberWithSubmission.AcceptSubmission();
        }

Router

Die Client-Implementierung der Routing-API

Client.GetRouter(FitConnectEnvironment.Development, logger);

glossary

License

Source code is licensed under the EUPL.

Rechtlicher Hinweis: 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.