Änderungen von Dokument API-Key

Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

...	...	@@ -5,53 +5,80 @@
5	5
6	6	== API-Keys für die Authentifizierung ==
7	7
8		-[[image:@ServerAdministrationHauptmenüpunkt.jpg||alt="Ansicht des Hauptmenüpunkts „Server-Administration“" data-xwiki-image-style-alignment="end" height="71" width="300"]]Um die von MACH formsolutions 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.machproforms.de/wiki/docwiki/view/Main/03_Hauptnavigationsleiste/]] "Einstellungen/Server-Administration/API-Keys" generiert werden.
	8	+Um die von MACH formsolutions 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.machproforms.de/wiki/docwiki/view/Main/03_Hauptnavigationsleiste/]] "Einstellungen/Server-Administration/API-Keys" hinterlegt werden.
9	9
10	10	>{{icon name="far fa-info-circle" size="3"/}} //**Hinweis:**//
11	11	>Diese Funktion steht nur Server-Administratoren zur Verfügung.
12	12
	13	+[[image:@ServerAdministrationHauptmenüpunkt.jpg||alt="Ansicht des Hauptmenüpunkts „Server-Administration“"]]
	14	+
	15	+----
	16	+
	17	+== Übersicht ==
	18	+
	19	+Nach dem Auswahl 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.
	20	+
	21	+[[image:@ServerAdministrationÜbersicht.jpg||alt="Ansicht der Übersicht „Server-Administration“"]]
	22	+
	23	+----
	24	+
13	13	== API-Keys ==
14	14
15	15	Unter dem Menüpunkt „API-Keys“ gelangt man in die Verwaltung der API-Keys. Hier können neue sowie bereits angelegte API-Keys verwaltet werden.
16	16
	29	+[[image:@ServerAdministrationAPIKEY.jpg||alt="Ansicht der „API-Key-Übersicht“"]]
	30	+
17	17	=== Filter in der API-Keys-Übersicht ===
18	18
19	19	Über die Filter in der API-Keys-Übersicht kann nach einem/mehreren API-Keys gesucht werden. Folgende Filtermöglichkeiten stehen hierzu zur Verfügung:
20	20
21		-* **Kundennummer (12345678-0000)**
22		-* **API-Key**
	35	+* **Kundennummer**
	36	+Hierüber kann nach der Kundennummer gesucht werden. Diese Nummer ist immer eine 12-stellige Nummer, die sich beispielsweise wie folgt aufgliedert 33333333-3333.
	37	+* **API-Keys**
	38	+Hierüber kann nach dem einzigartigen API-Key gesucht werden.
23	23	* **Zertifiziert**
	40	+Hierüber kann nach der Zertifizierung gesucht werden.
24	24	* **Remote-IP**
	42	+Hierüber kann nach der hinterlegtem Remote-IP gesucht werden.
25	25	* **Gültig von**
	44	+Hierüber kann nach dem Gültigkeitsdatum (von) des API-Keys gesucht werden.
26	26	* **Gültig bis**
	46	+Hierüber kann nach dem Gültigkeitsdatum (bis) des API-Keys gesucht werden.
27	27	* **Beschreibung**
	48	+Hierüber kann nach einem Wort in den Notizen gesucht werden.
28	28
29		-=== API-Key anlegen [[image:@ApiKeyNeueHinzufügen.jpg||alt="Schaltfläche „Neuer API-Key anlegen“"]] ===
	50	+[[image:@ApiKeyFilter.jpg||alt="Ansicht der Filter"]]
30	30
31		-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. Die Maske enthält die folgenden Felder:
	52	+=== Neuer API-Key anlegen [[image:@ApiKeyNeueHinzufügen.jpg||alt="Schaltfläche „Neuer API-Key anlegen“"]] ===
32	32
	54	+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:
	55	+
33	33	* **API-Key**
34		-Hier wird ein API-Key generiert.
35		-Da dieser Wert vom System vergeben wird, ist das Feld schreibgeschützt.
	57	+Hier wird ein entsprechender API-Key beim Anlegen generiert. Da dieser Wert nicht verändert werden darf, ist das Feld schreibgeschützt.
36	36	* **Kundennummer**
37		-Kundennummer im Format 12345678-0000
	59	+Hier muss die exakte Kundennummer angegeben werden, sodass der API-Key dem Mandanten entsprechend zugeordnet wird.
38	38	* **Erstellt**
39		-Erstellungsdatum und Datum, ab dem der API-Key gültig ist.
40		-Da dieser Wert vom System vergeben wird, ist das Feld schreibgeschützt.
	61	+Hier wird das entsprechende Gültigkeitsdatum angegeben, ab wann das Zertifikat gültig ist.
41	41	* **Gültig bis**
42		-Datum, ab dem das Zertifikat nicht mehr gültig ist. Muss mindestens drei Tage nach dem Erstellungsdatum liegen.
	63	+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.
43	43	* **Remote-IP**
44		-* **Beschreibung **(interne Notizen)
	65	+Hier kann eine Remote-IP hinterlegt werden.
	66	+* **Beschreibung**
	67	+Hier können interne Notizen hinterlegt werden. Diese haben keinerlei Auswirkungen.
45	45	* **Zertifikatsdatei**
46		-Es sind Formate nach dem Standard X.509 zugelassen.
	69	+Hier kann die entsprechende Datei, welche als Zertifikat verwendet werden soll, hochladen werden. Es sind Formate nach dem Standard X.509 zugelassen.
47	47
48		-Es ist außerdem verpflichtend, dem API-Key vor dem Speichern eine der unten aufgeführten Berechtigungen zuzuweisen.
	71	+[[image:@ApiKeyAnlegen_Stammdaten.jpg||alt="Ansicht der Eingabemaske ~"Neuer API-Key anlegen~" - Stammdaten"]]
49	49
	73	+Es ist außerdem verpflichtend dem API-Key vor dem Speichern eine der unten aufgeführten Berechtigungen zuzuweisen.
	74	+
50	50	* **SecurePostData**
51		-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 genau einen API-Key mit diesem Recht zu versehen, um eine Eindeutigkeit des verwendeten Schlüssels zu gewährleisten.
	76	+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.
52	52	* **Unbegrenzt**
53	53	Mit diesem Recht kann der API-Key für alle vorgesehenen Schnittstellen von MACH formsolutions verwendet werden.
54	54
	80	+[[image:@ApiKeyAnlegen_Berechtigungen.jpg||alt="Ansicht der Eingabemaske ~"Neuer API-Key anlegen~" - Berechtigungen"]]
	81	+
55	55	Nach der Eingabe aller erforderlichen Daten kann der API-Key über die Schaltfläche „Speichern“ gespeichert werden. Der Ersteller wird daraufhin wieder in die „API-Key-Übersicht“ weitergeleitet in der ein neuer Eintrag erstellt wurde.
56	56
57	57	=== API-Key bearbeiten [[image:@ApiKeyBearbeiten.jpg||alt="Schaltfläche „API-Key bearbeiten“"]] ===