Zum Inhalt springen

Änderungen von Dokument Submission-API

Zuletzt geändert von MACH ProForms GmbH am 25.06.2024
Von Version 3.1
bearbeitet von MACH ProForms GmbH
am 19.12.2020
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 5.1
bearbeitet von MACH ProForms GmbH
am 15.02.2021
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,12 +1,19 @@
1 1  ## Authentifizierung
2 2  
3 -Im Folgenden aufgeführte Schnittstelle erfordert eine Authentifizierung der ausführenden Stelle.
3 +Um die Schnittstelle verwenden zu können, muss eine Authentifizierung vorgenommen werden. Für diese ist die Mandantennummer und der dafür hinterlegte API-Schlüssel notwendig, wobei die Mandantennummer als Benutzername und der API-Schlüssel als Passwort gilt. Sollte noch kein passender API-Schlüssel vorliegen, kann dieser beim Administrator des Fomularservers beantragt werden.
4 4  
5 -Hierbei kommt eine preemptive Basic-Authentifizierung zum Einsatz.
5 +Mit dem folgenden Link wird auf eine Oberfläche weitergeleitet, bei der die Schnittstelle auf ihre Funktionalität getestet werden kann.
6 +Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
6 6  
7 -- Als Benutzername ist die Nummer des Mandanten zu verwenden, in dessen Namen der Aufruf durchgeführt wird.
8 -- Als Passwort dient ein CMS-Key wie er auch an anderen Stellen im System zur Anwendung kommt.
8 +*Beispiel: [https://vertrieb.form-solutions.de/submission/swagger-ui/index.html](https://vertrieb.form-solutions.de/submission/swagger-ui/index.html)*
9 +<br>
10 +*Mandantennummer: 88888888-8888*
11 +<br>
12 +*API-Schlüssel: npcnqwpefwAFWFAFAFqwcqcqwc23rf23rzhbnerg*
9 9  
14 +> ***Hinweis:***
15 +> Die verwendete Authentifizierungsart ist eine [Basis-Authentifizierung](https://de.wikipedia.org/wiki/HTTP-Authentifizierung#Basic_Authentication).
16 +
10 10  ___
11 11  
12 12  ## Base-URL
... ... @@ -109,7 +109,7 @@
109 109  - HIDDEN
110 110  - DELETED
111 111  
112 -> ***Hinweis:***\
119 +> ***Hinweis:***
113 113  > Wird der Status auf `DELETED` gesetzt, werden die Inhaltsdaten (payload, pdf, xml, attachments) unwiderruflich gelöscht.
114 114  
115 115  ___
... ... @@ -159,7 +159,7 @@
159 159  - HIDDEN
160 160  - DELETED
161 161  
162 -> ***Hinweis:***\
169 +> ***Hinweis:***
163 163  > Wird der Status auf `DELETED` gesetzt, werden der Text und alle Dateianhänge unwiderruflich gelöscht.
164 164  
165 165  ___
... ... @@ -188,3 +188,13 @@
188 188  ### Löschen
189 189  
190 190  Einzelne Dateien können über die Detail-URL auch wieder gelöscht werden. Dazu ist die HTTP-Methode DELETE zu verwenden.
198 +
199 +___
200 +
201 +### Beispielanwendung
202 +
203 +Um die Schnittstelle beispielhaft bedienen zu können, wird eine Demoanwendung unter folgender URL bereitgestellt: https://vertrieb.form-solutions.de/submission/swagger-ui/index.html
204 +
205 +Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation bereit, welche die einzelnen Ressourcen detaillierter beschreibt.
206 +
207 +