Erstellen Sie den Schlüssel unter API-Schlüssel und wählen Sie die Scopes (employees, payroll, timeclock, reports u. a.). Er wird nur einmal angezeigt.
Den Schlüssel erstellen
Klicken Sie im Menü „API-Schlüssel“ auf „Neuer API-Schlüssel“, vergeben Sie einen Namen, der die Integration kennzeichnet (das ERP, die Zeiterfassung, das BI), und wählen Sie die Scopes. Verfügbar sind employees:read, employees:write, payroll:read, payroll:write, departments:read, departments:write, positions:read, positions:write, timeclock:read, timeclock:write und reports:read.
Der Schlüssel wird nur ein einziges Mal bei der Erstellung angezeigt. Kopieren Sie ihn in einen Tresor für Geheimnisse; geht er verloren, widerrufen Sie ihn und erstellen einen neuen.
Ein Schlüssel, ein Unternehmen
Jeder Schlüssel gehört zu einem Unternehmen und sieht nur dessen Daten. Um mehrere Unternehmen desselben Kontos anzubinden, erstellen Sie in jedem einen Schlüssel. GET /companies liefert das Unternehmen des Schlüssels und hilft dem Integrator zu bestätigen, wohin er schreibt.
Bewährte Praxis
Nutzen Sie einen Schlüssel pro Integration und nur die benötigten Scopes: Ein BI, das Berichte liest, erhält reports:read und sonst nichts. Widerrufen Sie den Schlüssel sofort, wenn er offengelegt wurde; der Widerruf wirkt unmittelbar. Jede Erstellung und jeder Widerruf steht im Audit-Log, und mit dem Schlüssel ausgeführte Aufrufe werden 90 Tage protokolliert.