Skip to content
Snippets Groups Projects

515_NEW_Rueckkanal_Dokumentation_ueber_die_Verwendung(planning#515, planning#115)

Closed 515_NEW_Rueckkanal_Dokumentation_ueber_die_Verwendung(planning#515, planning#115)
515_NEW_Rueckkanal_Dokumentation_ueber_die_Verwendung into main
Closed Michael Haidner requested to merge 515_NEW_Rueckkanal_Dokumentation_ueber_die_Verwendung into main
Viewing commit 845eb79c
Prev Next
Show latest version
1 file
+ 55
− 5
Compare changes
  • Side-by-side
  • Inline
docs/reply-channels/einstellungen-sender.mdx 0 → 100644
+ 277
− 0
---
hide_table_of_contents: false
title: Einstellungen für Sender
---
import ApiLink from '@site/src/components/ApiLink'
# Einstellungen für Sender
## Rückkanal auswählen
Diese Seite beschreibt,
wie ein Sender (Onlinedienst) für eine Einreichung einen der Rückkanäle auswählt,
die der Empfänger (das adressierte Fachverfahren) anbietet.
### Welche Rückkanäle bietet ein Fachverfahren?
Um zu erfahren, welche Rückkanäle (Antwortkanäle) ein Fachverfahren anbietet,
können Sender die Konfiguration des Fachverfahrens abrufen.
In FIT-Connect ist die Konfiguration eines konkreten empfangenden Systems (eines Fachverfahrens) in einem Zustellpunkt beschrieben.
Somit können Sender diesen Zustellpunkt abfragen,
um zu erfahren, welche Rückkanäle das nachgelagerte Fachverfahren anbietet.
Im [Glossar](../glossary.md) dieser Dokumentation finden Sie eine Definition für den Begriff "Zustellpunkt".
### Konfiguration eines Zustellpunktes abfragen {#KonfigZustellpunkt}
Die Konfiguration eines Zustellpunktes für ein Fachverfahren können Sender über die Routing-API von FIT-Connect erfragen: <br/>
Der Aufruf des Endpunkts <ApiLink api="routing-api" to="/routes" />
mit Leistungs- und Gebietsschlüssel liefert die Informationen zu Zustellpunkten in einem JSON-Objekt zurück.
In diesem JSON-Objekt sind im `routes`-Array die Routen zu allen Zustellpunkten eingetragen,
die für die angegebene Leistung (Leistungsschlüssel im API-Aufruf) im angegebenen Gebiet (Gebietsschlüssel im API-Aufruf) zur Verfügung stehen. <br/>
Innerhalb einer Route befinden sich unter `destinationParameters.replyChannels` die Einträge zu den Rückkanälen,
die dieser Zustellpunkt anbietet
(und somit auch das nachgelagerte Fachverfahren).
Im folgenden Beispiel gibt es nur einen Zustellpunkt für die angegebene Leistung im angegebenen Gebiet.
Dieser Zustellpunkt (und das nachgelagerte Fachverfahren) bietet sendenden Systemen an, über Elster, E-Mail oder FIT-Connect zu antworten:
```json
{
"count": 1,
"offset": 0,
"totalCount": 1,
"routes": [
{
"destinationParameters": {
"destinationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"encryptionKid": "NFNb7k84r61G9ayAAJItJCNGl7wKWif9HyBAgicJq_8",
"metadataVersions": ["1.0.0"]
...
"replyChannels": {
"elster": {},
"eMail": {
"usePgp": false
},
"fitConnect": {
...
}
...
}
```
Gibt es keine Einträge zu `replyChannels`,
dann stellt das nachgelagerte Fachverfahren Antworten zu Einreichungen auf dem Postweg zu.
## Rückkanäle E-Mail, Elster und FIT-Connect
### Erforderliche Einträge in den Metadaten {#eintraege_metadaten}
Im [Beispiel oben](#KonfigZustellpunkt) für die Konfiguration eines Zustellpunkts
sind als mögliche Rückkanäle E-Mail, Elster und FIT-Connect eingetragen,
somit können Sender einen dieser Rückkanäle für ihre Einreichungen auswählen.
#### Einen Rückkanal eintragen
Wenn ein Sender für eine Einreichung E-Mail, Elster oder FIT-Connect auswählen will,
dann muss er dies dem adressierten Fachverfahren mitteilen,
indem er einen Eintrag in die Metadaten zu der Einreichung unter "replyChannel" einfügt. <br/>
Es darf nur ein Rückkanal eingetragen werden.
### Eintrag für E-Mail
Das folgende Beispiel für die Metadaten einer Einreichung zeigt den Eintrag für E-Mail als Rückkanal:
```json
{
"$schema": "https://schema.fitko.de/fit-connect/metadata/1.0.0/metadata.schema.json",
"authenticationInformation": [
{
...
}
],
"contentStructure": {
"data": {
...
},
"attachments": [
...
]
},
"paymentInformation": {
...
},
"publicServiceType": {
...
},
"replyChannel": {
"eMail": {
"address": "example@example.com"
}
...
}
}
```
### Eintrag für Elster
Das folgende Beispiel für die Metadaten einer Einreichung zeigt den Eintrag für Elster als Rückkanal:
```json
{
"$schema": "https://schema.fitko.de/fit-connect/metadata/1.0.0/metadata.schema.json",
"authenticationInformation": [
{
...
}
],
"contentStructure": {
"data": {
...
},
"attachments": [
...
]
},
"paymentInformation": {
...
},
"publicServiceType": {
...
},
"replyChannel": {
"elster": {
"accountId": "1234567891"
}
...
}
}
```
### Eintrag für FIT-Connect
Dieses Beispiel zeigt einen Auszug aus den Metadaten einer weiteren Einreichung; hier ist als Rückkanal `fitConnect` unter `replyChannel` eingetragen.
```json
{
"$schema": "https://schema.fitko.de/fit-connect/metadata/1.0.0/metadata.schema.json",
"authenticationInformation": [
...
],
"contentStructure": {
"data": {
...
},
"hash": {
...
}
},
"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"
}
}
}
```
## Rückkanal FIT-Connect
Im [Beispiel oben](#KonfigZustellpunkt) für die Konfiguration eines Zustellpunktes sind als mögliche Rückkanäle Elster, E-Mail und FIT-Connect eingetragen:
In diesem Beispiel können Sender also auch die bidirektionale Kommunikation über FIT-Connect wählen (siehe die folgenden Absätze).
### Bidirektionale Kommunikation über FIT-Connect
Bei bidirektionaler Kommunikation können ein Fachverfahren und ein Sender (Onlinedienst) Nachrichten austauschen.
Bidirektionale Kommunikation ist nur über FIT-Connect möglich,
nicht aber bei anderen Rückkanälen wie Elster oder E-Mail. <br/>
### Definition
In dieser Dokumentation wird unter "bidirektionaler Kommunikation"
der automatisierte Datenaustausch zwischen Softwareprogrammen (Onlinedienst und Fachverfahren) verstanden,
der darin besteht,
dass ein sendendes System (Onlinedienst) eine Nachricht sendet
und das empfangende System (Fachverfahren) darauf reagiert
und eine Antwort zurücksendet.
Das sendende System empfängt die Antwort,
wertet sie programmtechnisch aus und reagiert darauf,
indem es zum Beispiel eine weitere Nachricht an das empfangende System sendet,
das dann wiederum darauf antworten kann.
## Erforderliche Einstellungen für bidirektionale Kommunikation {#einstellungen_bidirektionale_kommunikation}
### Einträge in den Metadaten {#MetadatenFitConnect}
Soll bei einer Einreichung die bidirektionale Kommunikation verwendet werden,
dann muss in den Metadaten zu dieser Einreichung unter "replyChannel" ein Objekt "fitConnect" eingetragen sein,
das den Prozessstandard bezeichnet sowie ferner Angaben zum Verschlüsselungsschlüssel für die Antwort des Fachverfahrens enthält. <br/>
Im folgenden Beispiel wünscht sich der Sender (Onlinedienst), dass das Facherfahren FIT-Connect als Rückkanal verwendet. <br/>
Zudem soll der Prozessstandard "XBAU 2.3" genutzt werden. <br/>
Darüber hinaus übermittelt der Sender einen kryptografischen Schlüssel,
mit dem der Empfänger seine Antwort verschlüsseln soll, siehe "encryptionPublicKey" im folgenden Beispiel.
Bei der direktionalen Kommunikation werden Antworten verschlüsselt übertragen (Ende-zu-Ende-Verschlüsselung):
```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"
}
}
}
}
}
```