Clever vernetzt! - Unsere APIs
Sie kennen unsere APIs noch nicht? - Dann wird es aber höchste Zeit.
Die offene Form-Solutions-Schnittstellenarchitektur ermöglicht eine tiefe und absolut homogene Integration des Antragsmanagements in jegliche Richtungen. Für die Anbindung nachgelagerter Systeme stellen wir unterschiedliche Schnittstellen zur Verfügung. Die Architektur unserer APIs beruht auf dem REST-Standard. Für sämtliche Schnittstellen liegt eine Swagger-Dokumentation zu Testzwecken vor. Um das Auslesen bzw. den Zugriff durch Unbefugte sicherzustellen, unterliegt jede Schnittstelle einem Authentifizierungskonzept.
Unsere APIs im Überblick
- Submission-API
- Release-API
- Search-API
- Error-API
- PDFStructure-API
- Massenverarbeitung von Formular-Eingängen-API
- Server-Information-API
Submission-API
Unter dem "Submission"-Endpunkt lassen sich Informationen zu eingegangenen Formularen abrufen und der Bearbeitungsstatus zurückmelden. Via Mandanten- oder auch Formularnummer lässt sich eine Übersicht an eingegangenen Formularen anfordern, in welcher lediglich Metadaten enthalten sind. Die ausgelesenen Ergebnisdaten werden im JSON-Format zurückgeliefert.
Release-API
Mit der Release-API werden alle innerhalb des Antragsmanagement hinterlegten Veröffentlichungen ausgelesen. Diese Veröffentlichungen beinhalten sowohl Onlinedienste im Format HTML5 (Antragsassistenten) als auch PDF-Formulare. Die Architektur beruht auf dem REST-Standard und ist in der Lage die angefragten Dokumente entweder im JSON-Format oder im CSV-Format auszuliefern.
Hinweis: Seit der Version 3 der Release-API werden zusätzlich zur LeiKa-ID ebenso die OZG-IDs mit bereitgestellt.
Search-API
Mit der Search-API können die Suchergebnisse innerhalb des Form-Solutions-Antragsmanagement abgefragt werden. Die Schnittstelle bietet mehrere Parametrisierungsmöglichkeiten und liefert die Ergebnisdaten im JSON-Format.
Error-API
Während des Antragsprozesses kann der Onlinedienst auf einen unerwarteten Fehler stoßen. Für die Fehleranalyse musste bisher in jedem Fall die Administration des Formularservers kontaktiert werden. Damit dies künftig nicht mehr notwendig ist, stellt Form-Solutions mit der Error-API eine Lösung bereit, welche sämtliche Fehler, die standardmäßig auf eine Error-URL weitergeleitet werden, auflistet und der Sachbearbeitung zur Verfügung stellt. Die ausgelesenen Ergebnisdaten werden im JSON-Format ausgeliefert.
PDF Structure-API
Schnittstelle zur Auswertung der Formularfelder innerhalb von PDF-Formularen. Die Ergebnisdaten werden im TXT-Format ausgegeben, welche die Feldnamen, Feldeigenschaften und den Standardwert jeweils kommagetrennt enthält.
Massenverarbeitung von Formular-Eingängen-API
Diese API ist für DMS-Systeme besonders spannend. Mit dieser Schnittstelle können Formulareingänge in der "Massenverarbeitung" durchgeführt werden.
Beispiel: Die Behörde bekommt Formulareingänge von Bürger:innen, bei denen eine Vorabübertragung der Daten durchgeführt wurde. Die Sachbearbeiter:innen der Verwaltung scannen das Dokument ein. Nach Abschluss des Scan-Vorgangs wird die eingelesene Transaktions-ID sowie der definierte CMS-Key an das Antragsmanagement 4.0 versendet. Der Formularserver liefert mittels Servlet die gewünschte Datei aus.
Server-Information-API
Mit der Server-Information-API können allgemeine Informationen über den Server und verfügbare Schnittstellen ausgelesen werden.