Accountregistrierung und Client-Verwaltung

Das Self-Service-Portal (SSP) von FIT-Connect erlaubt es Ländern, Kommunen und IT-Dienstleistern, Clients und Zustellpunkte anzulegen. Clients müssen für jedes angebundene System angelegt werden (für Sender und Empfänger), Zustellpunkte dagegen nur für Empfänger. Die Seite Anlegen eines Zustellpunktes zeigt, wie Sie für Empfänger (Subscriber) Zustellpunkte anlegen.

Testumgebung: Das Self-Service-Portal der Testumgebung steht allen Interessierten zur Registrierung von API-Clients für die Testinstanz des FIT-Connect Zustelldienstes zur Verfügung.

Anmeldung am Self-Service-Portal (SSP)

Eine Nutzung des Self-Service-Portals (SSP) setzt eine Authentifizierung über einen Identity Provider voraus (siehe folgendes Bild).

Zugang zum SSP in der Testumgebung

Username/Passwort erforderlich

In der Testumgebung ist die Authentifizierung per Username und Passwort über Ihren Account bei GitHub, GitLab.com oder OpenCoDE möglich. Ein Account auf der OpenCoDE-Plattform der öffentlichen Verwaltung kann selbstständig über das Registrierungsformular erstellt werden. Eine Registrierung über das GitLab der FITKO wird ab der Stageumgebung unterstützt. Bestehende Registrierungen über das GitLab der FITKO können Sie weiterhin nutzen.

Zugang zum SSP in der Stage- und Produktiv-Umgebung

Für die Stage- und Produktiv-Umgebung ist Elster erforderlich

Für den Zugang zum Self-Service-Portal in der Stage- und Produktivumgebung ist ein Unternehmenskonto bei Elster erforderlich. Der bisherige Zugang über Username/Passwort und der Zwei-Faktor-Authentifizierung ist ab Mitte Mai 2024 nicht mehr möglich. Die Seite Login über Elster beschreibt, wie Sie Zugang erhalten zur Stage- und Produktiv-Umgebung von FIT-Connect.

Nach erfolgreicher Authentifizierung wird die Startseite des Self-Service-Portals angezeigt: Die Clientverwaltung.

Zugang zum SSP in der Stage- und Produktivumgebung (bislang)

Username/Passwort und Zwei-Faktor-Authentifizierung erforderlich

Für den Zugang zum Self-Service-Portal in der Stage- und Produktivumgebung ist zusätzlich zur Anmeldung per Username und Passwort eine Zwei-Faktor-Authentifizierung erforderlich. Eine Beschreibung der Zwei-Faktor-Authentifizierung finden Sie hier. Anbei eine Schritt für Schritt Anleitung zum Umgang mit der 2-Faktor-Authentifizierung ab der Stageumgebung für die Erstnutzung:

1. Mail von GitLab erhalten
2. In dieser Mail auf den Link für die Berechtigungsgruppe klicken
3. Mit der personalisierten Mailadresse und Passwort anmelden. a. Falls dies einen Fehler aufwirft, auf „Passwort zurücksetzen“ klicken und ein neues Passwort anfordern.
4. Nach dem erfolgreichen Login die 2-Faktor-Authentifizierung einrichten.
5. Nach erfolgreicher Einrichtung der 2-Faktor-Authentifizierung Login in der Stage- oder Produktivumgebung.

Verwaltung von API-Clients

Ü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.

Im Video erklären wir Ihnen die Clientübersicht.

Über Client anlegen können neue API-Clients zu Ihren Konto hinzugefügt werden.

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.

Im Video zeigen wir Ihnen die Client-Anlegung.

Sender hinzufügen

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.

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, 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.

Weitere Informationen zu den Scopes von sendenden Systemen finden Sie unter OAuth-Scopes für sendende Systeme.

Im Video zeigen wir Ihnen die Sender-Client-Anlegung.

Subscriber hinzufügen

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 Subscriber angelegt.

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, 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.

Weitere Informationen zu den Scopes von empfangenden Systemen finden Sie unter OAuth-Scopes für empfangende Systeme.

Im Video zeigen wir Ihnen die Subscriber-Client-Anlegung.

Zudem ist nachfolgend die Client Secret Erneuerung beschrieben.

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.

Durch einen Klick auf Client editieren öffnet sich die Bearbeitungsansicht.
Hier kann die Bezeichnung des Clients angepasst werden. Zudem ist es möglich, die Destination Management API für diesen Subscriber-Client zu nutzen, sodass Sie diese API verwenden können, um neue Zustellpunkte anzulegen, die diesem Client zugeordnet sind. Dies ist ein optionales Feature.
Unter "Erlaubte Zustellpunkte" können Sie diesem Subscriber-Client durch einen Klick Zustellpunkte zuordnen. Im Beispiel kann ein Zustellpunkt diesem Client zugeordnet werden, siehe folgendes Bild:

Durch einen Klick auf Client löschen öffnet sich hingegen ein Kontrolldialog, in dem das Löschen bestätigt werden muss.