Änderungen von Dokument API-Key
Zuletzt geändert von MACH formsolutions am 08.04.2026
Von Version 202.1
bearbeitet von MACH formsolutions
am 08.04.2026
am 08.04.2026
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Auf Version 201.1
bearbeitet von MACH formsolutions
am 08.04.2026
am 08.04.2026
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Zusammenfassung
-
Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
Details
- Seiteneigenschaften
-
- Inhalt
-
... ... @@ -26,18 +26,16 @@ 26 26 * **Gültig bis** 27 27 * **Beschreibung** 28 28 29 -=== API-Key anlegen [[image:@ApiKeyNeueHinzufügen.jpg||alt="Schaltfläche „Neuer API-Key anlegen“"]] === 29 +=== Neuer API-Key anlegen [[image:@ApiKeyNeueHinzufügen.jpg||alt="Schaltfläche „Neuer API-Key anlegen“"]] === 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. DieMaske enthältdiefolgendenFelder: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. Folgende Stammdaten müssen angegeben werden: 32 32 33 33 * **API-Key** 34 -Hier wird ein API-Key generiert. 35 -Da dieser Wert vom System vergeben wird, ist das Feld schreibgeschützt. 34 +Hier wird ein API-Key generiert. Da dieser Wert vom System vergeben wird, ist das Feld schreibgeschützt. 36 36 * **Kundennummer** 37 37 Kundennummer im Format 12345678-0000 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. 38 +Erstellungsdatum und Datum, ab dem der API-Key gültig ist. Da dieser Wert vom System vergeben wird, ist das Feld schreibgeschützt. 41 41 * **Gültig bis** 42 42 Datum, ab dem das Zertifikat nicht mehr gültig ist. Muss mindestens drei Tage nach dem Erstellungsdatum liegen. 43 43 * **Remote-IP** ... ... @@ -45,13 +45,17 @@ 45 45 * **Zertifikatsdatei** 46 46 Es sind Formate nach dem Standard X.509 zugelassen. 47 47 48 - Esistaußerdem verpflichtend, dem API-Key vordem Speicherneinederunten aufgeführtenBerechtigungenzuzuweisen.46 +[[image:@ApiKeyAnlegen_Stammdaten.jpg||alt="Ansicht der Eingabemaske ~"Neuer API-Key anlegen~" - Stammdaten"]] 49 49 48 +Es ist außerdem verpflichtend dem API-Key vor dem Speichern eine der unten aufgeführten Berechtigungen zuzuweisen. 49 + 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 Mandantgenaueinen API-Key mit diesem Recht zu versehen, um eine Eindeutigkeit des verwendeten Schlüssels zu gewährleisten.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 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 55 +[[image:@ApiKeyAnlegen_Berechtigungen.jpg||alt="Ansicht der Eingabemaske ~"Neuer API-Key anlegen~" - Berechtigungen"]] 56 + 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“"]] ===