Skip to content
Snippets Groups Projects

"Zustellpunkt anlegen" überarbeitet.

Merged "Zustellpunkt anlegen" überarbeitet.
replyChannels_und_metadataVersions into main
Merged Andreas Huber requested to merge replyChannels_und_metadataVersions into main
Compare
and
14 files
+ 70
− 47
Compare changes
  • Side-by-side
  • Inline
Files
14
docs/getting-started/receiving/destination.mdx
+ 70
− 47
---
sidebar_position: 3
title: 🚧 Zustellpunkt anlegen
title: Zustellpunkt anlegen
---
@@ -9,13 +9,6 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
Um Einreichungen über FIT-Connect zu empfangen, muss zunächst ein Zustellpunkt (Destination) angelegt werden.
Dies wird über das Self-Service-Portal umgesetzt.
:::caution
In der finalen API wird eine explizite Aktivierung des Zustellpunkts (über die API oder das Self-Service-Portal) notwendig sein.
Damit soll sichergestellt werden, dass ein API-Client mit dem Scope `subscribe:destination:<id>` für diese `destinationId` angelegt und technisch empfangsbereit ist.
Entsprechende organisatorische und technische Hinweise zu Aktivierung werden an dieser Stelle noch ergänzt.
:::
## Zustellpunkt anlegen
Unter einem Zustellpunkt versteht sich ein technisch eindeutig adressierbarer Endpunkt zur Einreichung von Anträgen oder Berichten an die Verwaltung über die FIT-Connect Übermittlungsinfrastruktur.
@@ -26,96 +19,126 @@ Es ist jedoch möglich einem empfangenden System (API-Client) multiple Zustellpu
Über die Zustellpunktverwaltung lassen sich neue Zustellpunkte anlegen, bereits hinzugefügt Zustellpunkte verwalten und auch wieder entfernen.
<div class="center">
<img width="600" alt="Zustellpunktverwaltung"
src={useBaseUrl('/images/ssp/7-Destinationverwaltung.png')}/>
<img width="800" alt="Zustellpunktverwaltung"
src={useBaseUrl('/images/ssp/destinations-overview.png')}/>
</div>
Über den Menüpunkt `Zustellpunkt hinzufügen` können neue Zustellpunkte zu Ihrem Konto hinzugefügt werden.
Über den Menüpunkt <img width="123" alt="Zustellpunkt anlegen" src={useBaseUrl('/images/ssp/add-destination.png')}/> können neue Zustellpunkte zu Ihrem Konto hinzugefügt werden.
Ein Zustellpunkt benötigt zur Erstellung eine Vielzahl von Angaben, die sich im Wesentlichen auf Kontaktdaten, technische Angaben und Service aufteilen.
<div class="center">
<img width="800" alt="Formular zum Anlegen eines neuen Zustellpunktes"
src={useBaseUrl('/images/ssp/8-Destination-hinzufuegen.png')}/>
<img width="600" alt="Formular zum Anlegen eines neuen Zustellpunktes - Teil 1"
src={useBaseUrl('/images/ssp/add-destination-section-1.png')}/>
</div>
Ein Zustellpunkt benötigt zur Erstellung eine Vielzahl von Angaben, die sich im Wesentlichen auf Kontaktdaten, technische Angaben und Service aufteilen.
In diesem Bereich vergeben Sie einen Namen, unter dem der Zustellpunkt im Self-Service-Portal angezeigt wird.
Unter <b>Kontaktdaten</b> werden Details zum antragsempfangenden System erfasst.
Sämtliche Felder sind dabei aktuell noch Fließtext.
Unter der Funktionspostfachadresse wird eine E-Mail-Adresse erwartet.
Sie können Ihr empfangendes System per Callback (Webhook) über neue Einreichungen informieren lassen.
Die Nutzung eines Callbacks ist grundsätzlich optional, wird jedoch empfohlen.
Tragen Sie dafür die Adresse des Callbacks und ein Geheimis zur Absicherung ein.
Die Nutzung eines Callbacks ohne ein Geheimnis ist nicht möglich.
<div class="center">
<img width="600" alt="Formular zum Anlegen eines neuen Zustellpunktes - Teil 2"
src={useBaseUrl('/images/ssp/add-destination-section-2.png')}/>
</div>
Um im Fehlerfall Kontakt aufzunehmen benötigt der Betreiber des Zustelldienstes Kontaktdaten der Organisation, die den Zustellpunkt betreibt.
<div class="center">
<img width="600" alt="Formular zum Anlegen eines neuen Zustellpunktes - Teil 3"
src={useBaseUrl('/images/ssp/add-destination-section-3.png')}/>
</div>
Aktivieren Sie die von Ihnen unterstützten Antwortkanäle.
Sofern Sie keinen Antwortkanal anbieten oder der Antragsteller keinen den angebotenen Kanäle nutzen kann, müssen Sie ihm auf dem Postweg antworten.
<div class="center">
<img width="600" alt="Formular zum Anlegen eines neuen Zustellpunktes - Teil 4"
src={useBaseUrl('/images/ssp/add-destination-section-4.png')}/>
</div>
Aktivieren Sie alle von Ihrem empfangenden System unterstützen Metadatenversionen.
<div class="center">
<img width="600" alt="Formular zum Anlegen eines neuen Zustellpunktes - Teil 5"
src={useBaseUrl('/images/ssp/add-destination-section-5.png')}/>
</div>
In diesem Bereich müssen Sie zwei öffentliche Schlüssel für Ihren Zustellpunkt angeben.
Mit dem Verschlüsselungsschlüssel werden die Einreichungen verschlüsselt.
Mit dem öffentlichen Signaturschlüssel werden die von Ihrem System ausgestellten Empfangsquittungen geprüft.
Unter <b>Technische Angaben</b> werden neben einem Callback auch öffentliche Schlüssel zur Signaturprüfung und Verschlüsselung erwartet.
Beide Schlüssel müssen im JSON-Format vorliegen und den Anforderungen aus
[Vorgaben für kryptographische Verfahren](https://docs.fitko.de/fit-connect/docs/details/crypto) entsprechen.
Ein Tool und die zugehörige Anleitung um schnell und einfach passende Schlüssel für Testzwecke zu generieren finden Sie unter
[Tool zur Erstellung von JSON Web Keys](https://docs.fitko.de/fit-connect/docs/details/jwk-creation/).
Unter <b>Service</b> werden ein eindeutiger Leistungsindikator, eine Region aus der eine Anfrage zulässig ist sowie die URI des verwendeten Fachschemas erwartet.
<div class="center">
<img width="800" alt="Zustellpunkt mit Beispieldaten befüllt"
src={useBaseUrl('/images/ssp/9-Destination-hinzufuegen-befuellt.png')}/>
<img width="800" alt="Formular zum Anlegen eines neuen Zustellpunktes - Teil 6"
src={useBaseUrl('/images/ssp/add-destination-section-6.png')}/>
</div>
Unter <b>Verwaltungsleistungen</b> werden ein eindeutiger Leistungsindikator, eine Region aus der eine Anfrage zulässig ist sowie die URI des verwendeten Fachschemas erwartet.
Wurden alle Informationen und Schlüssel in korrekter Form übergeben wird der Zustellpunkt erstellt.
<div class="center">
<img width="600" alt="Destination wurde erfolgreich angelegt"
src={useBaseUrl('/images/ssp/11-Destination-erfolgreich-angelegt.png')}/>
src={useBaseUrl('/images/ssp/destination-created.png')}/>
</div>
:::caution
:::caution Hinweis
Neu angelegte Zustellpunkte haben nach der Erstellung den Status `created` und sind für sendende Systeme weder sichtbar noch adressierbar.
Hiermit soll verhindert werden, dass Einreichungen an den Zustellpunkt übersendet werden, ohne das ein empfangsbereites System vorliegt, dass die Einreichungen für diesen Zustellpunkt an der API abrufen kann.
Daher ist zwingend vor der Aktivierung eines Zustellpunktes [ein API-Client anzulegen](https://docs.fitko.de/fit-connect/docs/account) und diesem Zustellpunkt zuzuweisen (siehe nächster Abschnitt).
:::
## Zugriff auf Zustellpunkte einrichten
Clients vom Typ **Subscriber** können Zustellpunkten zugeordnet werden.
Der Client empfängt dann die für den Zustellpunkt bestimmten Anfragen.
Durch einen Klick auf die Client-ID eines Clients vom Typ **Subscriber** in der Client-Verwaltung öffnet sich die Detailansicht.
<div class="center">
<img width="600" alt="Zustellpunkte zu einem Client hinzufügen"
src={useBaseUrl('/images/ssp/16-Destination-zu-Client-hinzufuegen.png')}/>
<img width="800" alt="Zustellpunkte zu einem Client hinzufügen"
src={useBaseUrl('/images/ssp/client-details.png')}/>
</div>
Unter `Zustellpunkte` werden alle verfügbaren oder bereits verknüpften Zustellpunkte angezeigt.
Durch Aktivieren des Kontrollkästchens vor dem Zustellpunkt öffnet sich der Bestätigungsdialog, um dem Client Zugriff auf den Zustellpunkt zu geben.
Unter **Erlaubte Zustellpunkte** werden alle mit den Client bereits verknüpften Zustellpunkte angezeigt.
Um einen weiteren Zustellpunkt hinzuzufügen, klicken Sie auf **Client editieren**.
<div class="center">
<img width="600" alt="Bestätigungsdialog um einen Zustellpunkt zu einem Client hinzufügen"
src={useBaseUrl('/images/ssp/16b-Destination-zu-Client-hinzufuegen.png')}/>
<img width="800" alt="Bestätigungsdialog um einen Zustellpunkt zu einem Client hinzufügen"
src={useBaseUrl('/images/ssp/client-edit.png')}/>
</div>
Im Anschluss wird der hinzugefügte Zustellpunkt durch ein Häkchen im Kontrollkästchen gekennzeichnet.
Zusätzlich wurde der Zustellpunkt im Scope des Clients hinzugefügt.
Aktivieren Sie nun die Kontrollkästchen bei allen Zustellpunkten, auf die der Client Zugriff haben soll und speichern Sie den Client.
<div class="center">
<img width="600" alt="Aktualisierter Scope des Clients"
src={useBaseUrl('/images/ssp/16c-Destination-zu-Client-hinzufuegen.png')}/>
<img width="800" alt="Aktualisierter Scope des Clients"
src={useBaseUrl('/images/ssp/client-with-destination.png')}/>
</div>
## Zugriff auf Zustellpunkte entfernen
## Aktivieren eines Zustellpunktes
Bei Clients vom Typ **Subscriber** können zugeordnete Zustellpunkte auch wieder entfernt werden.
Durch einen Klick auf das derzeit noch aktive und mit einem Häkchen gekennzeichnete Kontrollkästchen des zu entfernenden Zustellpunktes, öffnet sich ein Kontrolldialog, in dem das Löschen bestätigt werden muss.
Sofern Ihr empfangendes System bereit ist Einreichungen zu empfangen, können Sie den Zustellpunkt aktivieren.
Erst nach der Aktivierung ist es möglich, Einreichungen an den Zustellpunkt zu senden.
Wählen Sie den Zustellpunkt aus und bearbeiten Sie ihn.
<div class="center">
<img width="600" alt="Kontrolldialog zum Entfernen des Zugriffs auf einen Zustellpunkt"
src={useBaseUrl('/images/ssp/17-Destination-vom-Client-entfernen.png')}/>
<img width="800" alt="Kontrolldialog zum Entfernen des Zugriffs auf einen Zustellpunkt"
src={useBaseUrl('/images/ssp/edit-destination-created.png')}/>
</div>
Im Anschluss wird der entfernte Zustellpunkt nicht länger durch ein Häkchen im Kontrollkästchen gekennzeichnet.
Zusätzlich wurde der Zustellpunkt im Scope des Clients entfernt.
Ändern Sie den Status von `created` nach `active` und speichern Sie ihn.
<div class="center">
<img width="600" alt="Aktualisierter Scope des Clients"
src={useBaseUrl('/images/ssp/17b-Destination-vom-Client-entfernen.png')}/>
</div>
Weitere Informationen zu den möglichen Status finden Sie unter [Statusmodell eines Zustellpunktes](/docs/details/destination-management#statusmodell-eines-zustellpunktes).
## Bearbeiten und Löschen von Zustellpunkten
## Aktivieren Bearbeiten und Löschen von Zustellpunkten
Weiterführende Informationen zum Bearbeiten und Löschen von Zustellpunkten finden sich im Artikel
[Verwalten eines Zustellpunktes](/docs/details/destination-management).