Authentifizierung

Die ActivityReport Public API authentifiziert Requests über einen API-Key. Der Key ist an deinen Benutzer und seine Rolle gebunden - alle Zugriffe erfolgen im Kontext dieses Benutzers und seines Tenants: Du siehst ausschließlich Daten deiner eigenen Organisation.

API-Key erzeugen

Einen API-Key erstellst du direkt in der ActivityReport-App: Öffne deine Benutzereinstellungen und lege dort einen neuen API-Key an. Der Key hat das Format ario_….

Bereich „Öffentlicher API-Zugriff“ in den Benutzereinstellungen mit den Buttons „Neuen Schlüssel erzeugen“ und „Schlüssel deaktivieren“

Wichtig: Der Key wird nur ein einziges Mal im Klartext angezeigt - direkt nach dem Erstellen. Kopiere ihn sofort und bewahre ihn sicher auf (z. B. in einem Secret-Manager). Geht der Key verloren, musst du einen neuen erzeugen.

Requests authentifizieren

Sende den Key bei jedem Request im HTTP-Header X-API-KEY mit:

X-API-KEY: ario_your_api_key

Fehlt der Header oder ist der Key ungültig, antwortet die API mit 401 Unauthorized und einem JSON-Body, z. B.:

{ "error": "Missing X-API-KEY header" }

Rolle & Berechtigungen

Der Key übernimmt die Rolle seines Inhabers (ADMIN, ENGINEER, …) - sie bestimmt, welche Operationen erlaubt sind. Nicht-Admin-Keys sehen und verwalten nur eigene Datensätze (WorkUnits, Abwesenheiten, Assignments); Stammdaten wie Kunden und Produkte sind Admin-Keys vorbehalten. Verstöße beantwortet die API mit 403. Die vollständige Übersicht steht unter Erste Schritte.

Key prüfen: GET /me

Mit GET /me prüfst du, an welchen Benutzer und welche Rolle dein Key gebunden ist - ersetze ario_your_api_key durch deinen eigenen Key:

curl https://app.activityreport.io/public/api/v1/me \
  -H "X-API-KEY: ario_your_api_key"
{
  "userId": 42,
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com",
  "role": "ENGINEER",
  "tenant": "acme"
}

Umgang mit dem Key

  • Behandle den Key wie ein Passwort - niemals in Client-Code, Repositories oder Logs ablegen.
  • Verwende pro Integration einen eigenen Key, damit du einzelne Zugriffe gezielt widerrufen kannst.
  • Kompromittierte Keys sofort in den Einstellungen löschen und ersetzen.

Weiter geht es mit den Guides WorkUnits, Abwesenheiten und Stammdaten.