Erstellen eines API-Schlüssels

Vor Beginn

Sie können API-Schlüssel für Mitarbeiter oder Roboter erstellen. Hierbei handelt es sich um den Identifikationscode eines Benutzers (oder Entwicklers), der für den Zugriff auf unsere APIs nötig ist. Die API-Schlüssel werden verwendet, um die Verwendung der API überprüfen und verfolgen zu können. Der API-Schlüssel dient als eindeutige ID und Security-Token für die Authentifizierung, und entspricht unterschiedlichen Zugriffsrechten, die mit ihm verknüpft ist.

Achten Sie darauf, welche Berechtigungen Sie mit dem Schlüssel verknüpfen und an wen Sie das Token übertragen. Die Person, die dieses Token besitzt, kann vertrauliche Informationen enthalten.

Erstellen eines neuen API-Schlüssels

Klicken Sie auf das Zahnrad und anschließend auf Authentifizierung, SSO und API API-Schlüssel, um einen neuen API-Schlüssel zu erstellen. Sollten Sie nicht über die Zugangsrechte verfügen, können Sie sich an Ihren Administrator wenden, damit dieser einen API-Schlüssel erstellt. Wenn Sie Administrator sind, jedoch nicht auf die Rollen zugreifen können, wenden Sie sich an den Help Desk.

chrome_wlrta4DtL3.png

Klicken Sie auf Neuen API-Schlüssel erstellen, um dies zu tun.

generercleapi.png

Im Erstellungsfenster:

  • Geben Sie den gewünschten Namen für den Schlüssel ein.
  • Wählen Sie die Berechtigungen aus, die Sie mit diesem Schlüssel verknüpfen möchten (hier muss mindestens eine Berechtigung ausgewählt werden. Dies kann später bearbeitet werden, so wie dies nachstehend beschrieben wird).

Erweiterte Optionen: Sie können den Schlüssel individuell einstellen. Sie müssen jedoch das GUID-Format (Globally Unique Identifier) verwenden, das einer eindeutigen ID mit 16 Byte entspricht (z. B.: [%1$s:3F2504E0-4F89-11D3-9A0C-0305E82C3301]).

chrome_2020-11-03_11-10-00.png

Sobald der Schlüssel erstellt wurde, können Sie diesen kopieren, indem Sie den Mauszeiger auf diesen bewegen:

2020-11-03_11-13-44.png

Bearbeiten der mit einem vorhandenen Schlüssel verknüpften Berechtigungen

Wenn Sie die mit einem Schlüssel verknüpften Berechtigungen bearbeiten möchten, können Sie dies in der Rollenverwaltung tun, indem Sie auf den blauen Link „Rollenverwaltung“ klicken.

2020-11-03_11-14-37.png

Tipp: Wenn Sie mit Poplee HR-Grundlagen arbeiten und die Zugriffsberechtigung des Schlüssels auf nur einige Datenelemente der Personalakte beschränken möchten, können Sie eine spezielle Abteilung in Poplee HR-Grundlagen erstellen und nur dieser die Einsichtsrechte erteilen. Die Personen, die über das Token des API-Schlüssels verfügen, können somit auf diese Daten zugreifen.

Nach der Erstellung des Schlüssels können Sie unsere APIs verwenden. Mehr zu unseren unterschiedlichen APIs finden Sie in der API-Dokumentation.

Contenu de la page

War dieser Beitrag hilfreich?
1 von 1 fanden dies hilfreich