Skip to content
Snippets Groups Projects

515_NEW_Rueckkanal_Dokumentation_ueber_die_Verwendung(planning#515, planning#115)

Compare and Show latest version
8 files
+ 712
20
Compare changes
  • Side-by-side
  • Inline
Files
8
@@ -7,23 +7,29 @@ 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) zu 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 {#KonfigZustellpunkt}
**Sender erfragen Konfiguration** <br/>
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,9 +61,52 @@ 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 nur auf dem Postweg zu.
## Rückkanäle E-Mail, De-Mail, FINK und Elster
### Erforderliche Einstellungen
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 für ihre Einreichungen einen dieser Rückkanäle auswählen. <br/>
Wenn ein Sennder für eine Einreichung E-MMail, Elster odr FINK auswählten will,
dann muuss er diese Auswahl dem addresierten Fachverfahren mitteilen,
indem er einen entsprechen Einrag in den Metadaten zu einer Einreichung einfügt. <br/>
Im Folgenden sollenn die erforderlichen Einstellung in den Metadaten für E-Mail gezeigt werden.
```json
{
"$schema": "https://schema.fitko.de/fit-connect/metadata/1.0.0/metadata.schema.json",
"authenticationInformation": [
{
...
}
],
"contentStructure": {
"data": {
...
},
"attachments": [
...
]
},
"paymentInformation": {
...
},
"publicServiceType": {
...
},
"replyChannel": {
"e-mail": {
...
}
}
```
Im [Beispiel oben](#KonfigZustellpunkt) für die Konfiguration eines Zustellpunkts sind als mögliche Rückkanal Elster, E-MMail und FIT-Connect eingetragen,
somit können Sender in diesem Beispiel die bidirektionale Kommunikation über FIT-Connect wählen (folgende 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.
@@ -69,12 +118,20 @@ der darin besteht, dass ein sendendes System (Onlinedienst) eine Nachricht sende
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.
### Bidirektionale Kommunikation einstellen {#BidirektKommunikationEinstellen}
## Rückkanal FIT-Connect
### Erforderliche Einstellungen für bidirektionale Kommunikation
Soll ein Sender bei einer Einreichung die bidirektionale Kommunikation verwenden,
dann müssen die folgenden Einstelluungen bei dieser Einreichung vorhanden sein:
### 1: Bidirektionale Kommunikation einschalten beim Erstellen einer 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,7 +147,7 @@ Mit diesem Wert signalisiert der Sender, dass er eine bidirektionale Kommunikati
}
```
### Einträge in den Metadaten {#MetadatenFitConnect}
### 2: Einträge in den Metadaten erforderlich {#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/>
Loading