Zum Inhalt springen

Änderungen von Dokument Search-API

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

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -22,21 +22,24 @@
22 22  
23 23  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.
24 24  
25 -Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
26 -***Mandantennummer:*** 77777777-0000
27 -***API-Schlüssel:*** yIJNM2BS6LI0lS25Qa5xbtEK
25 +Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
26 +***Mandantennummer:*** 77777777-0000
27 +***API-Schlüssel:*** yIJNM2BS6LI0lS25Qa5xbtEK
28 28  > {{icon name="far fa-info-circle" size="3"/}} ***Hinweis:***
29 -> Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung.
29 +> Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung.
30 30  
31 31  ## Beispielanwendung (Swagger-Dokumentation)
32 32  
33 33  Um die Schnittstelle beispielhaft bedienen zu können, wird eine Demoanwendung unter folgender URL bereitgestellt: https://vertrieb.form-solutions.de/search/api/swagger-ui/index.html
34 34  
35 +> ***Achtung***
36 +> Die oben verlinkte Swagger-Dokumentation greift auf den Form-Solutions internen Vertriebsserver zu. Um die Dokumentation auf anderen Servern einzusehen muss die URL folgendem Format entsprechen: < BASIS_URL >/submission/swagger-ui/index.html
37 +
35 35  Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt.
36 36  
37 37  ### Testdaten zu Demonstrationszwecken
38 38  
39 -***organizationID:*** 77777777-0000
40 -***leikaID:*** 99102013000000 (Hundesteuer)
41 -***ozgID:*** (aktuell gibt es noch keine Testmöglichkeit)
42 +***organizationID:*** 77777777-0000
43 +***leikaID:*** 99102013000000 (Hundesteuer)
44 +***ozgID:*** (aktuell gibt es noch keine Testmöglichkeit)
42 42