Zum Hauptinhalt springen
Version: FIT-Connect_v1

Accountregistrierung und Client-Verwaltung

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.

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#

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.

Übersicht der aktuell unterstützten OAuth 2.0 Identiy Provider

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

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.

Startansicht

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

Client-Verwaltung mit eingerichteten Clients

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

Neuen OAuth-API-Client vom Typ: Sender hinzufügen

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.

OAuth-API-Client vom Typ: Sender

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

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

Neuen OAuth-API-Client vom Typ: Subscriber hinzufügen

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.

OAuth-API-Client vom Typ: Subscriber

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

Clients bearbeiten und löschen#

Durch einen Klick auf die Client-ID in der Client-Verwaltung öffnet sich die Detailansicht für den ausgewälten Client.

Detailansicht von Clients, hier ein Sender

Durch einen Klick auf Client editieren öffnet sich die Bearbeitungsansicht. Hier kann die Bezeichnung des Clients angepasst werden.

Client bearbeiten

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

Client löschen