Skip to content
Snippets Groups Projects

515_Rueckkanal_Dokumentation_ueber_die_Verwendung

Closed Michael Haidner requested to merge 515_Rueckkanal_Dokumentation_ueber_die_Verwendung into main
Compare and Show latest version
1 file
+ 95
14
Compare changes
  • Side-by-side
  • Inline
@@ -11,14 +11,12 @@ Diese Seite beschreibt, wie Sie in FIT-Connect einen bestimmten Rückkanal ausw
### Bidirektionale Kommunikation über FIT-Connect
Nutzt ein Fachverfahrens FIT-Connect als Rückkanal, um Antworten auf Einreichungen zurückzusenden, dann können das Fachverfahren und der Sender (Onlinedienst oder ein anderes Softwareprogramm) bidirektional Nachrichten austauschen.
Bei anderen Rückkanälen (Postweg, E-Mail, Elster oder FINK) ist keine solche bidirektionale Kommunikation zwischen dem sendenden System (Sender, Onlinedienst) und dem empfangenden System (Empfänger, Fachverfahren) möglich.
Bei anderen Rückkanälen (Postweg, E-Mail, Elster oder FINK) ist keine bidirektionale Kommunikation möglich.
### Bidirektionale Kommunikation einstellen
Um die bidirektionale Kommunikation zwischen einem sendenden System (Onlinedienst) und einem empfangenden System (Fachverfahren) zu verwenden, ist die folgende Einstellung erforderlich: <br/>
**Submission-API** <br/>
Beim Aufruf des Endpunkts "/submissions" der Submission-API muss im übergebenen JSON-Objekt die Eigenschaft (der Schlüssel) "bidirectional" auf den Wert "true" gesetzt sein. <br/>
Im folgenden Beispiel ist die Eigenschaft "bidirectional" auf den Wert "true" gesetzt. Mit diesem Wert signalisiert der Sender, dass er eine bidirektionale Kommunikation mit dem Empfänger wünscht:
Um bidirektionale Kommunikation zu verwenden, muss beim Aufruf des Endpunkts "/submissions" der Submission-API im übergebenen JSON-Objekt die Eigenschaft (der Schlüssel) "bidirectional" auf den Wert "true" gesetzt sein. <br/>
Im folgenden Beispiel ist bei "bidirectional" der Wert "true" eingetragen. Mit diesem Wert signalisiert der Sender, dass er eine bidirektionale Kommunikation mit dem Empfänger wünscht:
```json
{
@@ -27,14 +25,97 @@ Im folgenden Beispiel ist die Eigenschaft "bidirectional" auf den Wert "true" ge
"879ee109-a690-4db8-ab32-424284184d7d",
"2046f9f1-dc89-4440-9c24-c76a8f40d668"
],
"serviceType": {
"name": "Bauantrag",
"identifier": "urn:de:fim:leika:leistung:99010003001006"
},
"callback": {
"url": "https://my-onlineservice.example.org/callbacks/fit-connect",
"secret": "insecure_unsafe_qHScgrg_kP-R31jHUwp3GkVkGJolvBchz65b74Lzue0"
},
...
bidirectional: true
}
```
\ No newline at end of file
```
### Konfiguration eines Zustellpunktes
Die Konfiguration eines Zustellpunkts gibt Auskunft über die Rückkanäle, die dieser Zustellpunkt anbietet. Die Konfiguration können Sender über die Routing-API von FIT-Connect erfragen. <br/>
**Konfiguration erfragen** <br/>
Der Aufruf des Endpunkts "/routes" mit Leistungs- und Gebietschlüssel liefert die Informationen zum Zustellpunkt in einem JSON-Objekt zurück. In diesem Objekt sind im "routes"-Array alle Routen zu diesem Zustellpunkt eingetragen. Innerhalb einer Route befinden sich unter "destinationParameters.replyChannels" die Einträge zu den Rückkanälen, die der Zustellpunkt anbietet.
Im folgenden Beispiel bietet ein Zustellpunkt an, über Elster, E-Mail oder FIT-Connect zu antworten:
```json
{
"count": 0,
"offset": 0,
"totalCount": 0,
"routes": [
{
"destinationParameters": {
"destinationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"encryptionKid": "NFNb7k84r61G9ayAAJItJCNGl7wKWif9HyBAgicJq_8",
"metadataVersions": ["^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$"]
...
"replyChannels": {
"elster": { },
"eMail": {
"usePgp": false
},
"fitconnect": {}
...
}
```
Gibt es keine Einträge zu "replyChannels", dann werden Antworten auf Einreichungen auf dem Postweg als Briefe zugestellt. Eine bidirektionale Kommunikation über FIT-Connect ist hier nicht möglich.
### Eintrag in den Metadaten
Wenn ein Onlinedienst FIT-Connect für Antworten nutzen will (FIT-Connect als Rückkanal), dann muss in den Metadaten, die dieser Onlinedienst an ein Fachverfahrens sendet, unter "replyChannel" der Wert "fitConnect" eingetragen sein. <br/>
Im folgenden Beispiel wünscht sich das sendende System (der Onlinedienst), dass der Zustellpunkt als Rückkanal FIT-Connect verwendet. Zudem soll der Prozessstardard "XBAU 2.3" genutzt werden:
```json
{
"$schema": "https://schema.fitko.de/fit-connect/metadata/1.0.0/metadata.schema.json",
"authenticationInformation": [
{
...
}
],
"contentStructure": {
"data": {
...
},
"attachments": [
...
]
},
"paymentInformation": {
...
},
"publicServiceType": {
...
},
"replyChannel": {
"fitConnect": {
"processStandards": [ "urn:xoev-de:bmk:standard:xbau_2.3"
]
"encryptionPublicKey": {
"kty": "RSA",
"key_ops": [
"wrapKey"
],
"alg": "RSA-OAEP-256",
"kid": "……(Key ID)……"
"n": "4096",
"e": "AQAB"
}
}
}
}}
```
Loading