Onlinedienste anbinden

Aufgaben zur Anbindung an das Produktivsystem

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.

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.
   Die rechtlichen Voraussetzungen sind unter Punkt 1 beschrieben.

2. API-Client für Sender
   Verantwortliche für Onlinedienste (Antragsplattformen und Softwareprogramme), die Einreichungen über FIT-Connect senden wollen, müssen für ihre Systeme API-Clients anlegen. Eine Beschreibung dazu finden Sie hier.
   Sie legen API-Clients im Self-Service-Portal (SSP) der FITKO an. Das SSP erreichen Sie über die Schaltfläche "Self-Service-Portal" oben rechts auf dieser Seite. Wie Sie sich beim SSP anmelden, das ist hier beschrieben.
   

1. Rechtliche Voraussetzung erfüllen

Schließen Sie mit der FITKO einen Auftragsverarbeitungsvertrag (AVV) und Nutzungsbedingungen. Die aktuellen Dokumente erhalten Sie bei Bedarf vom Anbindungsmanagement. Bitte senden Sie an fit-connect@spotgroup.de eine Mail mit dem Wunsch die Dokumente zu erhalten. Beachten Sie bei den Nutzungsbedingungen, dass die unterschreibende Person den SSP-Zugang erhält. Falls das nicht gewünscht ist, bitte einen 3-Zeiler zur schriftlichen Bestätigung/Weisung (insbesondere mit vollem Namen und personalisierter Email-Adresse) per personalisierter Mail von der unterschriftgebenden Person an das Anbindungsmanagement senden. Wenn Sie einmal die Nutzungsbedingungen unterschrieben haben, gelten diese für alle Anbindungen mit FIT-Connect. Nach Abschluss des Vertrags erstellt die FITKO einen Account für FITKO-GitLab. Damit kann im Self-Service-Portal, wie nachfolgend beschrieben, ein API-Client angelegt werden.

2. API-Client für Sender anlegen

Legen Sie im Self-Service-Portal einen Client des Typs "Sender" an.
Dazu klicken Sie in der Ansicht "Client anlegen", bei der Auswahl der Art des Clients, auf "Sender".
Geben Sie eine Bezeichnung für den Client ein. Weitere Angaben sind für API-Clients des Typs "Sender" nicht erforderlich.
Um den neuen API-Client anzulegen, klicken Sie auf die Schaltfläche "Anlegen".

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.

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.

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