Änderungen von Dokument Schnittstellen
Zuletzt geändert von MACH ProForms GmbH am 07.08.2025
Von Version 101.2
bearbeitet von MACH ProForms GmbH
am 07.08.2025
am 07.08.2025
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Auf Version 84.1
bearbeitet von MACH ProForms GmbH
am 05.08.2022
am 05.08.2022
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Zusammenfassung
-
Seiteneigenschaften (3 geändert, 0 hinzugefügt, 0 gelöscht)
Details
- Seiteneigenschaften
-
- Titel
-
... ... @@ -1,1 +1,1 @@ 1 -Schnittstellen 1 +Form-Solutions Schnittstellen - Syntax
-
... ... @@ -1,1 +1,1 @@ 1 - XWiki2.11 +Markdown 1.2 - Inhalt
-
... ... @@ -1,106 +1,13 @@ 1 -(% class="wikigeneratedid" id="HAPISchnittstellen" %) 2 -MACH formsolutions stellt Schnittstellen zur Verfügung, um verschiedene Informationen über den Formularserver auszulesen, sowie Datensätze automatisiert abzurufen und zu aktualisieren. 1 +In diesem Teil der Dokumentation finden Sie: 2 +- Die Dokumentation der „[[Submission-API|Main.02_FSSchnittstellen.01_SubmissionAPI]]“ 3 +- Die Dokumentation der „[[Release-API|Main.02_FSSchnittstellen.02_ReleaseAPI]]“ 4 +- Die Dokumentation der „[[Search-API|Main.02_FSSchnittstellen.03_SearchAPI]]“ 5 +- Die Dokumentation der „[[Error-API|Main.02_FSSchnittstellen.04_ErrorAPI]]“ 6 +- Die Dokumentation der „[[CMS-Schnittstelle|Main.02_FSSchnittstellen.05_CMSSchnittstelle]]“ 7 +- Die Dokumentation der „[[Search-API-Metaform|Main.02_FSSchnittstellen.06_SearchAPIMetaform]]“ 8 +- Die Dokumentation der „[[PDF Structure-API|Main.02_FSSchnittstellen.07_PDFStructureAPI]]“ 9 +- Die Dokumentation der „[[Massenverarbeitung von Formular-Eingängen-API|Main.02_FSSchnittstellen.08_MassenverarbeitungAPI]]“ 10 +- Die Dokumentation zum Anlegen von „[[API-Keys|Main.02_FSSchnittstellen.09_API-Key]]“ für Nutzung der Schnittstellen 11 +- Die Dokumentation der „[[Server-Information-API|Main.02_FSSchnittstellen.10_ServerInformationAPI]]“ 3 3 4 -(% class="wikigeneratedid" %) 5 -Die Schnittstellen beruhen auf dem REST-Standard. Sie werden über eine URL angesprochen. Hierbei gibt es einen festen Basispfad und einen ergänzenden Endpunkt. Der Basispfad ist bei jedem Aufruf gleich, die Endpunkte unterscheiden sich je nach Funktion. Ein Endpunkt spricht eine Funktionalität der Schnittstelle an. 6 - 7 -Um die API-Schnittstellen verwenden zu können, ist die Authentifizierung auf Mandantenbasis durch einen API-Key/Schlüssel erforderlich. Der API-Key kann beim Support Ihres Formularserverbetreibers beantragt werden. 8 -Die Anleitung für Formularserverbetreiber finden Sie in der [[Dokumentation zum Anlegen von API-Keys>>Main.02_FSSchnittstellen.09_API-Key]]. 9 - 10 -(% class="box infomessage" %) 11 -((( 12 -Der Supermandant hat als übergeordnete Instanz Zugriff auf alle Mandanten. 13 -))) 14 - 15 -{{toc/}} 16 - 17 -= Übersicht der APIs = 18 - 19 -== Server-Information-API == 20 - 21 -|(% style="width:250px" %)Zweck|allgemeine Informationen über den Server und die verfügbaren Schnittstellen 22 -|Ausgabeformat|JSON 23 -|weitere Informationen| 24 -|Dokumentation|[[Dokumentation Server-Information-API>>Main.02_FSSchnittstellen.10_ServerInformationAPI]] 25 - 26 -== Search-API == 27 - 28 -|(% style="width:250px" %)Zweck|Suchergebnisse, wie sie über die Benutzeroberfläche zu erlangen sind 29 -|Ausgabeformat|JSON 30 -|weitere Informationen|Damit die Suchlogik abgebildet und die Suchergebnisse gefiltert werden können, bietet die Schnittstelle einige Query-Parameter an, die an die URL angefügt werden können. 31 -|Dokumentation|[[Dokumentation Search-API>>path:/wiki/admindoku/view/Main/02_FSSchnittstellen/03_SearchAPI/]] 32 - 33 -== Release-API == 34 - 35 -|(% style="width:250px" %)Zweck|Veröffentlichungen auslesen; sowohl Assistenten als auch PDF-Formulare 36 -|Ausgabeformat|JSON; CSV 37 -|weitere Informationen|Wir stellen mehrere Versionen der Release-API zur Verfügung. 38 -|Dokumentation|[[Dokumentation Release-API>>doc:.02_ReleaseAPI.WebHome]] 39 - 40 -== (% style="color:inherit; font-family:inherit; font-size:max(20px, min(24px, 12.8889px + 0.925926vw))" %)Submission-API(%%) == 41 - 42 -|(% style="width:250px" %)Zweck|Abruf von Informationen zu eingegangenen Formularen und von Formulardaten 43 -|Ausgabeformat|JSON 44 -|weitere Informationen|((( 45 -OpenAPI Specification 3.0 46 - 47 -Einreichungen zu einem Formular/Artikelnummer für den Mandanten 48 - 49 -* Übersicht der Einreichungen (nur Metadaten) 50 -* Einschränkung der Suche 51 -** nach Bearbeitungsstatus (z.B. "NEW") 52 -** nach Einreichungszeitpunkt 53 - 54 -Spezifische Einreichungen 55 - 56 -* Abruf einer konkreten Einreichung 57 -** Metadaten 58 -** Inhalte 59 -* Änderung des Bearbeitungsstatus einer Einreichung 60 - 61 -Wir stellen mehrere Versionen der Submission-API zur Verfügung. 62 -))) 63 -|Versionshistorie|[[Submission-API Release-Notes>>doc:.01_SubmissionAPI.Release-Notes.WebHome]] 64 -|Dokumentation|[[Dokumentation Submission-API>>Main.02_FSSchnittstellen.01_SubmissionAPI]] 65 - 66 -== Error-API == 67 - 68 -|(% style="width:250px" %)Zweck|Auflistung von Fehlern im Antragsprozess; alternativer Zugang zu Fehlerinformationen, ohne einen Formularserver-Administrator zu kontaktieren 69 -|Ausgabeformat|JSON 70 -|weitere Informationen|((( 71 -Während des Antragsprozesses kann der Assistent unerwartet auf einen Fehler laufen. 72 - 73 -Mit der Error-API stellt MACH formsolutions eine Lösung bereit, Fehlerursachen festzustellen, ohne einen Formularserver-Administrator zu kontaktieren. 74 - 75 -Um die Schnittstelle verwenden zu können, ist es notwendig beim Assistentenstart eine "errorUrl" zu übergeben, wie unter [[Rücksprung-URLs>>https://wiki.machproforms.de/wiki/admindoku/view/Main/03_Steuerungsprozess/03_Portalintegration/]] beschrieben. 76 -In Fehlerfällen während des Antragsprozesses wird dadurch der Parameter "errorId" an die URL angehängt. Mit dieser ID können Informationen zum Fehler über die Schnittstelle ausgelesen werden. 77 -))) 78 -|Dokumentation|[[Dokumentation Error-API>>Main.02_FSSchnittstellen.04_ErrorAPI]] 79 - 80 -= Unterstützung von Vorgängerversionen und abgekündigten APIs = 81 - 82 -* Die Dokumentation der „[[Search-API-Metaform>>Main.02_FSSchnittstellen.06_SearchAPIMetaform]]“ 83 -* Die Dokumentation der „[[Massenverarbeitung von Formular-Eingängen-API>>Main.02_FSSchnittstellen.08_MassenverarbeitungAPI]]“ 84 -* Die Dokumentation der „[[CMS-Schnittstelle>>Main.02_FSSchnittstellen.05_CMSSchnittstelle]]“ 85 -* Die Dokumentation der „[[PDF Structure-API>>Main.02_FSSchnittstellen.07_PDFStructureAPI]]“ 86 - 87 -= Versionierung = 88 - 89 -Unsere APIs sind für eine lange Betriebsphase und Versionskompatibilität konzipiert. 90 - 91 -Wir behalten immer zwei Versionen online, soweit technisch möglich. Sobald eine neue Version hinzukommt, wird die älteste Version mit einem zeitlichen Horizont von mindestens 6 Monaten abgekündigt. Nach dieser Frist sind die veraltete Version und alle ihre Minor-Versionen nicht mehr erreichbar. 92 - 93 -Eine neue **Major-Version (1.x)** kann Änderungen beinhalten, die nicht abwärtskompatibel sind. Dies sind z.B.: 94 - 95 -* Authentifizierungsmethoden 96 -* Umbenennung und Löschung von Endpunkten 97 -* Löschung von HTTP-Methoden an vorhandenen Endpunkten 98 -* Umbenennung und Löschung von Parametern 99 -* Restrukturierung des Response-Objekts 100 - 101 -Eine neue **Minor-Version (x.1)** ist definitionsgemäß abwärtskompatibel zur **Major-Version**. Änderungen wären z.B.: 102 - 103 -* Zusätzliche Endpunkte 104 -* Zusätzliche HTTP-Methoden an Endpunkten 105 -* Weitere (optionale) Parameter für eine Abfrage (z.B. Filterfunktion) 106 -* Erweitertes Response-Objekt 13 +![[Schnittstellen|@Schnittstellen.jpg]]