Was sind die Unterschiede zwischen Dienstnutzer- und Nutzer-API-Token?
Dienstbenutzer- und Benutzer-API-Tokens bieten flexible Möglichkeiten zur Anbindung externer Tools an SafetyCulture.
Dienstbenutzer-API-Token eignen sich am besten für langfristige oder gemeinsame Integrationen, bei denen der Zugriff unabhängig von Benutzeränderungen gleich bleiben soll. Sie können ihre Berechtigungen festlegen, was sie ideal für stabile Verbindungen auf Systemebene macht.
Benutzer-API-Token eignen sich für einmalige Aufgaben, persönliche Workflows oder Szenarien, in denen der Zugriff die Berechtigungen oder Gruppen- und Websitemitgliedschaften eines bestimmten Benutzers widerspiegeln muss.
Die Wahl des richtigen Token-Typs stellt sicher, dass Ihre Integration reibungslos verläuft und den Sicherheits- und Zugriffsanforderungen Ihres Unternehmens entspricht.
Funktionalität | API-Token für Service-Nutzer | API-Token für Nutzer |
|---|---|---|
Eigentümerschaft | Für einen Service-Nutzer erstellt (systembasiert oder integrationsorientiert) | Von einem einzelnen Nutzer erstellt |
Anmeldung | Kann nicht zum Anmelden verwendet werden | Kann zum Einloggen verwendet werden |
Berechtigungen | Jedem Service-Nutzer zugewiesen | Übernimmt die Berechtigungsgruppe des Benutzers. |
Gruppe und Standort- Zugangskontrolle | Nicht unterstützt | Überträgt den Zugriff vom Nutzer |
Integrationen | Konzipiert für langfristige oder gemeinsame Integrationen | Geeignet für den kurzfristigen oder persönlichen Gebrauch |
Token-Stabilität | Nicht von Nutzeränderungen betroffen | Läuft ab, wenn der Nutzer deaktiviert wird oder er die Organisation verlässt |
Aktivitätsprotokolle | Zeigt den Servicenutzernamen an | Zeigt den Namen des einzelnen Nutzers an |
Sichtbarkeit | Wird nicht in der Nutzerliste angezeigt | Sichtbar in den Nutzereinstellungen |
Abrechnung | Wird nicht auf die Lizenz angerechnet | Wird auf die zugewiesene Nutzerlizenz angerechnet |
Jeder Nutzer kann bis zu 10 aktive Nutzer-API-Token erstellen. Jede Organisation kann hingegen bis zu 20 aktive Service-Nutzer-Token haben.
Wenn Sie zu mehrere Organisationen gehören, müssen Sie separate API-Tokens für Ihre Integrationen erstellen. Dies gilt sowohl für Service-Nutzer- als auch für Nutzer-API-Tokens.
Auf welche Daten können API-Anfragen mit API-Token zugreifen?
API-Token berechtigen API-Anfragen dazu, im Namen eines bestimmten Subjekts in SafetyCulture zu handeln. Dieses Subjekt ist entweder:
Der Nutzer, der ein Nutzer-API-Token erstellt hat, oder
Der Servicenutzer, der ein Servicenutzer-API-Token besitzt.
Bei jeder Anfrage überprüft die SafetyCulture-API die Berechtigungen des Subjekts und den Zugriff.
Wenn Sie möchten, dass eine Integration genau das widerspiegelt, was Sie in SafetyCulture sehen, verwenden Sie Ihr eigenes Nutzer-API-Token. Wenn Sie eine andere Ansicht wünschen (z. B. einen breiteren, von einem Administrator verwalteten Zugriff), sollten Sie ein Servicenutzer-API-Token verwenden.
Berechtigungen
Berechtigungen steuern, welche Aktionen API-Anfragen ausführen können.
Nutzer-API-Token verwenden das Berechtigungsset des Nutzers, der das Token erstellt hat. Wenn dieser Nutzer eine Aufgabe in SafetyCulture nicht ausführen kann, können API-Anfragen, die sein Token verwenden, diese auch nicht ausführen.
Dienstbenutzer-API-Token verwenden den Berechtigungssatz, den Sie dem Dienstbenutzer zuweisen. Wenn der Dienstbenutzer keine Berechtigung zur Durchführung einer Aufgabe hat, können API-Aufrufe, die mit seinem Token erfolgen, dies nicht tun.
Zugriff
Der Zugriff steuert, welche Elemente API-Anfragen zurückgeben oder mit ihnen arbeiten können.
API-Anfragen, die einen API-Token verwenden, können nur Vorlagen, Inspektionen, Assets und andere Elemente zurückgeben, auf die das Subjekt (Nutzer oder Servicenutzer) in SafetyCulture zugreifen kann.
Bei Nutzer-API-Token erfolgt dieser Zugriff in der Regel über die Nutzergruppen, Standorte und alle Freigabe- oder Zugriffsregeln, die Sie für Inhalte festgelegt haben.
Für die API-Token des Servicenutzers ergibt sich dieser Zugriff aus dem Zugriff und der Freigabe, die Sie für den Servicenutzer und Ihre Inhalte konfigurieren (z. B. Vorlagen oder Inspektionen, die Sie explizit mit diesem Servicenutzer teilen oder in Regeln aufnehmen, die ihn abdecken).
Bei Inhalten, die eine andere Organisation mit der Ihren teilt, muss die Vorlage oder Inspektion so geteilt werden, dass das Thema (Nutzer oder Servicenutzer) mit einbezogen wird.
Was Sie brauchen
Wenn Sie ein Service-Nutzer-API-Token für die SCIM-Bereitstellung verwenden, muss der Service-Nutzer sowohl Berechtigung "Plattformverwaltung: Nutzer" als auch Berechtigung "Plattformverwaltung: Gruppen" besitzen.
Erstellen eines API-Tokens für Service-Nutzer
Klicken Sie unten links auf der Seite auf den Namen Ihrer Organisation und wählen Sie Integrationen aus.
Wählen Sie oben auf der Seite API-Token aus.
Klicken Sie in der oberen rechten Ecke der Seite auf API-Token generieren.
Vervollständigen Sie die folgenden Angaben:
Geben Sie einen Namen für das API-Token des Service-Nutzers ein, um seinen Zweck zu beschreiben.
Wählen Sie, wie lange der Token aktiviert bleibt, bevor er aufgrund von Inaktivität abläuft. Sie können 31, 45 (Standard), 60 oder 180 Tage wählen.
Wählen Sie die Berechtigungs-Sets für den Service-Nutzer aus. Standardmäßig sind alle Berechtigungen ausgewählt.
Klicken Sie unten rechts auf der Seite auf Token erstellen.
Klicken Sie im Pop-up-Fenster auf den API-Token des Service-Nutzers, um es zu kopieren. Speichern Sie den Token sicher, bevor Sie das Fenster schließen.
Ein API-Token für einen Service-Nutzer bearbeiten
Klicken Sie unten links auf der Seite auf den Namen Ihrer Organisation und wählen Sie Integrationen aus.
Wählen Sie oben auf der Seite API-Token aus.
Klicken Sie auf das aktive API-Token des Service-Nutzers, das Sie bearbeiten möchten.
Klicken Sie oben links auf der Seite auf , um den Tokennamen zu ändern.
Klicken Sie Bearbeiten auf der linken Seite der Seite, um zu ändern, wie lange das Token aktiviert bleibt, bevor es aufgrund von Inaktivität abläuft. Sie können zwischen 31, 45 (Standard), 60 oder 180 Tagen wählen.
Klicken Sie auf Bearbeiten auf der rechten Seite der Seite, um die Berechtigung-Sets des Service-Nutzers zu aktualisieren.
Klicken Sie auf Änderungen speichern.
Liste der API-Token für Service-Nutzer anzeigen
Klicken Sie unten links auf der Seite auf den Namen Ihrer Organisation und wählen Sie Integrationen aus.
Wählen Sie oben auf der Seite API-Token aus.
Unter Service-Benutzer-API-Token können Sie sich die Liste der Token anzeigen lassen.
Ein Service-Nutzer-API-Token deaktivieren
Klicken Sie unten links auf der Seite auf den Namen Ihrer Organisation und wählen Sie Integrationen aus.
Wählen Sie oben auf der Seite API-Token aus.
Klicken Sie unter Service-Nutzer-API-Token neben dem Token auf Widerrufen.
Klicken Sie in dem Popup-Fenster auf Widerrufen.
Ein deaktiviertes Service-Nutzer-Token neu generieren
Klicken Sie unten links auf der Seite auf den Namen Ihrer Organisation und wählen Sie Integrationen aus.
Wählen Sie oben auf der Seite API-Token aus.
Klicken Sie unter Service-Nutzer API-Token neben dem deaktivierten Token auf Erneut generieren.
Klicken Sie in dem Popup-Fenster auf Bestätigen.
Klicken Sie auf das Service-Nutzer-API-Token, um es zu kopieren. Speichern Sie das Token sicher, bevor Sie das Fenster schließen.
Löschen eines deaktivierten Service-Nutzer-Tokens
Klicken Sie unten links auf der Seite auf den Namen Ihrer Organisation und wählen Sie Integrationen aus.
Wählen Sie oben auf der Seite API-Token aus.
Klicken Sie neben dem deaktivierten Service-API-Token auf .
Wählen Sie Löschen aus.
Klicken Sie in dem Popup-Fenster auf Löschen.
