Bevor Sie beginnen
Sie können API-Schlüssel für Mitarbeitende oder Benutzer:innen erstellen. Hierbei handelt es sich um den Identifikationscode eines/einer Benutzers:in (oder Entwicklers:in), 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 sind.
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. Wenn Sie keine Zugriffsrechte haben, wenden Sie sich bitte an Ihre:n Administrator:in, um einen API-Schlüssel für Sie zu generieren. Wenn Sie Administrator:in ohne Zugriff auf Rollen sind, wenden Sie sich bitte an den Helpdesk.
Klicken Sie auf Neuen API-Schlüssel generieren, um einen Schlüssel zu erstellen.
Im Erstellungsfenster:
- Geben Sie den gewünschten Namen für den Schlüssel ein.
- Wählen Sie die Rechte aus, die Sie mit diesem Schlüssel verknüpfen möchten (hier muss unbedingt eine Berechtigung überprüft werden, Sie können dann aber alle Berechtigungen des Schlüssels in den unten angegebenen Rollen ändern).
- Geben Sie eine:n technische:n Ansprechpartner:in an, für den Fall, dass Fragen zur Verwendung des API-Schlüssels auftreten (die Angabe eines Kontakts ist obligatorisch).
- Wählen Sie die gewünschte Verwendung dieses Schlüssels aus (es ist zwingend erforderlich, eine der Optionen anzukreuzen, um entweder einen Editor eines Drittanbieters über diesen Schlüssel anzubinden oder diesen Schlüssel intern zu verwenden).
- Erweiterte Optionen: Sie können den Schlüssel individuell einstellen. Sie müssen jedoch das GUID-Format (Globally Unique Identifier) respektieren, einen eindeutigen Benutzernamen mit einer Größe von 16 Byte (Beispiel: [3F2504E0-4F89-11D3-9A0C-0305E82C3301]).
Sobald der Schlüssel erstellt wurde, können Sie diesen kopieren, indem Sie den Mauszeiger auf diesen bewegen:
Bearbeiten der mit einem vorhandenen Schlüssel verknüpften Berechtigungen
Abhängig von der gewünschten Nutzung Ihres Schlüssels müssen Sie ihm die entsprechenden Rechte einräumen.
Wenn Sie beispielsweise Mitarbeitendendaten aus einem bestimmten Abschnitt der Personalakte eines/einer Mitarbeitenden abrufen möchten, müssen Sie Ihrem Schlüssel das Recht geben, diesen Abschnitt einzusehen.
Wenn Sie die mit einem Schlüssel verbundenen Rechte ändern möchten, gelangen Sie zur Rollenverwaltung, indem Sie auf den blauen Link „Verwaltung der Rollen“ klicken:
Tipp: Wenn Sie mit Poplee Core HR 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 Core HR 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. Um mehr über unsere verschiedenen APIs zu erfahren, laden wir Sie ein, die API-Dokumentation zu konsultieren.