Skip to content
Snippets Groups Projects
Commit b7272785 authored by David Schwarzmann's avatar David Schwarzmann
Browse files

Update docs/roadmap.md

parent 2bf5f132
No related branches found
No related tags found
1 merge request!53Insert Roadmap
# 🚧 Roadmap
# Roadmap
## Event Log
Die FIT-Connect Einreichungs-API und die dazugehörige Infrastruktur wird in einem Projekt des IT-Planungsrats im Jahr 2021 zu einer Produktreife entwickelt. Die Umsetzung der Projektliefergegenstände erfolgt iterativ, um eine schnelle Erprobung und Feedback zu ermöglichen.
TBD
Die Roadmap soll daher einen Überblick verschaffen, wann das FIT-Connect Team für die folgende Projektliefergegenstände neue Features anstebt:
## Callbacks
- **API-Spezifikation:** In der OpenAPI geschriebene Spezifikation der FIT-Connect Einreichungs-API.
- **Entwicklerdokumentation- und tools:** Weiterführende Dokumentationsartikel zur technischen Anbindung an der API für sendende und empfangende Systeme udn Bereitstellung von Tools für technische Querschnittsaufgaben wie Tokenhandling, Signaturprüfung oder Verschlüsselung.
- **Infrastruktur:** Bereitstellung von Infrastrukturkomponenten für die Durchführung von Anbindungstests oder Validierungsaufgaben sowie die produktive Bereitstellung der API für Datenübermittlungen.
TBD
Die Roadmap wird laufend aktualisiert und erweitert. Unser Team versucht weitestgehend verbindliche Termine zu benennen, jedoch passen wir die Umsetzungen den aktuellen Bedarfen des Projekts an, wodurch es zu Verzögerungen bei manchen Liefergegenständen kommen kann. Umgekehrt kann es auch sein, das Features früher fertiggestellt werden, falls die Prioritäten ändern oder freie Kapazitäten zur Verfügung stehen.
## Rückkanal
Wir nehmen gerne neue Wünsche & Anregungen für die FIT-Connect API als Issue auf unserem Projekt (https://git.fitko.de/fit-connect/api) entgegen und versuche diese Issues nach einer Umsetzungsprüfung in unsere Roadmap aufzunehmen.
TBD
## Überblick über die Zeitplanung
- **Seit 24.06.2021:** Preview der API-Spezifikation und der Entwicklerdokumentaion für die Version 1.0 der API ist online und ist für alle interessierten Entwickler zugänglich.
- **Mitte Juli 2021:** Bis zu diesem Zeitpunkt werden alle Kernfeatures API spezifiziert und als stabile API Spezifikation veröffentlicht. Für die Evaluierung und Entwicklung durch interessierte Entwickler wird ein öffentlicher Testserver bereitgestellt.
- **Mitte September 2021:** Die API wird als Produktivinfrastruktur für erste Pilotantragsverfahren und deren Systeme bereitstellt. Zudem werden noch neue abwärtskompatible Features und zusätzliche Entwicklerangebote bereitgestellt.
- **Erste Jahreshälfte 2022:** Alle Beschlüsse zur weiteren Pflege der API und dem Betrieb der Infrastruktur liegen vor.
## Detailplanung bis Mitte Juli 2021
### API-Spezifikation
- **Bereitstellung und Übermittlung des Security Event Logs:** Der bisherige Übermittlungsstatus wird durch einen Security Event Log ersetzt, der aus signierten Security Event Tokens besteht und die einzelnen Übermittlungsschritte beweissicher dokumentiert. Die jeweiligen Security Event Tokens sind durch die jeweils verantwortlichen Systeme (Zustelldienst bzw. das empfangende System) zu erstellen und zu signieren. Dieser Security Event Log kann über die API von beiden Parteien abgerufen werden und dient späteren Nachweisen über die korrekte Zustellung.
- **Callbacks zur Benachrichtigung sendender Systeme:** Sendende Systeme bekommen die Möglichkeit für Submissions einen Callback einzurichten. Über diesen Callback informiert der Zustelldienst sendende Systeme, sobald es Änderungen im Zustellstatus. Durch den Callback soll ein regelmäßiges Polling des Security Event Log zur Prüfung des Zustellstatus unötig gemacht werden.
- **Neuumsetzung von Features:** Einige Features aus der Beta7 Version der API wie die Abfrage von Destination Informationen und die Abfrage von abholbereiten Anträgen werden neu konzipiert und sind in der aktuellen Preview noch nicht enthalten.
- **Neues Client Autorisierungskonzept auf Basis des bestehen Client Credentials Flows:** Ein neues OAuth Konzept soll umgesetzt werden, da detailierte Berechtigung für den API-Zugriff ermöglicht und höhere Sicherheit für die Nutzung von Access Token gewährleistet. Hieraus werden auch Änderungen in der Erstellung von neuen Destinations entstehen.
### Entwicklerdokumentation- und tools
### Infrastruktur
- **Testinfrastruktur:** Es wird eine Testinfrastruktur bereitgestellt, über die alle Funktionen der API angesprochen und getestet werden können.
- **Sandbox Systeme**: Über eine Portaloberfläche werden generische API-Clients angeboten, um bei Versand oder Empfang von Submissions die jeweilige Gegenseite zu simulieren.
- Aktuell wird noch geprüft, ob dieses Feature aufgrund von Kapazitätsgründen in den Umsetzungszeitraum September 2021 verlagert wird.
## Detailplanung bis Mitte September 2021
### API-Spezifikation
- Im Rahmen der Produktivstellungen werden Erweiterungen an der API zurückgestellt und nur bei dringenden Bedarf bzw. kritischen Fehler entsprechende Fixes an der API durchgeführt.
- Falls Kapazitäten vorhanden sind, werden Preview von zukünftigen Features in der zweiten Jahreshälfte über das API Portal veröffentlicht
### Entwicklerdokumentation- und tools
- **Bereitstellung von SDKs für erste Querschnittsfunktionen:** Es ist geplant, erste Unterstützungsfunktionen für Querschnittsaufgaben bereitzustellen.
### Infrastruktur
- **Self-Service Portal:** Es wird ein Self-Service Portal eingerichtet, über das Entwickler ihre API-Clients am OAuth Server selbst anlegen können. Als weiteres Feature wird es für Betreiber von empfangenden Systemen möglich sein, über das Self-Service Portal Destination anzulegen und zu konfigurieren.
## Detailplanung bis Ende 2021
### API-Spezifikation
- **Routing API:** Über die Routing API wird zukünftig möglich sein, Destinations und deren technische Parameter über eine API Anfrage anhand technische Zuständigkeitskriterien zu ermitteln.
- **Hinterlegung einer OSCI-Weiterleitung:** Um bestehende OSCI Intermediärsinfrastrukturen einzubinden, wird eine Hinterlegung von OSCI-Kommunikationsparametern möglich sein. Hierdurch werden abgebeben Submissions durch den Zustelldienst automatisch an den vorgesehen OSCI Intermediär weitergeleitet.
- **Erweiterung um einen Rückkanal für Prozessstandards:** Als abwärtskompatible Erweiterung wird über die API ermöglich, eine bilaterale Antragskommunikation auf Basis von Fachstandards wie XBau umzusetzen. API-Nutzer, die FIT-Connect nur für Einreichungen nutzen, sind von diesen Änderungen nicht betroffen.
- **Weiterentwicklung von FIM/XFall Schemata**: Um die Nutzung von FIM für die Antragsübermittlung zu vereinfachen, werden in Zusammenarbeit mit FIM neue technologische Ansätze und Verbesserung in der Schema Nutzung angestrebt.
### Entwicklerdokumentation- und tools
- **Vollumfängliche Bereitstellung von SDKs**: In der zweiten Jahreshälfte werden SDKs in verschiedenen Programmiersprachen für alle zentralen FIT-Connect Anforderungen angeboten.
- **FIM Entwicklungstools**: Um die Nutzung von FIM für Antragsschemata sollen diverse Entwicklungstools für die Generierung und Validierung von FIM/XFall Nachrichten angeboten werden.
### Infrastruktur
- **Validierungsumgebung:** Um gegenüber Auftraggebern oder anderen Stellen nachzuweisen, dass die eigene Software FIT-Connect nutzen kann, soll eine Validierungsumgebung geschaffen werden, die die API-Umsetzung gegenüber festgelegten Testfällen prüfen und hierfür einen signierten Nachweis an den Verfahrenbetreiber ausstellt.
## Erste Jahreshälfte 2022
... TBD ...
## Verschiedene Umgebungen
TBD
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