Skip to content
Snippets Groups Projects
Commit 0d2bf745 authored by Alexander Hoose's avatar Alexander Hoose
Browse files

Aktualisieren docs/overview.md

parent 17f5fd28
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 36 additions and 37 deletions
docs/overview.md
+ 36
− 37
View file @ 0d2bf745
...@@ -3,56 +3,55 @@ title: Überblick ...@@ -3,56 +3,55 @@ title: Überblick
slug: / slug: /
--- ---
Willkommen auf der Dokumentation für die FIT-Connect API von FITKO. Die FIT-Connect API baut auf dem bestehenden Willkommen auf der Dokumentation für die FIT-Connect APIs von FITKO. Die FIT-Connect Submission API baut auf dem bestehenden
IT-Planungsrat Standard XFall auf und bietet Lösungsverantwortlichen von sendenden und empfangenden Systemen eine IT-Planungsrat Standard XFall auf und bietet Lösungsverantwortlichen von sendenden und empfangenden Systemen eine
einfache Möglichkeit, ihre Software schnell und wirtschaftlich in länder- und ebenenübergreifende Antragsprozesse zu einfache Möglichkeit, ihre Software schnell und wirtschaftlich in länder- und ebenenübergreifende Antragsprozesse zu
integrieren. integrieren. Die FIT-Connect Routing API soll es bundesweit ermöglichen, die richtigen Empfangspunkte für jeden Leistungs-
und Zuständigkeitskontext zu ermitteln und soll die Submission API ergänzen.
## Was ist die FIT-Connect API und was unterscheidet diese API vom bisherigen XFall-Standard? ## Was ist die FIT-Connect Submission API und was unterscheidet diese API vom bisherigen XFall-Standard?
Die FIT-Connect API baut auf den bisherigen Konzepten und Erfahrungen des bestehenden IT-Planungsrats Standards XFall Die FIT-Connect Submission API baut auf den bisherigen Konzepten und Erfahrungen des bestehenden IT-Planungsrats Standards XFall
auf. auf.
> Die übergreifende Zielstellung des Standards XFall besteht darin, Anträge und Berichte, die aus vorgelagerten Systemen (bspw. Onlineantragsdienste, Fachportale oder Berichtssysteme) erstellt werden, in die unterschiedlichen Systeme der elektronischen Verfahrensbearbeitung (bspw. Fachverfahren, Dokumentenmanagementsystem oder Prozessplattformen) zu übergeben. > Die übergreifende Zielstellung des Standards XFall besteht darin, Anträge und Berichte, die aus vorgelagerten Systemen (bspw. Onlineantragsdienste, Fachportale oder Berichtssysteme) erstellt werden, in die unterschiedlichen Systeme der elektronischen Verfahrensbearbeitung (bspw. Fachverfahren, Dokumentenmanagementsystem oder Prozessplattformen) zu übergeben.
Bei der Entwicklung der FIT-Connect API wurden viele Konzepte mit Hinblick auf die neuen Erfordernisse des Bei der Entwicklung der Submission API wurden viele Konzepte mit Hinblick auf die neuen Erfordernisse des
Onlinezugangsgesetzes, der SDG-Verordnung sowie den Anforderungen digitaler Geschäftsmodelle weiterentwickelt. Technisch Onlinezugangsgesetzes, der SDG-Verordnung sowie den Anforderungen digitaler Geschäftsmodelle weiterentwickelt. Technisch
setzt die FIT-Connect API auf einen leichtgewichtigen RESTful-Architekturstil und baut auf der föderalen setzt die FIT-Connect Submission API auf einen leichtgewichtigen RESTful-Architekturstil und baut auf der föderalen
Antragsübertragungsarchitektur von FIT-Connect auf. Antragsübertragungsarchitektur von FIT-Connect auf. Bereitgestellt wird diese API durch einen zentral gemanagten Intermediär
(`FIT-Connect Zustelldienst`), der für Nutzer der API einen Aufbau eigener Infrastruktur unnötig macht.
## Was macht die FIT-Connect API und wie kann diese genutzt werden? ## Was macht die FIT-Connect Submission API und wie kann diese genutzt werden?
Die FIT-Connect API besteht aus zwei getrennt nutzbaren APIs: Die FIT-Connect Submission API ist als ein universelles Eingangstor für digitale Einreichungen an die Verwaltung ausgelegt:
- Für empfangende Systeme wird eine `Application Subscriber API` für den Empfang von Anträgen sowie eine `Callback` / - Empfangende Systeme (bspw. Fachverfahren oder E-Akte Systeme) können einen digitalen Zugang (Zustellpunkt) eröffnen und hierüber beliebige Einreichungen (Anträge,
Webhook Funktion für die technische Benachrichtigung über vorliegende Anträge angeboten. Berichtsmeldung, etc. ) erhalten. Was empfangen wird, kann über eindeutige Schema Referenzen auf Fachstandards festgelegt werden.
- Für sendende Systeme wird eine `Application Sender API` angeboten, um an beliebige empfangende Systeme Anträge zu - Sendende Systeme (bspw. Antragsdienste) können Einreichungen an alle existierenden Zustellpunkte senden. Um die richtigen Zustellpunkte für den jeweiligen Leistungskontext
senden, die sich mit einem Zustellpunkt registriert haben. und die jeweilige Zuständigkeit zu finden, wird sendenden Systemen eine Routing API bereitgestellt. Mit der FIT-Connect API können sendende Systeme die auf Basis Leistungs- und Ortsbezug
der Einreichung den richtigen Zustellpunkt ermitteln und alle technischen Verbindungsparameter ermitteln.
Diese beiden APIs werden durch einen zentralen Intermediär (`FIT-Connect Zustelldienst`) bereitgestellt. Um auf diese Die Vertaulichkeit der Übermittlung ist jederzeit gewährt, da eine Ende-zu-Ende standardmäßig für alle übermittelten Daten vorgesehen ist und bis in den Browser oder das Endgerät
APIs zuzugreifen, müssen interessierte Entwickler ihre Anwendungen beim FIT-Connect Autorisierungsdienst vorab des Antragssteller oder Berichtsersteller möglich ist.
registrieren.
### Zusammenspiel der APIs in der Antragsübermittlung ### Zusammenspiel der Infrastruktur bei der Übermittlung von Einreichungen
![Applicationtransfer_Architecture](/images/api_overview/XFall_Integration_Architecture.png "Antragsübertragungsarchitektur FIT-Connect") ![Applicationtransfer_Architecture](/images/api_overview/XFall_Integration_Architecture.png "Antragsübertragungsarchitektur FIT-Connect")
Über die `Application Subscriber API` können die zuständigen Stellen für ihre Systeme einen Zustellpunkt eröffnen, der Über die `Submission API` können die zuständigen Stellen für ihre Systeme einen Zustellpunkt eröffnen, der
über eine `destination-Id` eindeutig adressierbar ist. Für diese Zustellpunkte legen die zuständigen Stellen alle über eine `destination-Id` eindeutig adressierbar ist. Für diese Zustellpunkte legen die zuständigen Stellen alle
fachlichen Vorgaben (Zulässige Fachstandards, Verschlüsselung, Datenformate etc.) fest, damit eine medienbruchfreie fachlichen Vorgaben (Zulässige Fachstandards, Verschlüsselung, Datenformate etc.) fest, damit eine medienbruchfreie
Weiterverarbeitung in ihren Systemen gewährleistet ist. Über die Angabe der `destination-Id` in Weiterverarbeitung in ihren Systemen gewährleistet ist. Über die Angabe der `destination-Id` in
der `Application Sender API` können beliebige sendende Systemen Anträge an die zuständige Stelle senden. der `Submission API` können sendende Systemen Einreichungen an die zuständige Stelle senden.
Dieser Zustellpunkt ist jedoch vorab für eine Verwaltungsleistung und den jeweiligen örtlichen Antragskontext (bspw. Ort Dieser Zustellpunkt ist jedoch vorab für eine Verwaltungsleistung und den jeweiligen örtlichen Antragskontext (bspw. Ort
der Antragsstellung) korrekt zu ermitteln. Damit die Ermittlung des korrekten Zustellpunkts skalierbar für das ganze der Antragsstellung) korrekt zu ermitteln. Damit die Ermittlung des korrekten Zustellpunkts skalierbar für das ganze
Bundesgebiet funktioniert, ist langfristig vorgesehen, die `destination-Id` in den Leistungs- und Bundesgebiet funktioniert, ist es vorgesehen, die `destinationId` in den Leistungs- und
Zuständigkeitsinformationen des jeweils bekannten Zuständigkeitsfinders zu hinterlegen. Diese dezentral gepflegten Zuständigkeitsinformationen des lokalen FIM Leistungsredaktionssystems zu hinterlegen. Diese dezentral gepflegten
Informationen sollen durch das IDs werden durch das Online-Gateway (<https://www.onlinezugangsgesetz.de/Webs/OZG/DE/umsetzung/portalverbund/online-gateway/online-gateway-node.html>)
Online-Gateway (<https://www.onlinezugangsgesetz.de/Webs/OZG/DE/umsetzung/portalverbund/online-gateway/online-gateway-node.html>) gebündelt. Fragt nun ein sendendes System über die Routing API an, ermittelt der FIT-Connect Routingdienst die korrekte `destination-Id` im Onlinegateway,
gebündelt und über eine offene API im XZuFi Format (<https://www.xrepository.de/details/urn:xoev-de:fim:standard:xzufi>) ruft auf Basis dieser ID die technischen Verbindungsparameter im DVDV ab und sendet diese Informationen an das sendende System zurück.
nutzbar gemacht werden.
![Applicationtransfer_Architecture](https://raw.githubusercontent.com/fiep-poc/assets/master/images/api_overview/Pflege%20und%20Ermittlung%20destination-Id.jpg "Pflege und Ermittlung der destination-Id")
## Für wen ist die FIT-Connect API gedacht und warum sollte ich sie nutzen? ## Für wen ist die FIT-Connect API gedacht und warum sollte ich sie nutzen?
...@@ -81,8 +80,8 @@ Antragsprozesse eine Reihe von Mehrwerten: ...@@ -81,8 +80,8 @@ Antragsprozesse eine Reihe von Mehrwerten:
auf und nutzt verbreitete Industriestandards wie die OpenAPI Specification und OAuth 2.0, sodass kein spezialisiertes auf und nutzt verbreitete Industriestandards wie die OpenAPI Specification und OAuth 2.0, sodass kein spezialisiertes
Know-How und spezifische Softwarekomponenten für die Anbindung erforderlich sind. Know-How und spezifische Softwarekomponenten für die Anbindung erforderlich sind.
- **Flexibilität in der Antragsübermittlung**: Die FIT-Connect API verbindet Flexibilität und Standardisierung. Während - **Flexibilität in der Antragsübermittlung**: Die FIT-Connect API verbindet Flexibilität und Standardisierung. Während
die FIT-Connect API eine einheitliche Metadatenstruktur festlegt, um Anträge strukturiert zu verarbeiten, können die FIT-Connect API eine einheitliche Metadatenstruktur festlegt, um Einreichungen strukturiert zu verarbeiten, können
beliebige Fachstandards und Anhänge übertragen werden. Auch die Übertragung von Anträgen im PDF Format ist möglich, beliebige Fachstandards und Anhänge übertragen werden. Auch die Übertragung von Einreichungen im PDF Format ist möglich,
solange für die Antragsdaten noch kein FIM Schema vorhanden ist. solange für die Antragsdaten noch kein FIM Schema vorhanden ist.
**Nutzung bestehender Prozesse und Strukturen für die Pflege von Adressierungsinformationen**: Langjährig erprobte **Nutzung bestehender Prozesse und Strukturen für die Pflege von Adressierungsinformationen**: Langjährig erprobte
Prozesse und Strukturen zur Pflege der Zuständigkeitsinformationen, können in den zuständigen Stellen beibehalten Prozesse und Strukturen zur Pflege der Zuständigkeitsinformationen, können in den zuständigen Stellen beibehalten
...@@ -93,20 +92,20 @@ Antragsprozesse eine Reihe von Mehrwerten: ...@@ -93,20 +92,20 @@ Antragsprozesse eine Reihe von Mehrwerten:
Drittsoftware oder Unternehmenssysteme direkt eingebunden werden, ohne das hierfür eine gesonderte Infrastruktur Drittsoftware oder Unternehmenssysteme direkt eingebunden werden, ohne das hierfür eine gesonderte Infrastruktur
notwendig ist. notwendig ist.
### Ist die FIT-Connect API nur für länder- und behördenübergreifende Antragskontexte gedacht? ### Ist die FIT-Connect Submission API nur für länder- und behördenübergreifende Antragskontexte gedacht?
Durch die einfache Anbindung und Nutzung bietet sich die FIT-Connect API auch dort an, wo das behördeneigene Durch die einfache Anbindung und Nutzung bietet sich die Submission API auch dort an, wo das behördeneigene
Antragsverfahren mit dem behördeneigenen Fachverfahren verbunden wird. Durch die Nutzung der FIT-Connect API werden Antragsverfahren mit dem behördeneigenen Fachverfahren verbunden wird. Durch die Nutzung der Submission API werden
diese Systeme standardisiert verbunden, ohne das die Behörde in Abhängigkeiten zu proprietären Technologien und diese Systeme standardisiert verbunden, ohne das die Behörde in Abhängigkeiten zu proprietären Technologien und
Schnittstellen gerät. Dies ermöglicht es der Behörde, ihre Systeme auf beiden Seiten flexibel auszutauschen und Schnittstellen gerät. Dies ermöglicht es der Behörde, ihre Systeme auf beiden Seiten flexibel auszutauschen und
weiterzuentwickeln, um somit auf neue technische Trends und Möglichkeit schnell zu reagieren. weiterzuentwickeln, um somit auf neue technische Trends und Möglichkeit schnell zu reagieren.
## In welchem Stand befindet sich FIT-Connect API und wann kann man die API nutzen? ## In welchem Stand befindet sich FIT-Connect API und wann kann man diese nutzen?
Die Entwicklung und Bereitstellung der FIT-Connect API erfolgt im Rahmen eines Proof of Concepts für die geplante Ein Zugang für interessierte Enwickler zur Test-API ist in Q3 2020 geplant. Um auf diese API zuzugreifen, müssen interessierte
föderale Integrations- und Entwicklungsplattform FIT-Connect. Seit dem zweiten Quartal 2020 ist es interessierten Entwickler ihre Anwendungen das Self-Service-Portal vorab registrieren. Projektpartner können die API und Infrastruktur
Parteien möglich, einen Zugang zur FIT-Connect API zu bekommen und eine prototypische Anbindung von Verfahren für produktive Datenübermittlungen ab September 2020 nutzen. Detailerte Zeitpläne können der [Roadmap](https://docs.fitko.de/fit-connect/docs/roadmap)
umzusetzen. entnommen werden. Updates werden regelmäßig im Bereich [News](https://docs.fitko.de/fit-connect/news) mitgeteilt.
## Ich habe einen Fehler in der Dokumentation oder in der API-Spezifikation gefunden. Wo kann ich diesen melden? ## Ich habe einen Fehler in der Dokumentation oder in der API-Spezifikation gefunden. Wo kann ich diesen melden?
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment