Änderungen von Dokument API-Key

Zusammenfassung

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

Details

Seiteneigenschaften

Dokument-Autor

...	...	@@ -1,1 +1,1 @@
1		-xwiki:XWiki.Dokumentation
	1	+xwiki:XWiki.fweise

Inhalt

...	...	@@ -2,12 +2,14 @@
2	2
3	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.
4	4
5		-> {{icon name="far fa-info-circle" size="3"/}} ***Hinweis:***
	5	+> {{icon name="far fa-info-circle" size="3"/}} _**Hinweis:**_
	6	+>
6	6	> Diese Funktion steht nur Serveradministratoren zur Verfügung.
7	7
8	8	![[Ansicht des Hauptmenüpunkts „Server-Administration“|@ServerAdministrationHauptmenüpunkt.jpg]]
9		-___
10	10
	11	+---
	12	+
11	11	## Übersicht
12	12
13	13	Nach dem Betätigen des Menüpunkts „Server-Administration“ gelangt man auf eine Übersichtsseite. Dieser Bereich befindet sich derzeit noch im Aufbau und wird in Kürze weitere Funktionen beinhalten.
...	...	@@ -14,7 +14,7 @@
14	14
15	15	![[Ansicht der Übersicht „Server-Administration“|@ServerAdministrationÜbersicht.jpg]]
16	16
17		-___
	19	+---
18	18
19	19	## API-Keys
20	20
...	...	@@ -26,33 +26,21 @@
26	26
27	27	Über die Filter in der API-Keys-Übersicht kann nach einem/mehreren API-Keys gesucht werden. Folgende Filtermöglichkeiten stehen hierzu zur Verfügung:
28	28
29		-- **Kundennummer**<br />
30		- Hierüber kann nach der Kundennummer gesucht werden. Diese Nummer ist immer eine 12-stellige Nummer, die sich beispielsweise wie folgt aufgliedert 33333333-3333.
31		-<br />
	31	+* **Kundennummer**
	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	+* **API-Keys**
	34	+Hierüber kann nach dem einzigartigen API-Key gesucht werden.
	35	+* **Zertifiziert**
	36	+Hierüber kann nach der Zertifizierung gesucht werden.
	37	+* **Remote-IP**
	38	+Hierüber kann nach der hinterlegtem Remote-IP gesucht werden.
	39	+* **Gültig von**
	40	+Hierüber kann nach dem Gültigkeitsdatum (von) des API-Keys gesucht werden.
	41	+* **Gültig bis**
	42	+Hierüber kann nach dem Gültigkeitsdatum (bis) des API-Keys gesucht werden.
	43	+* **Beschreibung**
	44	+Hierüber kann nach einem Wort in den Notizen gesucht werden.
32	32
33		-- **API-Keys**<br />
34		- Hierüber kann nach dem einzigartigen API-Key gesucht werden.
35		-<br />
36		-
37		-- **Zertifiziert**<br />
38		- Hierüber kann nach der Zertifizierung gesucht werden.
39		-<br />
40		-
41		-- **Remote-IP**<br />
42		- Hierüber kann nach der hinterlegtem Remote-IP gesucht werden.
43		-<br />
44		-
45		-- **Gültig von**<br />
46		- Hierüber kann nach dem Gültigkeitsdatum (von) des API-Keys gesucht werden.
47		-<br />
48		-
49		-- **Gültig bis**<br />
50		- Hierüber kann nach dem Gültigkeitsdatum (bis) des API-Keys gesucht werden.
51		-<br />
52		-
53		-- **Beschreibung**<br />
54		- Hierüber kann nach einem Wort in den Notizen gesucht werden.
55		-
56	56	![[Ansicht der Filter|@ApiKeyFilter.jpg]]
57	57
58	58	### Neuer API-Key anlegen ![[Schaltfläche „Neuer API-Key anlegen“|@ApiKeyNeueHinzufügen.jpg]]
...	...	@@ -59,43 +59,28 @@
59	59
60	60	Neue API-Keys können über die Schaltfläche „Hinzufügen“ in der API-Key-Übersicht angelegt werden. Daraufhin öffnet sich die Eingabemaske „API-Key anlegen“, in der die Daten zum API-Key hinterlegt werden können. Folgende Stammdaten müssen angegeben werden:
61	61
62		-- **API-Key** <br />
63		- Hier wird ein entsprechender API-Key beim Anlegen generiert. Da dieser Wert nicht verändert werden darf, ist das Feld schreibgeschützt.
64		-<br />
	52	+* **API-Key**
	53	+Hier wird ein entsprechender API-Key beim Anlegen generiert. Da dieser Wert nicht verändert werden darf, ist das Feld schreibgeschützt.
	54	+* **Kundennummer**
	55	+Hier muss die exakte Kundennummer angegeben werden, sodass der API-Key dem Mandanten entsprechend zugeordnet wird.
	56	+* **Erstellt**
	57	+Hier wird das entsprechende Gültigkeitsdatum angegeben, ab wann das Zertifikat gültig ist.
	58	+* **Gültig bis**
	59	+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.
	60	+* **Remote-IP**
	61	+Hier kann eine Remote-IP hinterlegt werden.
	62	+* **Beschreibung**
	63	+Hier können interne Notizen hinterlegt werden. Diese haben keinerlei Auswirkungen.
	64	+* **Zertifikatsdatei**
	65	+Hier kann die entsprechende Datei, welche als Zertifikat verwendet werden soll, hochladen werden. Es sind Formate nach dem Standard X.509 zugelassen.
65	65
66		-- **Kundennummer** <br />
67		- Hier muss die exakte Kundennummer angegeben werden, sodass der API-Key dem Mandanten entsprechend zugeordnet wird.
68		-<br />
69		-
70		-- **Erstellt**<br />
71		- Hier wird das entsprechende Gültigkeitsdatum angegeben, ab wann das Zertifikat gültig ist.
72		-<br />
73		-
74		-- **Gültig bis**<br />
75		- 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.
76		-<br />
77		-
78		-- **Remote-IP**<br />
79		- Hier kann eine Remote-IP hinterlegt werden.
80		-<br />
81		-
82		-- **Beschreibung**<br />
83		- Hier können interne Notizen hinterlegt werden. Diese haben keinerlei Auswirkungen.
84		-<br />
85		-
86		-- **Zertifikatsdatei**<br />
87		- Hier kann die entsprechende Datei, welche als Zertifikat verwendet werden soll, hochladen werden. Es sind Formate nach dem Standard X.509 zugelassen.
88		-
89	89	![[Ansicht der Eingabemaske "Neuer API-Key anlegen" - Stammdaten|@ApiKeyAnlegen_Stammdaten.jpg]]
90	90
91		-
92	92	Es ist außerdem verpflichtend dem API-Key vor dem Speichern eine der unten aufgeführten Berechtigungen zuzuweisen.
93	93
94		-- **SecurePostData**<br />
95		-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.
96		-Es wird empfohlen pro Mandant lediglich einen API-Key mit diesem Recht zu versehen, um eine Eindeutigkeit des verwendeten Schlüssels zu gewährleisten.
97		-
98		-- **Unbegrenzt**<br />
	71	+* **SecurePostData**
	72	+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.
	73	+* **Unbegrenzt**
99	99	Mit diesem Recht kann der API-Key für alle vorgesehenen Schnittstellen von Form-Solutions verwendet werden.
100	100
101	101	![[Ansicht der Eingabemaske "Neuer API-Key anlegen" - Berechtigungen|@ApiKeyAnlegen_Berechtigungen.jpg]]
...	...	@@ -110,3 +110,8 @@
110	110
111	111	Muss ein API-Key gelöscht werden, kann das ein Benutzer, mit dem entsprechenden Recht, in der API-Key-Übersicht. Hierzu steht neben jedem API-Key die Schaltfläche „Löschen“ zur Verfügung.
112	112
	88	+### Mögliche Fehlerquellen
	89	+
	90	+#### Standardbenutzer nicht vorhanden
	91	+
	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_.