Skip to content
Snippets Groups Projects
Commit dbfe1d1c authored by Florian Kaufmann's avatar Florian Kaufmann
Browse files

Merge branch 'fix-missing-v1-doc-updates' into 'main'

Neuerstellen der v1 docu um die fehlenden docus updates reinzubekommen.

See merge request !82
parents 8a7a56f0 6b8eb04e
No related branches found
No related tags found
1 merge request!82Neuerstellen der v1 docu um die fehlenden docus updates reinzubekommen.
......@@ -4,7 +4,7 @@ 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.
Das [Anlegen eines Zustellpunktes](getting-started/receiving/destination.mdx) ist dagegen nur für empfangende Systeme (Subscriber) notwendig.
Zustellpunkte können dann im Rahmen von FIT-Connect über den Antrags-Routingdienst gefunden werden.
**Testumgebung**: Das [Self-Service-Portal der Testumgebung](https://portal.auth-testing.fit-connect.fitko.dev/) steht allen Interessierten zur Registrierung von API-Clients für die Testinstanz des FIT-Connect Zustelldienstes zur Verfügung.
......@@ -20,11 +20,12 @@ Nach erfolgreicher Authentifizierung wird die Startseite des Self-Service-Portal
## 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.
Über **Clients** lässt sich die Client-Verwaltung aufrufen.
Hier 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.
Über **Client anlegen** 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')} />
......@@ -34,7 +35,7 @@ Hierbei wird zwischen **Sendern** und **Subscribern** unterschieden.
### 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.
Mit **Client anlegen**, Auswahl der Art des Clients als **Sender**, Eingabe einer Bezeichnung und anschließender Betätigung mit **Anlegen** 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')} />
......@@ -56,7 +57,7 @@ Weitere Informationen zu den Scopes von sendenden Systemen finden Sie unter [OAu
### 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.
Mit **Client anlegen**, Auswahl der Art des Clients als **Subscriber**, Eingabe einer Bezeichnung und anschließender Betätigung mit **Anlegen** 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')} />
......@@ -76,14 +77,14 @@ Weitere Informationen zu den Scopes von empfangenden Systemen finden Sie unter [
### 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.
Durch einen Klick auf die **Client-ID** 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')} />
<img width="600" alt="Detailansicht von Clients, hier ein Sender" src={useBaseUrl('/images/ssp/4-Client-hinzufuegen-Sender2.png')} />
Durch einen Klick auf <mark>bearbeiten</mark> öffnet sich die Bearbeitungsansicht. Hier kann derzeit die Bezeichnung des Clients angepasst werden.
Durch einen Klick auf **Client editieren** öffnet sich die Bearbeitungsansicht. Hier kann 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.
Durch einen Klick auf **Client löschen** ö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')} />
......@@ -5,4 +5,4 @@ hide_table_of_contents: true
import JSONSchema from '@site/src/components/JSONSchema'
<JSONSchema version = {"1.*.*"} />
<JSONSchema version = {"1.*.*"}/>
......@@ -6,14 +6,19 @@ Ziel von FIT-Connect ist es, ein möglichst einfaches, sicheres und klar definie
Deshalb erfolgt eine Übertragung von Antragsdaten mit FIT-Connect ausschließlich verschlüsselt.
## Warum ist Ende-zu-Ende-Verschlüsselung wichtig?
Im Kontext von Anträgen an Behörden werden häufig höchstsensible personenbezogene Daten übermittelt.
Auf grund ihres hohen Schutzbedarfs dürfen solche Daten nach den [Vorgaben des BSI](https://www.bsi.bund.de/SharedDocs/Downloads/DE/BSI/Publikationen/TechnischeRichtlinien/TR03107/TR-03107-1.pdf?__blob=publicationFile&v=4) nur Ende-zu-Ende-verschlüsselt übertragen werden.
Im Kontext von Anträgen an Behörden werden häufig personenbezogene Daten übermittelt.
Solche Daten dürfen nach den [Vorgaben des BSI](https://www.bsi.bund.de/SharedDocs/Downloads/DE/BSI/Publikationen/TechnischeRichtlinien/TR03107/TR-03107-1.pdf?__blob=publicationFile&v=4) nur Ende-zu-Ende-verschlüsselt übertragen werden.
Die FIT-Connect Architektur unterstützt dafür zwei Umsetzungs-Varianten - abhängig vom Schutzbedarf der zu übermittelnden Daten.
<img src={useBaseUrl('/images/encryption/tls-no-tls.png')} alt="Grafik zur Veranschaulichung einer Ende-zu-Ende-Verschlüsselung" width="600" />
<img src={useBaseUrl('/images/encryption/ende-zu-ende.png')} alt="Grafik zur Veranschaulichung einer Ende-zu-Ende-Verschlüsselung" width="600" />
FIT-Connect verwendet zur Absicherung der Übertragung von Antragsdaten und Antragsmetadaten eine auf asymmetrischer Kryptographie basierenden Ende-zu-Ende-Verschlüsselung.
Abgesehen von denen für die Übermittlung zwingend notwendigen Daten können so nur die Zielbehörde bzw. das Ziel-Fachverfahren die Antragsdaten und Antragsmetadaten entschlüsseln und lesen.
Bei der Umsetzung einer Ende-zu-Ende-Verschlüsselung zwischen dem Endgerät der Nutzer:in und der zuständigen Fachbehörde verlassen sämtliche Inhaltsdaten das Endgerät der Nutzer:in immer verschlüsselt.
Für besonders schutzbedürftige personenbezogene Daten ist es notwendig, dass die Antragsdaten bereits auf dem Endgerät der Anwender:in verschlüsselt werden.
Dafür stehen Anbietern von Online-Antragsverfahren eine Vielzahl von Bibliotheken zu Verfügung, um die erforderlichen Operationen im Browser der Anwender:in auszuführen.
So verlassen sämtliche Inhaltsdaten das Endgerät der Nutzer:in immer verschlüsselt.
Beispiele wie Anträge im Rahmen von FIT-Connect verschlüsselt werden können, finden Sie unter [Verschlüsselung](https://docs.fitko.de/fit-connect/docs/next/getting-started/sending/encrypt/).
## Grundlagen zur eingesetzten Verschlüsselung
......
......@@ -39,21 +39,21 @@ Beispiele für das Ermitteln der benötigten Daten:
$ export SERVICE_URL=...
$ curl \
-H "Content-Type: application/json" \
-X GET $SERVICE_URL/v1/routes?leika-key=99010003001006&ags=15085055
-X GET $SERVICE_URL/v1/routes?leikaKey=99010003001006&ags=15085055
```
```bash
$ export SERVICE_URL=...
$ curl \
-H "Content-Type: application/json" \
-X GET $SERVICE_URL/v1/routes?leika-key=99010003001006&ars=150850055055
-X GET $SERVICE_URL/v1/routes?leikaKey=99010003001006&ars=150850055055
```
```bash
$ export SERVICE_URL=...
$ curl \
-H "Content-Type: application/json" \
-X GET $SERVICE_URL/v1/routes?leika-key=99010003001006&area-id=15529
-X GET $SERVICE_URL/v1/routes?leikaKey=99010003001006&areaId=15529
```
</TabItem>
......@@ -189,7 +189,7 @@ Das Ergebnis der Anfrage enthält daher neben der eigentlichen (Teil-)Ergebnisme
Die zurückgegebene Teilergebnismenge ist standardmäßig auf 100 Einträge limitiert und kann über den GET-Parameter `limit` auf maximal 500 Einträge erweitert werden.
Über den GET-Paramter `offset` können weitere Teilmengen der Ergebnismenge ermittelt werden.
Die `id` eines Gebietes aus der Ergebnismenge kann im Endpunkt [/routes](../../apis/routing-api.mdx#get-/routes) als Identifikator (`area-id`) eines verwaltungspolitischen Gebietes verwendet werden.
Die `id` eines Gebietes aus der Ergebnismenge kann im Endpunkt [/routes](../../apis/routing-api.mdx#get-/routes) als Identifikator (`areaId`) eines verwaltungspolitischen Gebietes verwendet werden.
Beispiele für die Suche:
......@@ -208,7 +208,7 @@ Suche mit Postleitzahlanfang
$ export SERVICE_URL=...
$ curl \
-H "Content-Type: application/json" \
-X GET $SERVICE_URL/v1/areas?area-searchexpression=061*
-X GET $SERVICE_URL/v1/areas?areaSearchexpression=061*
```
Suche mit Name
......@@ -217,7 +217,7 @@ Suche mit Name
$ export SERVICE_URL=...
$ curl \
-H "Content-Type: application/json" \
-X GET $SERVICE_URL/v1/areas?area-searchexpression=Halle
-X GET $SERVICE_URL/v1/areas?areaSearchexpression=Halle
```
Suche mit Name und Postleitzahl
......@@ -226,7 +226,7 @@ Suche mit Name und Postleitzahl
$ export SERVICE_URL=...
$ curl \
-H "Content-Type: application/json" \
-X GET $SERVICE_URL/v1/areas?area-searchexpression=06108&area-searchexpression=Halle
-X GET $SERVICE_URL/v1/areas?areaSearchexpression=06108&areaSearchexpression=Halle
```
</TabItem>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment