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
Compare
and
Show latest version
4 files
+ 186
− 149
Compare changes
  • Side-by-side
  • Inline
Files
4
docs/reply-channels/einstellungen-sender.mdx
+ 184
− 31
@@ -7,23 +7,32 @@ import ApiLink from '@site/src/components/ApiLink'
# Einstellungen für Sender
### Einen Rückkanal auswählen
## Rückkanal auswählen
Diese Seite beschreibt aus Sicht eines Senders, wie Sie einen Rückkanal für einen Sender auswählen.
Zudem wird gezeigt, welche Einstellung für die bidirektionale Kommunikation zwischen Sender und Empfänger erforderlich ist.
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.
### Konfiguration eines Zustellpunktes {#KonfigZustellpunkt}
### 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".
Die Konfiguration eines Zustellpunkts gibt Sendern Auskunft darüber, welche Rückkanäle dieser Zustellpunkt anbietet.
Die Konfiguration können Sender über die Routing-API von FIT-Connect erfragen.
### Konfiguration eines Zustellpunktes abfragen {#KonfigZustellpunkt}
**Sender erfragen Konfiguration** <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.
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.
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 bietet sendenden Systemen an, über Elster, E-Mail oder FIT-Connect zu antworten:
Dieser Zustellpunkt (und das nachgelagerte Fachverfahren) bietet sendenden Systemen an, über Elster, E-Mail oder FIT-Connect zu antworten:
```json
{
@@ -55,26 +64,169 @@ Dieser Zustellpunkt bietet sendenden Systemen an, über Elster, E-Mail oder FIT-
}
```
Gibt es keine Einträge zu `replyChannels`, dann werden Antworten auf Einreichungen auf dem Postweg zugestellt. <br/>
In der [Konfiguration des Beispiels oben](#KonfigZustellpunkt) ist als Rückkanal auch FIT-Connect enthalten,
somit können Sender in diesem Beispiel die bidirektionale Kommunikation über FIT-Connect wählen.
Gibt es keine Einträge zu `replyChannels`,
dann stellt das nachgelagerte Fachverfahren Antworten zu Einreichungen auf dem Postweg zu.
## Rückkanäle E-Mail, De-Mail und Elster
### Erforderliche Einträge in den Metadaten
Im [Beispiel oben](#KonfigZustellpunkt) für die Konfiguration eines Zustellpunkts
sind als mögliche Rückkanäle Elster, E-Mail und FIT-Connect eingetragen,
somit können Sender einen dieser Rückkanäle für ihre Einreichungen auswählen. <br/>
Wenn ein Sender für eine Einreichung E-Mail, De-Mail oder Elster auswählen will,
dann muss er dies dem adressierten Fachverfahren mitteilen,
indem er einen Eintrag in den Metadaten zu der Einreichung einfügt, unter "replyChannel". <br/>
Sie dürfen nur einen Rückkanal eintragen.
### Einträge für E-Mail
Das folgende Beispiel für die Metadaten einer Einreichung zeigt die Einträge 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"
}
...
}
}
```
### Einträge für De-Mail
Das folgende Beispiel für die Metadaten einer Einreichung zeigt die Einträge für De-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": {
"deMail": {
"address": "example@example.de-mail.de"
}
}
...
}
```
### Einträge für Elster
Das folgende Beispiel für die Metadaten einer Einreichung zeigt die Einträge 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"
}
...
}
}
```
## 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 oder ein anderes Softwareprogramm) miteinander Nachrichten austauschen.
Bidirektionale Kommunikation ist nur über FIT-Connect möglich, nicht aber bei anderen Rückkanälen wie Elster oder E-Mail. <br/>
Bei bidirektionaler Kommunikation können ein Fachverfahren und ein Sender (Onlinedienst oder ein anderes Softwareprogramm) 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.
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
Soll ein Fachverfahren bei einer Einreichung die bidirektionale Kommunikation verwenden,
dann sind die folgenden Angaben für diese Einreichung erforderlich:
- Der Sender muss beim Erstellen einer Einreichung dem Fachverfahren mitteilen,
dass die bidirektioale Kommunikation verwendet werden soll
(siehe [Erstellen einer Einreichung](#erstellen_einreichung)).
- Der Sender muss beim Versenden dieser Einreichung dem Fachverfahren in den Metadaten mitteilen,
welcher Prozessstandard und welcher Verschlüsselungsschlüssel bei der Antwort verwendet werden sollen
(siehe [Einträge in den Metadaten](#MetadatenFitConnect)).
### Bidirektionale Kommunikation einstellen {#BidirektKommunikationEinstellen}
### Erstellen einer Einreichung {#erstellen_einreichung}
Um bidirektionale Kommunikation zu verwenden,
muss der Sender beim Aufruf des Endpunkts "/submissions" der Submission-API im übergebenen JSON-Objekt die Eigenschaft (den Schlüssel) "bidirectional" auf den Wert "true" setzen. <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 (mit dem Zustellpunkt des Fachverfahrens) wünscht:
Soll bei einer Einreichung die bidirektionale Kommunikation verwendet werden,
dann muss der Sender (Onlinedienst) beim Aufruf des Endpunkts
<ApiLink api="submission-api" to="/submissions" withMethod="post"/> (beim Erstellen der Einreichung)
ein JSON-Objekt übergeben,
in dem die Eigenschaft "bidirectional" auf den Wert "true" gesetzt ist.
Das folgende Beispiel zeigt diese Einstellung:
```json
{
@@ -90,15 +242,16 @@ Mit diesem Wert signalisiert der Sender, dass er eine bidirektionale Kommunikati
}
```
### Einträge in den Metadaten {#MetadatenFitConnect}
### Einträge in den Metadaten {#MetadatenFitConnect}
Wenn ein Sender FIT-Connect für Antworten nutzen will (FIT-Connect als Rückkanal), dann muss in den Metadaten,
die dieser Sender an ein Fachverfahren sendet, unter "replyChannel" der Wert "fitConnect" eingetragen sein. <br/>
Im folgenden Beispiel wünscht sich der Sender (Onlinedienst), dass der Empfänger als Rückkanal FIT-Connect verwendet. <br/>
Zudem soll der Prozessstardard "XBAU 2.3" genutzt werden. <br/>
Darüber hinaus übermittelt der Sender in den Metadaten einen kryptografischen Schlüssel,
Soll bei einer Einreichung die bidirektionale Kommunikation verwendet werden,
dann muss zudem in den Metadaten zu dieser Einreichung unter "replyChannel" ein Objekt zu "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 direktionaler Kommunikation werden auch Antworten verschlüsselt übertragen (Ende-zu-Ende-Verschlüsselung).
Bei der direktionalen Kommunikation werden Antworten verschlüsselt übertragen (Ende-zu-Ende-Verschlüsselung):
```json