Durchgängiges Beispiel für Getting Started erstellen und nutzbar machen
Ziel: Um Getting Started besser für Entwickler Hands's on nutzbar zu machen, soll ein durchgängiger Beispielspieldatensatz genutzt werden, der für alle API-Aufrufe und technische Aufgaben (Schemavalidierung) genutzt werden kann. Dieser Beispieldatensatz besteht aus folgenden Bestandteilen:
- Einem Metadatensatz, der das gesamte Beispiel definiert. Dieser enthält zudem:
- Ein identificationReport
- Einen Bezahlungsnachweis (PaymentInfo) mit Minimalbefüllung
- Eine Mailadresse als Replychannel, der an ein erreichbares Postfach verweist (ggf. mit automatischer Glückwunsch Nachricht)
- vgl: https://docs.fitko.de/fit-connect/docs/getting-started/sending/metadata
- vgl. https://git.fitko.de/fit-connect/metadata-schema/-/tree/main/examples
- Das Schema des Metadatensatzes
- Ein Zertifikat zur Prüfung des identificationReport
- Einen Fachdatensatz (gemäß den Angaben des Metadatensatzes)
- Das Schema des Fachdatensatzes (gemäß den Angaben des Metadatensatzes)
- 1-2 PDF Anlagen (gemäß den Angaben des Metadatensatzes)
- Ein SET für die Accepted Meldung
- Eine Musterkonfiguration für eine Destination (Kann im SSP per Copy&Paste eingefügt werden)
- Je ein JWK für Verschlüsselung und Signatur
- ohne Zertifikatskette: #29 (closed)
- mit Zertifikatskette: #18 (moved) (PrivateKey darf gemäß DOI-CA-Vorgaben nicht veröffentlicht werden)
Als Erweiterung könnte vorgesehen werden:
- Den Metadatensatz und das SET auf Basis von Datenvorgaben selbst erstellen.
Akzeptanzkriterien:
- Alle Beispieldaten liegen vor und können öffentlich runtergeladen werden
- Beispiel wird durchgängig in Getting Started genutzt
- Alle Schritte in der API können mit einem einfachen Tool (aka. CURL) umgesetzt werden
- Die Validierungen des Fachdatensatzes und des Metadatensatzes können mit einem einfachen Tool wie ajv-cli (https://ajv.js.org/) durchgeführt werden. Validierungsschritte im Kontext des Tools sind beschrieben -> vgl. #3 (moved)
- Fachdatensatz soll ein JSON Schema besitzen. Dies kann ein reelles FIM-Beispiel (Hundesteuer) sein, muss es aber nicht (kann auch ein X-beliebiges JSON Schema sein). Es sollte nur relativ einfach sein. XML oder speziell XÖV sollte nicht genutzt werden, da für die Validierung zusätzliches Tooling und Know-How gebraucht wird.
Edited by Marco Holz