Zum Inhalt springen

Änderungen von Dokument Submission-API

Zuletzt geändert von MACH formsolutions am 08.10.2025
Von Version 13.1
bearbeitet von MACH formsolutions
am 25.06.2024
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 14.1
bearbeitet von MACH formsolutions
am 08.10.2025
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,6 +1,6 @@
1 1  ## Allgemeines
2 2  
3 -MACH ProForms stellt eine Schnittstelle zur Verfügung, die die Daten aller im System hinterlegten Einreichungen ausliest. Die Architektur beruht auf dem REST-Standard. Wie bei allen von MACH ProForms angebotenen Schnittstellen unterliegt auch diese einem Authentifizierungskonzept. Die ausgelesenen Ergebnisdaten werden im JSON-Format zurückgeliefert. Im nachfolgenden Dokument werden die genauen Funktionalitäten im Einzelnen beschrieben.
3 +MACH formsolutions stellt eine Schnittstelle zur Verfügung, die die Daten aller im System hinterlegten Einreichungen ausliest. Die Architektur beruht auf dem REST-Standard. Wie bei allen von MACH formsolutions angebotenen Schnittstellen unterliegt auch diese einem Authentifizierungskonzept. Die ausgelesenen Ergebnisdaten werden im JSON-Format zurückgeliefert. Im nachfolgenden Dokument werden die genauen Funktionalitäten im Einzelnen beschrieben.
4 4  
5 5  ## Voraussetzungen
6 6  
... ... @@ -28,7 +28,11 @@
28 28  
29 29  Um die Schnittstelle beispielhaft bedienen zu können, wird eine Demoanwendung unter folgender URL bereitgestellt: <https://vertrieb.form-solutions.de/submission/api/swagger-ui/index.html>
30 30  
31 -> _**Achtung**_ Die oben verlinkte Swagger-Dokumentation greift auf den internen Vertriebs-Server der MACH ProForms GmbH zu. Um die Dokumentation auf anderen Servern einzusehen muss die URL folgendem Format entsprechen: < BASIS_URL >/submission/swagger-ui/index.html
31 +> _**Achtung**_
32 +>
33 +> Die oben verlinkte Swagger-Dokumentation ist beispielhaft und wird von einem Server der MACH abgerufen.
34 +>
35 +> Um die Dokumentation eines anderen Servers einzusehen, ändern Sie die URL nach folgendem Format: `< SERVER_BASIS_URL >/submission/swagger-ui/index.html`
32 32  
33 33  Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt.
34 34