Skip to content
Snippets Groups Projects
Commit a1394259 authored by Michael Haidner's avatar Michael Haidner
Browse files

Navigation erweitert um Kategorie 'Infos für Verantwortliche'

parent 03345c1b
No related branches found
No related tags found
1 merge request!216599-Dokumentation_Kuerzen_der_Seite_Fachverfahren_anmelden (planning#599)
...@@ -14,7 +14,7 @@ Die Zertifikate enthalten öffentliche und private Schlüssel für Verschlüssel ...@@ -14,7 +14,7 @@ Die Zertifikate enthalten öffentliche und private Schlüssel für Verschlüssel
#### Überblick #### Überblick
Das Beantragen von Zertifikaten ist eine Aufgabe, die Verantwortliche für Fachverfahren beachten müssen, um Fachverfahren an FIT-Connect anzubinden. Das Beantragen von Zertifikaten ist eine Aufgabe, die Verantwortliche für Fachverfahren beachten müssen, um Fachverfahren an FIT-Connect anzubinden.
Alle Aufgaben sind [hier im Überblick](publish_destination) aufgelistet. <br/> Alle Aufgaben sind [hier im Überblick](./publish_destination) aufgelistet. <br/>
:::note Hinweis :::note Hinweis
Pro Fachverfahren ist ein Zertifikat der Verwaltungs-PKI erforderlich, um ein Fachverfahren an das Produktivsystem anzubinden. <br/> Pro Fachverfahren ist ein Zertifikat der Verwaltungs-PKI erforderlich, um ein Fachverfahren an das Produktivsystem anzubinden. <br/>
......
...@@ -39,7 +39,7 @@ Die rechtlichen Vertreter:innen eines Fachverfahrens, die FIT-Connect für ihre ...@@ -39,7 +39,7 @@ Die rechtlichen Vertreter:innen eines Fachverfahrens, die FIT-Connect für ihre
Die FITKO legt anschließend für das Fachverfahren einen Account für FITKO-Gitlab an, sodass Sie auf dem Self-Service-Portal der Produktivumgebung Daten pflegen können (oder ein von Ihnen beauftragter Mitarbeiter oder Dienstleister pflegt die Daten). Die FITKO legt anschließend für das Fachverfahren einen Account für FITKO-Gitlab an, sodass Sie auf dem Self-Service-Portal der Produktivumgebung Daten pflegen können (oder ein von Ihnen beauftragter Mitarbeiter oder Dienstleister pflegt die Daten).
### 2. Beantragen Sie Zertifikate der Verwaltungs-PKI. ### 2. Beantragen Sie Zertifikate der Verwaltungs-PKI.
Wie Sie Zertifikate beantragen, das ist [hier](apply-for-certificates) beschrieben. Wie Sie Zertifikate beantragen, das ist [hier](./apply-for-certificates) beschrieben.
### 3. Zustellpunkt und API-Client anlegen ### 3. Zustellpunkt und API-Client anlegen
Beauftragen Sie Administrator:innen Ihrer Behörde (oder Dienstleister) damit, einen Zustellpunkt und einen API-Client des Typs "Subscriber" anzulegen. Hierfür benötigen die Administrator:innen die Zertifikate, die Sie im Schritt 2 erhalten haben. <br/> Beauftragen Sie Administrator:innen Ihrer Behörde (oder Dienstleister) damit, einen Zustellpunkt und einen API-Client des Typs "Subscriber" anzulegen. Hierfür benötigen die Administrator:innen die Zertifikate, die Sie im Schritt 2 erhalten haben. <br/>
......
---
title: Onlinedienste / Softwareprogramme anbinden
---
import useBaseUrl from '@docusaurus/useBaseUrl';
# Onlinedienste
### Aufgaben für die Anbindung an das Produktivsystem
:::note Hinweis
Vor der Anbindung an das Produktivsystem von FIT-Connect ist es erforderlich, Ihren Onlinedienst mit der Testumgebung von FIT-Connect zu testen. Für den Zugang zur Testumgebung ist keine Anmeldung bei der FITKO erforderlich. <br/>
:::
Als Verantwortliche für einen Onlinedienst (eine Antragsplattform oder ein Softwareprogramm) müssen Sie die folgenden Aufgaben beachten, um ein System an die Produktivumgebung von FIT-Connect anzubinden (Überblick)::
1. Beantragen Sie bei der FITKO einen Zugang zum Produktivsystem für FIT-Connect. <br/>
Die rechtlichen Voraussetzungen sind unter [Punkt 1](#1-rechtliche-voraussetzung) beschrieben.
2. API-Client für Sender <br/>
Verantwortliche für Onlinedienste (Antragsplattformen und Softwareprogramme), die Einreichungen über FIT-Connect senden wollen, müssen ihre Systeme bei FIT-Connect registrieren. <br/>
Dazu dient das Self-Service-Portal, das Sie über die Schaltfläche "Self-Service-Portal" oben rechts auf dieser Seite erreichen. <br/>
Diese [Beschreibung](./publish_destination#self-service-portal-ssp) zeigt, wie Sie sich beim Self-Service-Portal anmelden. <br/>
### 1. Rechtliche Voraussetzung erfüllen
Die rechtliche Voraussetzung für eine Anbindung an das Produktivsystem ist ein gültiger Auftragsdatenverarbeitungsvertrag (AVV) mit der FITKO. <br/>
Nach Abschluss des Vertrags erstellt die FITKO für den Onlinedienst einen Account für FITKO-Gitlab. Damit kann im Self-Service-Portal ein API-Client angelegt werden (siehe folgenden Punkt):
### 2. API-Client für Sender anlegen
Legen Sie im Self-Service-Portal einen Client des Typs "Sender" an. <br/>
Dazu klicken Sie in der Ansicht "Client anlegen", bei der Auswahl der Art des Clients, auf "Sender". <br/>
Geben Sie eine Bezeichnung für den Client ein. Weitere Angaben sind für API-Clients des Typs "Sender" nicht erforderlich. <br/>
Um den neuen API-Client anzulegen, klicken Sie auf die Schaltfläche "Anlegen". <br/>
<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.mdx), 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. <br/>
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.md).
#### Clients bearbeiten und löschen
Durch einen Klick auf die **Client-ID** in der Client-Verwaltung öffnet sich die Detailansicht für den ausgewählten Client.
<img width="600" alt="Detailansicht von Clients, hier ein Sender" src={useBaseUrl('/images/ssp/4-Client-hinzufuegen-Sender2.png')} />
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 **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')} />
module.exports = { module.exports = {
defaultSidebar: [ defaultSidebar: [
'intro', 'intro',
{
type: 'category',
label: 'Infos für Verantwortliche',
items: [
'organisation-tasks/publish_destination',
'organisation-tasks/register_onlineservice',
'organisation-tasks/apply-for-certificates',
],
},
'changelog', 'changelog',
'glossary', 'glossary',
'roadmap', 'roadmap',
......
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