Wiki-Quellcode von Parkausweis

Zuletzt geändert von MACH ProForms GmbH am 04.07.2024

version	line-number	content
181.1	1	## Allgemeines
1.1	2
181.1	3	### Voraussetzungen
1.1	4
336.1	5	* Ein [[Paymentanbieter\|Main.07_Einstellungen-Fachadministration.03_Module.01_Payment]] ist bereits eingerichtet.
	6	* Assistentenrechte für den [[Mandanten\|Main.07_Einstellungen-Fachadministration.01_Mandanten.01_Rechte]] sowie den [[Benutzer\|Main.07_Einstellungen-Fachadministration.02_Benutzer.02_Benutzereinzelrechte]] sind vorhanden.
	7	* Modulkonfigurationsrechte für den [[Mandanten\|Main.07_Einstellungen-Fachadministration.01_Mandanten.01_Rechte]] sowie für den [[Benutzer\|Main.07_Einstellungen-Fachadministration.02_Benutzer.02_Benutzereinzelrechte]] sind vorhanden.
1.1	8
181.1	9	### Relevante Daten
1.1	10
336.1	11	* WebService-Url
	12	* X-ApiKey
	13	* Referer
1.1	14
336.1	15	---
1.1	16
181.1	17	## Konfiguration des WebServices
1.1	18
	19	Es muss sichergestellt werden, dass der WebService "HSH Parkausweis" zur Verfügung steht (siehe hierzu "[[Webservice Einrichten\|Main.07_Einstellungen-Fachadministration.03_Module.06_Webservice.01_WebserviceEinrichten]])". Hierzu kann entweder der Reiter "Web Services" - "WebService-Definition" oder "WebService-Konfiguration" genutzt werden. Ist die Replikation eingerichtet, sollte der WebService bereits vorhanden sein.
	20
336.1	21	Unter "WebService-Konfiguration" müssen anschließend die obigen erwähnten Daten erfasst werden. Hierzu wird der WebService-Name "HSH-Parkausweis", die WebService-OrganisationsID "22222222-2222", sowie die von dem Anbieter bereitgestellte, bestenfalls aktuellste WebService-Version ausgewählt. Anschließend wird die WebService-URL eingetragen, beispielsweise "<https://www.meldebehoerde.de:443/cebit/IRWSBV/soap/olav/v2/parkausweis>".
1.1	22
	23	"Werte für HTTP-Basic Authentifikation" sind standardmäßig nicht zu befüllen.
	24
336.1	25	"Werte für Zertifikatsauthentifizierung" sind standardmäßig nicht zu befüllen. Eine Einrichtung wird jedoch empfohlen.
1.1	26
336.1	27	"Werte für Queue-Messaging Konfiguration" sind standardmäßig nicht zu befüllen. Eine Einrichtung wird jedoch empfohlen (siehe hierzu "[[Security Paket\|Main.07_Einstellungen-Fachadministration.03_Module.09_Security-Paket]])".
1.1	28
	29	Die Aktionsparameter sind zu definieren (siehe hierzu "[[Webservice Einrichten\|Main.07_Einstellungen-Fachadministration.03_Module.06_Webservice.01_WebserviceEinrichten]]").
	30
	31	Die Werte der Parameter sind je nach Kunden spezifisch anzupassen.
	32
	33	Nachfolgend werden die Aktionsparameter für "HSH Parkausweis" aufgelistet.
	34
	35	```
	36	Aktionsname des WebServices
	37	suche
	38	Parametername
	39	{http://parkausweis.v2.olav.services.endpoint.ireg.web.hshsoft.de/}suche:fassung
	40	Wert des Parameters
	41	2019-01-01
	42
	43	Aktionsname des WebServices
	44	suche
	45	Parametername
	46	{http://parkausweis.v2.olav.services.endpoint.ireg.web.hshsoft.de/}suche:test
	47	Wert des Parameters
	48	?
	49
	50	Aktionsname des WebServices
	51	suche
	52	Parametername
	53	{http://parkausweis.v2.olav.services.endpoint.ireg.web.hshsoft.de/}suche:responsewithoutrequest
	54	Wert des Parameters
	55	?
	56
	57	Aktionsname des WebServices
	58	suche
	59	Parametername
	60	{http://parkausweis.v2.olav.services.endpoint.ireg.web.hshsoft.de/}suche:produkt
	61	Wert des Parameters
	62	Informationsregister
	63
	64	Aktionsname des WebServices
	65	suche
	66	Parametername
	67	{http://parkausweis.v2.olav.services.endpoint.ireg.web.hshsoft.de/}suche:produkthersteller
	68	Wert des Parameters
	69	HSH Soft- und Hardware Vertriebs GmbH
	70
	71	Aktionsname des WebServices
	72	suche
	73	Parametername
	74	{http://parkausweis.v2.olav.services.endpoint.ireg.web.hshsoft.de/}suche:produktversion
	75	Wert des Parameters
	76	1.10
	77
	78	Aktionsname des WebServices
	79	suche
	80	Parametername
	81	{http://parkausweis.v2.olav.services.endpoint.ireg.web.hshsoft.de/}suche:version
	82	Wert des Parameters
	83	1.0
	84	```
	85
	86	![[Webservice Header Parameter\|@WebServiceHeaderParameter.jpg]]
	87
	88	Unter "WebService-HeaderParameter" ist der obige erwähnte X-ApiKey sowie ein Referer einzutragen.
	89
336.1	90	---
1.1	91
181.1	92	## Konfiguration der Veröffentlichung
1.1	93
336.1	94	Beim entsprechenden Assistent muss eine WebService-Einreichung konfiguriert werden (siehe hierzu "[[Webservice Einrichten\|Main.07_Einstellungen-Fachadministration.03_Module.06_Webservice.01_WebserviceEinrichten]])". Für die Einreichung wird der WebService "HSH Parkausweis" ausgewählt.
1.1	95
	96	![[WebService Einreichung\|@Einreichung.jpg]]
	97
	98	Damit diese Konfiguration genutzt wird, müssen über Formularkonfiguration weitere Veröffentlichungskonfigurationen definiert werden (siehe hierzu "[[Webservice Einrichten\|Main.05_Assistenten.02_VeröffentlichungvonAssistenten]])".
	99
	100	Das Formular muss per "Senden per E-Mail/Webservice" versendet werden.
	101
	102	![[Auswahl Sendeart\|@PHP12.jpg]]
	103
	104	Auf der nachfolgenden Seite muss die Option "Senden mit Webservice" ausgewählt und die entsprechende WebService-Url (siehe oben) hinterlegt werden.
	105
	106	![[Hinterlegung Webservice URL\|@PHP34.jpg]]
	107
	108	Nach Bestätigen der Seite ist die Konfiguration abgeschlossen.