Änderungen von Dokument API-Key

Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

...	...	@@ -1,6 +1,6 @@
1	1	## API-Keys für die Authentifizierung
2	2
3		-Um die von Form-Solutions bereitgestellten APIs verwenden zu können, muss für jeden Mandanten ein API-Key zur Authentifizierung in der Server-Konfiguration hinterlegt werden. Die Keys können unter der [Hauptnavigationsleiste](https://wiki.form-solutions.de/wiki/docwiki/view/Main/03_Hauptnavigationsleiste/) "Einstellungen/Server-Administration/API-Keys" hinterlegt werden.
	3	+Um die von MACH ProForms bereitgestellten APIs verwenden zu können, muss für jeden Mandanten ein API-Key zur Authentifizierung in der Server-Konfiguration hinterlegt werden. Die Keys können unter der [Hauptnavigationsleiste](https://wiki.form-solutions.de/wiki/docwiki/view/Main/03_Hauptnavigationsleiste/) "Einstellungen/Server-Administration/API-Keys" hinterlegt werden.
4	4
5	5	> {{icon name="far fa-info-circle" size="3"/}} _**Hinweis:**_
6	6	>
...	...	@@ -30,22 +30,16 @@
30	30
31	31	* **Kundennummer**
32	32	Hierüber kann nach der Kundennummer gesucht werden. Diese Nummer ist immer eine 12-stellige Nummer, die sich beispielsweise wie folgt aufgliedert 33333333-3333.
33		-
34	34	* **API-Keys**
35	35	Hierüber kann nach dem einzigartigen API-Key gesucht werden.
36		-
37	37	* **Zertifiziert**
38	38	Hierüber kann nach der Zertifizierung gesucht werden.
39		-
40	40	* **Remote-IP**
41	41	Hierüber kann nach der hinterlegtem Remote-IP gesucht werden.
42		-
43	43	* **Gültig von**
44	44	Hierüber kann nach dem Gültigkeitsdatum (von) des API-Keys gesucht werden.
45		-
46	46	* **Gültig bis**
47	47	Hierüber kann nach dem Gültigkeitsdatum (bis) des API-Keys gesucht werden.
48		-
49	49	* **Beschreibung**
50	50	Hierüber kann nach einem Wort in den Notizen gesucht werden.
51	51
...	...	@@ -57,22 +57,16 @@
57	57
58	58	* **API-Key**
59	59	Hier wird ein entsprechender API-Key beim Anlegen generiert. Da dieser Wert nicht verändert werden darf, ist das Feld schreibgeschützt.
60		-
61	61	* **Kundennummer**
62	62	Hier muss die exakte Kundennummer angegeben werden, sodass der API-Key dem Mandanten entsprechend zugeordnet wird.
63		-
64	64	* **Erstellt**
65	65	Hier wird das entsprechende Gültigkeitsdatum angegeben, ab wann das Zertifikat gültig ist.
66		-
67	67	* **Gültig bis**
68	68	Hier kann das entsprechende Gültigkeitsdatum angegeben werden, ab wann das Zertifikat nicht mehr gültig ist. Das hier angegebene Datum muss immer beim Anlegen mindestens drei Tage nach dem Datum "Gültig von" liegen.
69		-
70	70	* **Remote-IP**
71	71	Hier kann eine Remote-IP hinterlegt werden.
72		-
73	73	* **Beschreibung**
74	74	Hier können interne Notizen hinterlegt werden. Diese haben keinerlei Auswirkungen.
75		-
76	76	* **Zertifikatsdatei**
77	77	Hier kann die entsprechende Datei, welche als Zertifikat verwendet werden soll, hochladen werden. Es sind Formate nach dem Standard X.509 zugelassen.
78	78
...	...	@@ -83,7 +83,7 @@
83	83	* **SecurePostData**
84	84	Mit diesem Recht kann der API-Key für die Authentifizierung zur Nutzung der [SecurePostData-Schnittstelle](https://wiki.form-solutions.de/wiki/admindoku/view/Main/03_Steuerungsprozess/02_Vorbef%C3%BCllung/02_SecurePostdata/) verwendet werden. Es wird empfohlen pro Mandant lediglich einen API-Key mit diesem Recht zu versehen, um eine Eindeutigkeit des verwendeten Schlüssels zu gewährleisten.
85	85	* **Unbegrenzt**
86		-Mit diesem Recht kann der API-Key für alle vorgesehenen Schnittstellen von Form-Solutions verwendet werden.
	74	+Mit diesem Recht kann der API-Key für alle vorgesehenen Schnittstellen von MACH ProForms verwendet werden.
87	87
88	88	![[Ansicht der Eingabemaske "Neuer API-Key anlegen" - Berechtigungen|@ApiKeyAnlegen_Berechtigungen.jpg]]
89	89
...	...	@@ -101,4 +101,4 @@
101	101
102	102	#### Standardbenutzer nicht vorhanden
103	103
104		-Für die Benutzung der API ist es notwendig, dass unter der Kundennummer (Mandantennummer) der Benutzer _{Mandantennummer}-0000_ vorhanden ist. Sollte dies nicht der Fall sein, so kommt es z.B. bei der Benutzung der Search-API zu einer _UserNotFound_-Exception.
	92	+Für die Benutzung der API ist es notwendig, dass unter der Kundennummer (Mandantennummer) der Benutzer _{Mandantennummer}-0000_ vorhanden ist. Sollte dies nicht der Fall sein, so kommt es z.B. bei der Benutzung der Search-API zu einer _UserNotFoundException_.