Wiki-Quellcode von Submission-API
Version 7.1 von MACH formsolutions am 17.03.2021
Verstecke letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
 |
6.1 | 1 | ## Allgemeines |
| |
1.1 | 2 | |
| |
6.1 | 3 | Form-Solutions 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 Form-Solutions 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. |
| |
1.1 | 4 | |
| |
6.1 | 5 | ## Voraussetzungen |
| |
1.1 | 6 | |
| |
6.1 | 7 | Um die Submission-API nutzen zu können sind folgende Voraussetzungen zu erfüllen: |
| 8 | - Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein. | ||
| |
1.1 | 9 | |
| |
6.1 | 10 | ## Verwendung der Schnittstelle |
| |
5.1 | 11 | |
| |
6.1 | 12 | Unter dem "Submission"-Endpunkt lassen sich Informationen zu eingegangenen Formularen abrufen. Zusätzlich kann ein Bearbeitungsstatus zurückgemeldet werden. Mittels der Mandantennummer und der Formularnummer lässt sich eine Übersicht an eingegangenen Formularen abrufen. Dabei sind nur Metadaten enthalten. Wird beim Assistentenstart eine Ordnungsziffer mitgegeben enthält das Attribut "Payload" die übergebene Ordnungsziffer als eingebettetes JSON Element. Die Anzeige kann eingeschränkt werden, indem als Abfrage-Parameter der gewünschte Status mit angegeben wird. So kann z. B. mittels "?status=NEW" auf neue Anträge eingeschränkt werden. Ebenso ist es möglich mehrere Status gleichzeitig für die Filterung anzugeben. Zusätzlich kann der Abfragezeitraum über die Angabe eines "Last-Modified-Headers" eingeschränkt werden. Dabei handelt es sich um den Einreichezeitpunkt, nicht die letzte Statusänderung. Weitere Verwendungsmöglichkeiten finden Sie in unserer Swagger-Dokumentation. |
| |
1.1 | 13 | |
| |
6.1 | 14 | ## Authentifizierung |
| |
1.1 | 15 | |
| |
6.1 | 16 | 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. |
| |
1.1 | 17 | |
| |
7.1 | 18 | Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt: |
| 19 | ***Mandantennummer:*** 77777777-0000 | ||
| 20 | ***API-Schlüssel:*** yIJNM2BS6LI0lS25Qa5xbtEK | ||
| |
1.1 | 21 | |
| |
6.1 | 22 | > {{icon name="far fa-info-circle" size="3"/}} **Hinweis:** |
| 23 | > Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung. | ||
| |
1.1 | 24 | |
| |
6.1 | 25 | ## Beispielanwendung (Swagger-Dokumentation) |
| |
1.1 | 26 | |
| |
6.1 | 27 | 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 |
| |
1.1 | 28 | |
| |
6.1 | 29 | Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt. |
| |
1.1 | 30 | |
| |
6.1 | 31 | ### Testdaten zu Demonstrationszwecken |
| |
3.1 | 32 | |
| |
7.1 | 33 | ***organizationID:*** 77777777-0000 |
| 34 | ***Identifier:*** KFAS_SubmissionAPI_Test_WithUpload | ||
| 35 | ***transactionID:*** KFAS_SubmissionAPI_Test_WithUpload-SxqFFZb | ||
| 36 | ***messageID:*** 6050a243756f151657af46a4 | ||
| 37 | ***fileID:*** 6050a2e8756f151657af46a6 | ||
| |
1.1 | 38 | |
| |
7.1 | 39 | |
| 40 |