Änderungen von Dokument Server-Administration

Zuletzt geändert von MACH ProForms GmbH am 04.07.2024

Von Version 498.1
bearbeitet von MACH ProForms GmbH
am 06.08.2021
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 487.1
bearbeitet von MACH ProForms GmbH
am 24.06.2021
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -57,7 +57,7 @@
57 57  
58 58  ### Neuer API-Key anlegen ![[Schaltfläche „Neuer API-Key anlegen“|@ApiKeyNeueHinzufügen.jpg]]
59 59  
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:
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 Daten müssen angegeben werden:
61 61  
62 62  - **API-Key** <br />
63 63   Hier wird ein entsprechender API-Key beim Anlegen generiert. Da dieser Wert nicht verändert werden darf, ist das Feld schreibgeschützt.
... ... @@ -86,22 +86,10 @@
86 86  - **Zertifikatsdatei**<br />
87 87   Hier kann die entsprechende Datei, welche als Zertifikat verwendet werden soll, hochladen werden. Es sind Formate nach dem Standard X.509 zugelassen.
88 88  
89 -![[Ansicht der Eingabemaske "Neuer API-Key anlegen" - Stammdaten|@ApiKeyAnlegen_Stammdaten.jpg]]
90 -
91 -
92 -Es ist außerdem verpflichtend dem API-Key vor dem Speichern eine der unten aufgeführten Berechtigungen zuzuweisen.
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 />
99 -Mit diesem Recht kann der API-Key für alle vorgesehenen Schnittstellen von Form-Solutions verwendet werden.
100 -
101 -![[Ansicht der Eingabemaske "Neuer API-Key anlegen" - Berechtigungen|@ApiKeyAnlegen_Berechtigungen.jpg]]
102 -
103 103  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.
104 104  
91 +![[Ansicht der Eingabemaske "Neuer API-Key anlegen"|@ApiKeyAnlegen.jpg]]
92 +
105 105  ### API-Key bearbeiten ![[Schaltfläche „API-Key bearbeiten“|@ApiKeyBearbeiten.jpg]]
106 106  
107 107  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.