diff --git a/docs/getting-started/receiving/destination.mdx b/docs/getting-started/receiving/destination.mdx index 84d76ef238f0d0db3842b505066262ec9842f9b6..c712e844e1e2789b5f6fdc64d419c59d0eb7189a 100644 --- a/docs/getting-started/receiving/destination.mdx +++ b/docs/getting-started/receiving/destination.mdx @@ -1,27 +1,35 @@ --- sidebar_position: 2 -title: Zustellpunkt +title: Zustellpunkt anlegen --- import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Um Einreichungen über FIT-Connect zu empfangen, muss zunächst ein Zustellpunkt angelegt werden. Dies wird über das Self-Service-Portal +Um Einreichungen über FIT-Connect zu empfangen, muss zunächst ein Zustellpunkt angelegt werden. Dies wird über das Self-Service-Portal umgesetzt. -Behörden können über das FIT-Connect System Zustellpunkte für Anträge bereitstellen. In der Regel geben sie dabei an, für welches Gebiet -sie welche Einreichung aus dem Leistungskatalog entgegennehmen. Darauf erhalten sie eine Id für den Zustellpunkt (`destinationId`), -welche eine eindeutige Zustelladresse in der Zustelldienstinstanz für diese Leistung repräsentiert. Diese Id wird im Dienstverzeichnis -zusammen mit der LeiKa-ID und den Gemeindekennungen gelistet und wird somit für Antragsversender auffindbar. +:::caution +In der finalen API wird eine explizite Aktivierung des Zustellpunkts (über die API oder das Self-Service-Portal) notwendig sein, damit sichergestellt werden kann, dass ein API-Client mit dem Scope `subscribe:destination:<id>` für diese destinationId angelegt und technisch empfangsbereit ist. Die Aktivierung eines Zustellpunkts wird voraussichtlich zum 06.08. in der API und dem Self-Service Portal umgesetzt sein. Entsprechende organisatorische und technische Hinweise zu Aktivierung werden hier ergänzt. +::: -Nachdem ein Zustellpunkt angelegt wurde, können über diesen Anträge empfangen werden. Wenn eine Einreichung für diesen eingegangen ist, -wird das empfangende System darüber über einen Callback benachrichtigt. Um die Einreichung abzurufen, muss das empfangende System sich zuerst via OAuth2 authentifizieren -und kann sich dann mithilfe des JWT gegenüber der FIT-Connect API autorisieren und die Einreichung abrufen. +## Zustellpunkt anlegen +:::caution +In der finalen API wird eine Anlage der eines neuen Zustellpunkts nur über das Self-Service-Portal möglich sein. Sobald das +::: +## Vorbereitende Tätigkeiten für die Aktivierung eines Zustellpunktes -## Zustellpunkt anlegen +Alle neu angelegten Zustellpunkte haben nach der Erstellung den Status `created` und sind für sendende Systeme nicht sichtbar und 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. -Ein Zustellpunkt kann entweder programmatisch oder über das Self-Service-Portal angelegt werden. +Daher ist zwingend vor der Aktivierung ein API-Client anzulegen, der einen suscribe scope für diesen Zustellpunkt (bspw. subscribe:destination:655c6eb6-e80a-4d7b-a8d2-3f3250b6b9b1) besitzt. + +## Zustellpunkt bearbeiten und aktivieren + +Sobald ein Zustellpunkt über das Self-Service-Portal erstellt wurde und eine destinationID für diesen Zustellpunkt vergeben und dem Nutzer zugeordnet wurde, kann entweder programmatisch über die API oder über das Self-Service-Portal bearbeitet werden. Für die programmatische Bearbeitung über die API sind folgende Voraussetzung zu erfüllen: +- Die Software für die Bearbeitung des Zustellpunkts muss als API-Client mit dem manage scope für den angelegten Zustelpunkt (bspw. manage:destination:655c6eb6-e80a-4d7b-a8d2-3f3250b6b9b1) registiert sein + +**TO-DO: Lösungsneutrale Beschreibung der im Zustellpunkt zu hinterlegenden Informationen** <Tabs defaultValue="curl" @@ -131,9 +139,6 @@ Das Self-Service-Portal befindet sich noch in der Konzeption und ist daher noch </Tabs> -## Aktivierung eines Zustellpunkts für den Empfang von Einreichungen -:::caution -In der finalen API wird eine explizite Aktivierung des Zustellpunkts (über die API oder das Self-Service-Portal) notwendig sein, damit sichergestellt werden kann, dass ein API-Client mit dem Scope `subscribe:destination:<id>` für diese destinationId angelegt und technisch empfangsbereit ist. Die Aktivierung eines Zustellpunkts wird voraussichtlich zum 06.08. in der API und dem Self-Service Portal umgesetzt sein. Entsprechende organisatorische und technische Hinweise zu Aktivierung werden hier ergänzt. -::: +