Wiki-Quellcode von API-Key

Zuletzt geändert von MACH ProForms GmbH am 04.07.2024

version	line-number	content
1.1	1	## API-Keys für die Authentifizierung
	2
196.1	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.machproforms.de/wiki/docwiki/view/Main/03_Hauptnavigationsleiste/) "Einstellungen/Server-Administration/API-Keys" hinterlegt werden.
1.1	4
192.1	5	> {{icon name="far fa-info-circle" size="3"/}} _Hinweis:_
	6	>
195.1	7	> Diese Funktion steht nur Server-Administratoren zur Verfügung.
1.1	8
	9	![[Ansicht des Hauptmenüpunkts „Server-Administration“\|@ServerAdministrationHauptmenüpunkt.jpg]]
	10
192.1	11	---
	12
1.1	13	## Übersicht
	14
195.1	15	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.
1.1	16
	17	![[Ansicht der Übersicht „Server-Administration“\|@ServerAdministrationÜbersicht.jpg]]
	18
192.1	19	---
1.1	20
	21	## API-Keys
	22
	23	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.
	24
	25	![[Ansicht der „API-Key-Übersicht“\|@ServerAdministrationAPIKEY.jpg]]
	26
	27	### Filter in der API-Keys-Übersicht
	28
	29	Über die Filter in der API-Keys-Übersicht kann nach einem/mehreren API-Keys gesucht werden. Folgende Filtermöglichkeiten stehen hierzu zur Verfügung:
	30
192.1	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.
1.1	45
	46	![[Ansicht der Filter\|@ApiKeyFilter.jpg]]
	47
	48	### Neuer API-Key anlegen ![[Schaltfläche „Neuer API-Key anlegen“\|@ApiKeyNeueHinzufügen.jpg]]
	49
	50	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:
	51
192.1	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.
1.1	66
	67	![[Ansicht der Eingabemaske "Neuer API-Key anlegen" - Stammdaten\|@ApiKeyAnlegen_Stammdaten.jpg]]
	68
	69	Es ist außerdem verpflichtend dem API-Key vor dem Speichern eine der unten aufgeführten Berechtigungen zuzuweisen.
	70
192.1	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
194.1	74	Mit diesem Recht kann der API-Key für alle vorgesehenen Schnittstellen von MACH ProForms verwendet werden.
1.1	75
	76	![[Ansicht der Eingabemaske "Neuer API-Key anlegen" - Berechtigungen\|@ApiKeyAnlegen_Berechtigungen.jpg]]
	77
	78	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.
	79
	80	### API-Key bearbeiten ![[Schaltfläche „API-Key bearbeiten“\|@ApiKeyBearbeiten.jpg]]
	81
	82	Müssen die Daten zu einem API-Key geändert werden, so kann dies ein Benutzer, der das entsprechende Recht hat. Hierzu steht die Schaltfläche „Bearbeiten“ in der API-Key-Übersicht direkt am entsprechenden API-Key zur Verfügung. Nach dem Öffnen gelangt man direkt in die Eingabemaske „API-Key bearbeiten“, in der die Daten zum API-Key hinterlegt sind. Nach der Eingabe der geänderten Daten und dem Hochladen eines gültigen Zertifikats muss über die Schaltfläche „Speichern“ der API-Key gespeichert werden.
	83
	84	### API-Key löschen ![[Schaltfläche „API-Key löschen“\|@ApiKeyLöschen.jpg]]
	85
	86	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.
	87
192.1	88	### Mögliche Fehlerquellen
	89
	90	#### Standardbenutzer nicht vorhanden
	91
193.1	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_.