diff --git a/docs/account.md b/docs/account.md deleted file mode 100644 index e013fd315945fd9081af15f63241ae43a64d011a..0000000000000000000000000000000000000000 --- a/docs/account.md +++ /dev/null @@ -1,3 +0,0 @@ -# 🚧 Accountregistrierung und Client-Verwaltung - -Sobald das Self-Service-Portal umgesetzt ist, wird hier die Dokumentation zur Account-Registrierung und Client-Verwaltung zu finden sein. diff --git a/docs/account.mdx b/docs/account.mdx new file mode 100644 index 0000000000000000000000000000000000000000..8eb74afcdb3a507bcd5f63c512ad080c37cc6fd0 --- /dev/null +++ b/docs/account.mdx @@ -0,0 +1,87 @@ +# Accountregistrierung und Client-Verwaltung + +import useBaseUrl from '@docusaurus/useBaseUrl'; + +Das **Self-Service-Portal** von FIT-Connect erlaubt es Ländern, Kommunen oder interessierten IT-Dienstleistern über eine grafische Oberfläche mit wenigen Klicks OAuth-API-Clients anzulegen und Zustellpunkte, auch **Destinations** genannt, für ihre bereits bestehenden Fachverfahren und Verwaltungsleistungen zu registrieren. +OAuth-API-Clients müssen für jedes an FIT-Connect angebundene System registriert werden. +Das Anlegen eines Zustellpunktes ist dagegen nur für empfangende Systeme (Subscriber) notwendig. +Zustellpunkte können dann im Rahmen von FIT-Connect über den Antrags-Routingdienst gefunden werden. + +## Anmeldung am Self-Service-Portal + +Eine Nutzung des Self-Service-Portals setzt zwingend eine vorangehende Authentifizierung über einen der unterstützten Identity Provider voraus. +In der Testumgebung ist neben der Authentifizierung über das GitLab der FITKO auch ein Login mit einem bestehenden GitLab.com- oder GitHub-Account möglich. + +<img width="600" alt="Übersicht der aktuell unterstützten OAuth 2.0 Identiy Provider" src={useBaseUrl('/images/ssp/1-Login-Verfahren.png')} /> + +Nach erfolgreicher Authentifizierung wird die Startseite des Self-Service-Portals angezeigt: Die Clientverwaltung. + +## Verwaltung von API-Clients + +Über die Client-Verwaltung lassen sich bereits hinzugefügt OAuth-API-Clients verwalten, neue OAuth-API-Clients anlegen und auch wieder entfernen. + +<img width="600" alt="Startansicht" src={useBaseUrl('/images/ssp/2-Start-Ansicht.png')} /> + +Über den Menüpunkt <mark>Client hinzufügen</mark> können neue API-Clients zu Ihren Konto hinzugefügt werden. + +<img width="600" alt="Client-Verwaltung mit eingerichteten Clients" src={useBaseUrl('/images/ssp/6-Clientverwaltung.png')} /> + +Hierbei wird zwischen **Sendern** und **Subscribern** unterschieden. +**Sender** repräsentieren dabei technische Systeme, die Einreichungen über die Submission-API des Zustelldiensts vornehmen. +**Subscriber** stellen technische Systeme dar, die Einreichungen auf Verwaltungsseite entgegennehmen und bearbeiten. + +### Sender hinzufügen + +Mit Auswahl der Optionsschaltfläche <mark>Sender</mark> und Eingabe einer Bezeichnung und anschließender Betätigung wird ein Client von Typ **Sender** angelegt. + +<img width="600" alt="Neuen OAuth-API-Client vom Typ: Sender hinzufügen" src={useBaseUrl('/images/ssp/3-Client-hinzufuegen-Sender.png')} /> + +Das Self-Service-Portal generiert daraufhin **Client-ID** und **Client-Secret**. +Die **Client-ID** stellt dabei einen öffentlichen, im FIT-Connect Umfeld einzigartigen Identifikator für eine Anwendungen dar. +Das **Client-Secret** wiederum ist ein Geheimnis, welches nur der Anwendung und dem OAuth-Server bekannt ist. +Mit Hilfe von Client-ID und Client-Secret können API-Clients anschließend OAuth Access Tokens [beim OAuth-Dienst abrufen](getting-started/authentication), die zum Zugriff auf die FIT-Connect Submission API berechtigen. + +Für den Zugriff auf die Submission API werden Berechtigungen in Form von OAuth-Scopes verwaltet. +Jedem **API-Client** werden zu diesem Zweck ein oder mehrere OAuth-Scopes zugeordnet. + +Für **Sender** legen diese fest, ob ein sendendes System eine Einreichung an einen bestimmten Zustellpunkt übermitteln darf. +In der Testphase ist dieser mit `send:region:DE` vorbefüllt. +Dies erlaubt eine Antragstellung bei allen in FIT-Connect registrierten **Subscribern**. + +<img width="600" alt="OAuth-API-Client vom Typ: Sender" src={useBaseUrl('/images/ssp/4-Client-hinzufuegen-Sender2.png')} /> + +Weitere Informationen zu den Scopes von sendenden Systemen finden Sie unter [OAuth-Scopes für sendende Systeme](details/authentication/scopes-sender). + +### Subscriber hinzufügen + +Mit Auswahl der Optionsschaltfläche <mark>Subscriber</mark> und Eingabe einer Bezeichnung und anschließender Betätigung wird ein Client von Typ **Sender** angelegt. + +<img width="600" alt="Neuen OAuth-API-Client vom Typ: Subscriber hinzufügen" src={useBaseUrl('/images/ssp/3b-Client-hinzufuegen-Subscriber.png')} /> + +Das Self-Service-Portal generiert daraufhin **Client-ID** und **Client-Secret**. +Die **Client-ID** stellt dabei einen öffentlichen, im FIT-Connect Umfeld einzigartigen Identifikator für eine Anwendungen dar. +Das **Client-Secret** wiederum ist ein Geheimnis, welches nur der Anwendung und dem OAuth-Server bekannt ist. +Mit Hilfe von Client-ID und Client-Secret können API-Clients anschließend OAuth Access Tokens [beim OAuth-Dienst abrufen](getting-started/authentication), die zum Zugriff auf die FIT-Connect Submission API berechtigen. + +Für den Zugriff auf die Submission API werden Berechtigungen in Form von OAuth-Scopes verwaltet. +Jedem **API-Client** werden zu diesem Zweck ein oder mehrere OAuth-Scopes zugeordnet. + +**Subscribern** wird initial kein OAuth-Scope zugeordnet. Dieser wird durch Zuordnung einer oder mehrerer Zustellpunkten (Destinations) bestimmt und berechtigt den API-Client zum Abruf von Einreichungen bei einem oder mehreren Zustellpunkten. + +<img width="600" alt="OAuth-API-Client vom Typ: Subscriber" src={useBaseUrl('/images/ssp/4b-Client-hinzufuegen-Subscriber2.png')} /> + +Weitere Informationen zu den Scopes von empfangenden Systemen finden Sie unter [OAuth-Scopes für empfangende Systeme](details/authentication/scopes-subscriber). + +### Clients bearbeiten und löschen + +Durch einen Klick auf die <mark>Client-ID</mark> in der Client-Verwaltung öffnet sich die Detailansicht für den ausgewälten Client. + +<img width="600" alt="Detailansicht von Clients, hier ein Sender" src={useBaseUrl('/images/ssp/18-Client-Detailansicht-Sender.png')} /> + +Durch einen Klick auf <mark>bearbeiten</mark> öffnet sich die Bearbeitungsansicht. Hier kann derzeit die Bezeichnung des Clients angepasst werden. + +<img width="600" alt="Client bearbeiten" src={useBaseUrl('/images/ssp/5-Client-bearbeiten.png')} /> + +Durch einen Klick auf <mark>löschen</mark> öffnet sich hingegen ein Kontrolldialog, in dem das Löschen bestätigt werden muss. + +<img width="600" alt="Client löschen" src={useBaseUrl('/images/ssp/15-Client-loeschen.png')} /> diff --git a/docs/getting-started/authentication.mdx b/docs/getting-started/authentication.mdx index 54a598d4c448d7051571b10aae2997ec26050b8d..3a57f6cef87cd8c00aff23323ac3a124ee13b917 100644 --- a/docs/getting-started/authentication.mdx +++ b/docs/getting-started/authentication.mdx @@ -9,7 +9,7 @@ Nachfolgend wird der Abruf von Access Tokens beim OAuth-Dienst sowie der Zugriff Fast alle Anfragen an die FIT-Connect Submission API müssen authentifiziert werden. Hierfür ist ein Access Token notwendig, das beim OAuth-Dienst über die hierfür vorgesehene `Token URL` abgerufen werden kann (siehe Abschnitt `AUTHENTICATION` in der [Schnittstellenspezifikation](../apis/delivery-service)). -Für den Abruf von Access Tokens ist die [Konfiguration eines API-Client im Self-Service-Portal](../account.md) nötig. +Für den Abruf von Access Tokens ist die [Konfiguration eines API-Client im Self-Service-Portal](../account.mdx) nötig. Das Token kann anschließend bei Anfragen über den `Authentication` Header mitgeschickt werden. Da ein Token **max. 30 Minuten** gültig ist, muss dieses rechtzeitig erneuert werden. diff --git a/docs/getting-started/overview.md b/docs/getting-started/overview.md index cb547aa5292a37aaa5da4c8493a709c22cae6880..c4a99f5816d3c852089ba5b85bb36b5cbd971347 100644 --- a/docs/getting-started/overview.md +++ b/docs/getting-started/overview.md @@ -4,7 +4,7 @@ Im folgenden "Getting Started"-Guide wird beschrieben, wie die ersten Interaktio In den nächsten Abschnitten wird beschrieben, wie man sich gegenüber FIT-Connect authentifiziert, Daten für die Übertragung ver- und entschlüsselt werden, sowie welche Schritte für das Einreichen bzw. Empfangen von Einreichungen notwendig sind. :::note Hinweis -Als Voraussetzungen hierfür ist es notwendig einen Account zu besitzen, wie in "[Registrierung und Account-Verwaltung](../account.md)" beschrieben ist. +Als Voraussetzungen hierfür ist es notwendig einen Account zu besitzen, wie in "[Registrierung und Account-Verwaltung](../account.mdx)" beschrieben ist. ::: Kern von FIT-Connect ist der Zustelldienst, der sendende und empfangende Systeme einer Einreichung verbindet. diff --git a/docs/getting-started/receiving/destination.mdx b/docs/getting-started/receiving/destination.mdx index 259b3d6b41ba6d131ee2f6f8924849922924315b..4ced44d8b41977840e306f45576c7794c631a851 100644 --- a/docs/getting-started/receiving/destination.mdx +++ b/docs/getting-started/receiving/destination.mdx @@ -5,47 +5,94 @@ title: 🚧 Zustellpunkt anlegen import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' +import useBaseUrl from '@docusaurus/useBaseUrl'; Um Einreichungen über FIT-Connect zu empfangen, muss zunächst ein Zustellpunkt 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 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. +Entsprechende organisatorische und technische Hinweise zu Aktivierung werden an dieser Stelle noch ergänzt. ::: ## Zustellpunkt anlegen -:::caution -In der finalen API wird eine Anlage der eines neuen Zustellpunkts nur über das Self-Service-Portal möglich sein. -::: +Unter einem Zustellpunkt (Destination) versteht sich ein technisch eindeutig adressierbarer Endpunkt zur Einreichung von Anträgen oder Berichten an die Verwaltung über die FIT-Connect Übermittlungsinfrastruktur. +Jeder Zustellpunkt muss einem Subscriber-API-Client zugeordnet werden. +Ein Zustellpunkt repräsentiert dabei typischerweise einen Subscriber-Client (Fachverfahren oder virtuelle Poststelle). Es ist jedoch möglich einem empfangenden System (API-Client) multiple Zustellpunkte zuzuordnen. + +Über die Destination-Verwaltung lassen sich neue Zustellpunkte anlegen, bereits hinzugefügt Destinations verwalten und auch wieder entfernen. + +<img width="600" alt="Destinationverwaltung" src={useBaseUrl('/images/ssp/7-Destinationverwaltung.png')} /> + +Über den Menüpunkt <mark>Destination hinzufügen</mark> können neue Destinations zu Ihren Konto hinzugefügt werden. + +<img width="800" alt="Formular zum Anlegen einer neuer Destination" src={useBaseUrl('/images/ssp/8-Destination-hinzufuegen.png')} /> + +Ein Zustellpunkt benötigt zur Erstellung eine Vielzahl von Angaben, die sich im Wesentlichen auf Kontaktdaten, technische Angaben und Service aufteilen. + +Unter den unter dem Punkt Kontaktdaten abgefragten Informationen werden Details zur Antragempfangenden Instanz erfasst. Sämtliche Felder sind dabei aktuell noch Fließtext. Unter der Funktionspostfachadresse wird eine E-Mail-Adresse erwartet. + +Unter den unter dem Punkt „Technische Angaben“ abgefragten Informationen werden neben einer Callback-URL auch öffentliche Schlüssel zur Signaturprüfung und Verschlüsselung erwartet. +Beide Schlüssel müssen im JSON-Format vorliegen und den Anforderderungen aus [Vorgaben für kryptographische Verfahren](https://docs.fitko.de/fit-connect/docs/details/crypto) entsprechen. +Ein Tool um schnell und einfach passende Schlüssel für Testzwecke zu generieren finden Sie unter #TODO: Link zum Tool und Doku-Artikel hinzufügen + +Unter den unter dem Punkt „Service“ abgefragten Informationen werden ein eindeutiger Leistungsindikator, eine Region aus der eine Anfrage zulässig ist sowie die URI des verwendeten Fachschemas erwartet. -## Vorbereitende Tätigkeiten für die Aktivierung eines Zustellpunktes +<img width="800" alt="Destination mit Beispieldaten befüllt" src={useBaseUrl('/images/ssp/9-Destination-hinzufuegen-befuellt.png')} /> +Wurden alle Informationen und Schlüssel in korrekter Form übergeben wird die Destination erstellt. + +<img width="600" alt="Destination wurde erfolgreich angelegt" src={useBaseUrl('/images/ssp/11-Destination-erfolgreich-angelegt.png')} /> + +:::caution Wichtig! 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. -Daher ist zwingend vor der Aktivierung ein API-Client anzulegen, der einen subscribe scope für diesen Zustellpunkt (bspw. `subscribe:destination:655c6eb6-e80a-4d7b-a8d2-3f3250b6b9b1`) besitzt. +Daher ist zwingend vor der Aktivierung eines Zustellpuntes [ein API-Client anzulegen](../../account) und diesem Zustellpunkt zuzuweisen (siehe nächster Abschnitt). +::: -## 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 Zustellpunkt (bspw. manage:destination:655c6eb6-e80a-4d7b-a8d2-3f3250b6b9b1) registriert sein. +## Zugriff auf Zustellpunkte einrichten {#add-destination-to-client} +Clients vom Typ **Subscriber** können Destinations zugeordnet werden. Der Client empfängt dann die für den Zustellpunkt bestimmten Anfragen. Durch einen Klick auf die <mark>Client-ID</mark> eines Clients vom Typ **Subscriber** in der Client-Verwaltung öffnet sich die Detailansicht. -**TO-DO: Lösungsneutrale Beschreibung der im Zustellpunkt zu hinterlegenden Informationen** +<img width="600" alt="Destination zu einem Client hinzufügen" src={useBaseUrl('/images/ssp/16-Destination-zu-Client-hinzufuegen.png')} /> -**TO-DO: Bearbeitung über die API gemäß der API V.1 Spec überarbeiten** +Unter Destinations werden alle verfügbaren oder bereits verknüpften Destinations angezeigt. Durch aktivieren des Kontrollkästchens vor der gewünschten Destinations öffnet sich der Bestätigungsdialog, um dem Client Zugriff auf die gewählte Destination zu geben. + +<img width="600" alt="Bestätigungsdialog um eine Destination zu einem Client hinzufügen" src={useBaseUrl('/images/ssp/16b-Destination-zu-Client-hinzufuegen.png')} /> + +Im Anschluss wird die hinzufügte Destination durch ein Häkchen im Kontrollkästchen gekennzeichnet. Zusätzlich wurde die Destination im Scope des Clients hinzugefügt. + +<img width="600" alt="Aktualisierter Scope des Clients" src={useBaseUrl('/images/ssp/16c-Destination-zu-Client-hinzufuegen.png')} /> + +## Zugriff auf Zustellpunkte entfernen +Bei Clients vom Typ **Subscriber** können ihnen zugeordnete Destinations auch wieder entfernt werden. Durch einen Klick auf das derzeit noch aktive und mit einem Häkchen gekennzeichnete Kontrollkästchen der zu entfernenden Destination, öffnet sich ein Kontrolldialog, in dem das Löschen bestätigt werden muss. + +<img width="600" alt="Kontrolldialog zum Entfernen des Zugriffs auf eine Destination" src={useBaseUrl('/images/ssp/17-Destination-vom-Client-entfernen.png')} /> + +Im Anschluss wird die entfernte Destination nicht länger durch ein Häkchen im Kontrollkästchen gekennzeichnet. Zusätzlich wurde die Destination im Scope des Clients entfernt. + +<img width="600" alt="Aktualisierter Scope des Clients" src={useBaseUrl('/images/ssp/17b-Destination-vom-Client-entfernen.png')} /> + +## Zustellpunkt bearbeiten und aktivieren + +Sobald ein Zustellpunkt über das Self-Service-Portal erstellt wurde und eine Destination-ID für diesen Zustellpunkt vergeben und dem Nutzer zugeordnet wurde, kann dieser entweder programmatisch über die API oder über das Self-Service-Portal bearbeitet werden. +Für die Bearbeitung über die API sind folgende Voraussetzung zu erfüllen: +- Die Software für die Bearbeitung des Zustellpunkts muss als API-Client angelegt und der Zugriff auf den angelegten Zustellpunkt [im Self-Service-Portal konfiguriert sein](#add-destination-to-client). <Tabs - defaultValue="curl" + defaultValue="ssp" values={[ - { label: 'curl', value: 'curl', }, { label: 'Self-Service-Portal', value: 'ssp', }, + { label: 'curl', value: 'curl', }, ] }> <TabItem value="curl"> +**TO-DO: Lösungsneutrale Beschreibung der im Zustellpunkt zu hinterlegenden Informationen** + +**TO-DO: Bearbeitung über die API gemäß der API V.1 Spec überarbeiten** + ```bash $ export SERVICE_URL=... $ export JWT_TOKEN=eyJhbGciOiJIUzI1NiJ9.eyJJc3N1Z...NL-MKFrDGvn9TvkA @@ -97,10 +144,22 @@ $ curl \ <TabItem value="ssp"> -:::caution -Das Self-Service-Portal befindet sich noch in der Konzeption und ist daher noch nicht dokumentiert. +:::caution Hinweis +Die Funktionalität zum bearbeiten von Zustellpunkten über das Self-Service-Portal wird derzeit noch umgesetzt. ::: </TabItem> </Tabs> + +## Zustellpunkt löschen + +Durch einen Klick auf die <mark>Destination-ID</mark> in der Destination-Verwaltung öffnet sich die Detailansicht für den ausgewälten Zustellpunkt. + +<img width="600" alt="Destination Detailansicht" src={useBaseUrl('/images/ssp/19-Destination-Detailansicht.png')} /> + +Durch einen Klick auf <mark>löschen</mark> öffnet sich ein Kontrolldialog, in dem das Löschen der Destination bestätigt werden muss. + +<img width="600" alt="Kontrolldialog zum Löschen einer Destination" src={useBaseUrl('/images/ssp/20-Destination-loeschen.png')} /> + +Hierbei ist zu Beachten, dass Destination nur dann gelöscht werden können, wenn sie mit keinem Client verknüpft sind. diff --git a/docs/getting-started/ssp.mdx b/docs/getting-started/ssp.mdx deleted file mode 100644 index 2d80f539e5968ebf36699377a81414bf53b85432..0000000000000000000000000000000000000000 --- a/docs/getting-started/ssp.mdx +++ /dev/null @@ -1,137 +0,0 @@ ---- -sidebar_position: 3 -title: 🚧 Zustellpunkt anlegen ---- -# Das Self-Service-Portal von FIT-Connect - -import useBaseUrl from '@docusaurus/useBaseUrl'; - -Das Self-Service-Portal von FIT-Connect erlaubt es Ländern, Kommunen oder interessierten IT-Dienstleistern über eine grafische Oberfläche mit wenigen Klicks OAuth-API-Clients anzulegen und Zustellpunkte, auch **Destinations** genannt, für ihre bereits bestehenden Fachverfahren und Verwaltungsleistungen zu registrieren. -OAuth-API-Clients müssen für jedes an FIT-Connect angebundene System registriert werden. -Das Anlegen eines Zustellpunktes ist dagegen nur für empfangende Systeme (Subscriber) notwendig. -Zustellpunkte können dann im Rahmen von FIT-Connect über den Antrags-Routingdienst gefunden werden. - -### Anmeldung am Service Portal - -Eine Nutzung des Self-Service-Portals setzt zwingend eine vorangehende Authentifizierung mit OAuth 2.0 über einen der unterstützten Identity Provider voraus. - -<img width="600" alt="Übersicht der aktuell unterstützten OAuth 2.0 Identiy Provider" src={useBaseUrl('/images/ssp/1-Login-Verfahren.png')} /> - -Nach erfolgreicher Authentifizierung wird die Startseite des Self-Service-Portals angezeit: Die Clientverwaltung. - -### Verwaltung von Clients - -Über die Client-Verwaltung lassen sich bereits hinzugefügt OAuthAPI-Clients verwalten, neue OAuthAPI-Clients anlegen und auch wieder entfernen. - -<img width="600" alt="Startansicht" src={useBaseUrl('/images/ssp/2-Start-Ansicht.png')} /> - -Über den Menüpunkt <mark>Client hinzufügen</mark> können neue OAuthAPI-Client zu Ihren Konto hinzugefügt werden. - -<img width="600" alt="Client-Verwaltung mit eingerichteten Clients" src={useBaseUrl('/images/ssp/6-Clientverwaltung.png')} /> - -Hierbei wird zwischen **Sendern** und **Subscribern** unterschieden. **Sender** repräsentieren dabei technische Systeme, die in Zukunft Einreichungen über die Submission-API des Zustelldiensts vornehmen. **Subscriber** stellen technische Systeme dar, die Einreichungen auf Verwaltungsseite entgegennehmen und bearbeiten. - -#### Sender hinzufügen - -Mit Auswahl der Optionsschaltfläche <mark>Sender</mark> und Eingabe einer Bezeichnung und anschließender Betätigung wird ein Client von Typ **Sender** angelegt. - -<img width="600" alt="Neuen OAuth-API-Client vom Typ: Sender hinzufügen" src={useBaseUrl('/images/ssp/3-Client-hinzufuegen-Sender.png')} /> - -Das Self-Service-Portal generiert daraufhin **Client ID** und **Client Secret**. Die **Client ID** stellt dabei einen öffentlichen, im FIT-Connect Umfeld einzigartigen Identifkator für Anwendungen dar. Das **Client Secret** wiederum ist ein Geheimnis, welches nur der Anwendung und dem OAuth-Server bekannt ist. - -**Sendern** wird ein Scope zugeordnet. Dieser legt fest aus welchem Kontext heraus Anfragen über diesen Client gestellt werden können. In der Testphase ist dieser mit send:region:DE vorbefüllt. - -<img width="600" alt="OAuth-API-Client vom Typ: Sender" src={useBaseUrl('/images/ssp/4-Client-hinzufuegen-Sender2.png')} /> - -Weitere Informationen zu den Scopes von sendenen Systemen finden Sie unter [OAuth-Scopes für sendende Systeme](https://docs.fitko.de/fit-connect/docs/details/authentication/scopes-sender/). - -#### Subscriber hinzufügen - -Mit Auswahl der Optionsschaltfläche <mark>Subscriber</mark> und Eingabe einer Bezeichnung und anschließender Betätigung wird ein Client von Typ **Sender** angelegt. - -<img width="600" alt="Neuen OAuth-API-Client vom Typ: Subscriber hinzufügen" src={useBaseUrl('/images/ssp/3b-Client-hinzufuegen-Subscriber.png')} /> - -Das Self-Service-Portal generiert daraufhin **Client ID** und **Client Secret**. Die **Client ID** stellt dabei einen öffentlichen, im FIT-Connect Umfeld einzigartigen Identifkator für Anwendungen dar. Das **Client Secret** wiederum ist ein Geheimnis, welches nur der Anwendung und dem OAuth-Server bekannt ist. - -**Subscribern** wird initial kein Scope zugeordnet. Dieser wird durch Zuordnung einer oder mehrerer Destinations bestimmt und legt fest von welchen Zustellpunkten Anfragen an den Client übermittelt werden dürfen. - -<img width="600" alt="OAuth-API-Client vom Typ: Subscriber" src={useBaseUrl('/images/ssp/4b-Client-hinzufuegen-Subscriber2.png')} /> - -Weitere Informationen zu den Scopes von empfangenden Systemen finden Sie unter [OAuth-Scopes für empfangende Systeme](https://docs.fitko.de/fit-connect/docs/details/authentication/scopes-subscriber). - -#### Clients bearbeiten und löschen - -Durch einen Klick auf die <mark>Client ID</mark> in der Client-Verwaltung öffnet sich die Detailansicht für den ausgewälten Client. - -<img width="600" alt="Detailansicht von Clients, hier ein Sender" src={useBaseUrl('/images/ssp/18-Client-Detailansicht-Sender.png')} /> - -Durch einen Klick auf <mark>bearbeiten</mark> öffnet sich die Bearbeitungsansicht. Hier kann derzeit die Bezeichnung des Clients angepasst werden. - -<img width="600" alt="Client bearbeiten" src={useBaseUrl('/images/ssp/5-Client-bearbeiten.png')} /> - -Durch einen Klick auf <mark>löschen</mark> öffnet sich hingegen ein Kontrolldialog, in dem das Löschen bestätigt werden muss. - -<img width="600" alt="Client löschen" src={useBaseUrl('/images/ssp/15-Client-loeschen.png')} /> - -#### Zugriff auf Destinations einrichten -Clients vom Typ **Subscriber** können Destinations zugeordnet werden. Der Client empfängt dann die für den Zustellpunkt bestimmten Anfragen. Durch einen Klick auf die <mark>Client ID</mark> eines Clients vom Typ **Subscriber** in der Client-Verwaltung öffnet sich die Detailansicht. - -<img width="600" alt="Destination zu einem Client hinzufügen" src={useBaseUrl('/images/ssp/16-Destination-zu-Client-hinzufuegen.png')} /> - -Unter Destinations werden alle verfügbaren oder bereits verknüpften Destinations angezeigt. Durch aktivieren des Kontrollkästchens vor der gewünschten Destinations öffnet sich der Bestätigungsdialog, um dem Client Zugriff auf die gewählte Destination zu geben. - -<img width="600" alt="Bestätigungsdialog um eine Destination zu einem Client hinzufügen" src={useBaseUrl('/images/ssp/16b-Destination-zu-Client-hinzufuegen.png')} /> - -Im Anschluss wird die hinzufügte Destination durch ein Häkchen im Kontrollkästchen gekennzeichnet. Zusätzlich wurde die Destination im Scope des Clients hinzugefügt. - -<img width="600" alt="Aktualisierter Scope des Clients" src={useBaseUrl('/images/ssp/16c-Destination-zu-Client-hinzufuegen.png')} /> - -#### Zugriff auf Destinations entfernen -Bei Clients vom Typ **Subscriber** können ihnen zugeordnete Destinations auch wieder entfernt werden. Durch einen Klick auf das derzeit noch aktive und mit einem Häkchen gekennzeichnete Kontrollkästchen der zu entfernenden Destination, öffnet sich ein Kontrolldialog, in dem das Löschen bestätigt werden muss. - -<img width="600" alt="Kontrolldialog zum Entfernen des Zugriffs auf eine Destination" src={useBaseUrl('/images/ssp/17-Destination-vom-Client-entfernen.png')} /> - -Im Anschluss wird die entfernte Destination nicht länger durch ein Häkchen im Kontrollkästchen gekennzeichnet. Zusätzlich wurde die Destination im Scope des Clients entfernt. - -<img width="600" alt="Aktualisierter Scope des Clients" src={useBaseUrl('/images/ssp/17b-Destination-vom-Client-entfernen.png')} /> - - -### Destination-Verwaltung - -Unter einer Destination versteht sich ein technisch eindeutig adressierbarer Endpunkt zur digitalen Einreichung von Anträgen oder Berichten an die Verwaltung über die FIT-Connect Übermittlungsinfrastruktur. Sie werden Subscriber-OAuth-API-Client zugeordnet. Ein Zustellpunkt repräsentiert dabei typischerweise einen Subscriber-Client (Fachverfahren oder virtuelle Poststelle). Es ist jedoch möglich einem empfangenden System multiple Zustellpunkte zuzuordnen. - -Über die Destination-Verwaltung lassen sich bereits hinzugefügt Destinations verwalten, neue Destinations anlegen und auch wieder entfernen. - -<img width="600" alt="Destinationverwaltung" src={useBaseUrl('/images/ssp/7-Destinationverwaltung.png')} /> - -#### Destination hinzufügen - -Über den Menüpunkt <mark>Destination hinzufügen</mark> können neue Destinations zu Ihren Konto hinzugefügt werden. - -<img width="800" alt="Formular zum Anlegen einer neuer Destination" src={useBaseUrl('/images/ssp/8-Destination-hinzufuegen.png')} /> - -Ein Zustellpunkt benötigt zur Erstellung eine Vielzahl von Angaben, die sich im Wesentlichen auf Kontaktdaten, Technische Angaben und Service aufteilen. - -Unter den unter dem Punkt Kontaktdaten abgefragten Informationen werden Details zur Antragempfangenden Instanz erfasst. Sämtliche Felder sind dabei aktuell noch Fließtext. Unter der Funktionspostfachadresse wird eine E-Mail-Adresse erwartet. - -Unter den unter dem Punkt Technische Angaben abgefragten Informationen werden neben einer Callback-URL auch öffentliche Schlüssel zur Signaturprüfung und Verschlüsselung erwartet. Beide Schlüssel müssen im JSON-Format vorliegen und den Anforderderungen aus [Vorgaben für kryptographische Verfahren](https://docs.fitko.de/fit-connect/docs/details/crypto) entsprechen. Ein Tool um schnell und einfach passende Schlüssel für Testzwecke zu generieren finden Sie unter #TODO: Link zum Tool hinzufügen - -Unter den unter dem Punkt Service abgefragten Informationen werden ein eindeutiger Leistungsindikator, eine Region aus der eine Anfrage zulässig ist sowie die URI des verwendeten Fachschemas erwartet. - -<img width="800" alt="Destination mit Beispieldaten befüllt" src={useBaseUrl('/images/ssp/9-Destination-hinzufügen-befuellt.png')} /> - -Wurden alle Informationen und Schlüssel in korrekter Form übergeben wird die Destination erstellt. - -<img width="600" alt="Destination wurde erfolgreich angelegt" src={useBaseUrl('/images/ssp/11-Destination-erfolgreich-angelegt.png')} /> - -#### Destination löschen - -Durch einen Klick auf die <mark>Destination ID</mark> in der Destination-Verwaltung öffnet sich die Detailansicht für den ausgewälten Zustellpunkt. - -<img width="600" alt="Destination Detailansicht" src={useBaseUrl('/images/ssp/19-Destination-Detailansicht.png')} /> - -Durch einen Klick auf <mark>löschen</mark> öffnet sich ein Kontrolldialog, in dem das Löschen der Destination bestätigt werden muss. - -<img width="600" alt="Kontrolldialog zum Löschen einer Destination" src={useBaseUrl('/images/ssp/20-Destination-loeschen.png')} /> - -Hierbei ist zu Beachten, dass Destination nur dann gelöscht werden können, wenn sie mit keinem Client verknüpft sind. diff --git a/static/images/ssp/18-Client-Detailansicht_Sender.png b/static/images/ssp/18-Client-Detailansicht-Sender.png similarity index 100% rename from static/images/ssp/18-Client-Detailansicht_Sender.png rename to static/images/ssp/18-Client-Detailansicht-Sender.png