Zum Inhalt

TimeAM Dokumentation

Willkommen zur technischen Dokumentation von TimeAM – einer SaaS-Anwendung für Zeiterfassung, Schichtplanung und Mitarbeiterverwaltung.

Über TimeAM

Was ist TimeAM?

TimeAM ist eine moderne SaaS-Anwendung (Software-as-a-Service) für die Verwaltung von Arbeitszeiten, Schichtplanung und Mitarbeiterorganisation. Die Anwendung wurde speziell für Unternehmen entwickelt, die flexible Zeiterfassung, Schichtplanung und Compliance-Anforderungen benötigen.

Für wen ist TimeAM gedacht?

TimeAM richtet sich an:

  • Sicherheitsfirmen: Schichtplanung mit Freelancer-Pool, Zeiterfassung für Sicherheitsdienste
  • Dienstleistungsunternehmen: Flexible Zeiterfassung, Projektverwaltung, Mitarbeiterorganisation
  • Unternehmen mit Schichtbetrieb: Planung und Verwaltung von Schichten, Compliance-Überwachung
  • Organisationen mit verteilten Teams: Zentrale Verwaltung von Arbeitszeiten und Projekten

Hauptfunktionen und Features

  • ⏰ Zeiterfassung: Clock In/Out, Live-Tracking, Pausen-Management, Abwesenheitsverwaltung
  • 📋 Schichtplanung: Schicht-Erstellung, Veröffentlichung im Pool, Bewerbungssystem
  • 📅 Kalender-Integration: Zentrale Kalenderansicht für alle Events und Termine
  • 👥 Mitarbeiterverwaltung: Rollen, Berechtigungen, Einladungssystem
  • 📊 Dashboard: Live-Kennzahlen, Widgets, Echtzeit-Updates
  • ⚖️ Compliance: Automatische Überwachung von Arbeitszeitregeln (EU/DE)
  • 🔔 Benachrichtigungen: Zentrale Benachrichtigungen für alle wichtigen Ereignisse
  • 📈 Berichte & Analytics: Umfangreiche Auswertungen und Export-Funktionen
  • 🔐 Sicherheit: Multi-Factor Authentication (MFA), API-Tokens

Anwendungsfälle

  1. Zeiterfassung für Mitarbeiter: Einfaches Clock In/Out, automatische Pausenerfassung, Stundenkonto-Verwaltung
  2. Schichtplanung mit Freelancern: Schichten ausschreiben, Bewerbungen verwalten, Freelancer zuweisen
  3. Compliance-Überwachung: Automatische Prüfung von Arbeitszeitregeln, Audit-Trails
  4. Projektbezogene Zeiterfassung: Zeiterfassung pro Projekt/Kunde, Genehmigungs-Workflows
  5. Abwesenheitsverwaltung: Urlaub, Krankheit, Sonderurlaub mit Kontingent-Verwaltung

Schnellstart – Erste Schritte

Zeiterfassung starten

  1. Anmelden: Melden Sie sich mit Ihren Zugangsdaten an
  2. Zeiterfassung öffnen: Navigieren Sie zur Seite "Zeiterfassung" im Hauptmenü
  3. Clock In: Klicken Sie auf "Einstempeln" um die Zeiterfassung zu starten
  4. Pause: Klicken Sie auf "Pause starten" für eine Pause (automatisch nach 6 Stunden)
  5. Clock Out: Klicken Sie auf "Ausstempeln" um die Zeiterfassung zu beenden

Schichtplanung nutzen

  1. Schicht erstellen: Als Admin/Planer können Sie neue Schichten erstellen
  2. Schicht veröffentlichen: Veröffentlichen Sie die Schicht im Pool
  3. Bewerbungen verwalten: Prüfen und verwalten Sie Bewerbungen von Freelancern
  4. Schicht zuweisen: Nehmen Sie Bewerbungen an oder weisen Sie Mitarbeiter direkt zu

Kalender nutzen

  1. Kalender öffnen: Navigieren Sie zur Seite "Kalender"
  2. Ansicht wählen: Wählen Sie zwischen Monat, Woche oder Tag-Ansicht
  3. Events anzeigen: Alle Zeiteinträge und Schichten werden automatisch angezeigt
  4. Filter anwenden: Filtern Sie nach Modulen (Zeiterfassung, Schichten)

Mitarbeiter verwalten

  1. Mitarbeiter öffnen: Navigieren Sie zur Seite "Mitarbeiter"
  2. Einladung senden: Laden Sie neue Mitarbeiter per E-Mail ein
  3. Rolle zuweisen: Weisen Sie Rollen zu (Admin, Planer, Mitarbeiter)
  4. Berechtigungen: Verwalten Sie Berechtigungen pro Rolle

Abwesenheit beantragen

  1. Zeiterfassung öffnen: Navigieren Sie zur Seite "Zeiterfassung"
  2. Abwesenheit: Klicken Sie auf "Abwesenheit beantragen"
  3. Typ wählen: Wählen Sie Urlaub, Krankheit oder Sonderurlaub
  4. Zeitraum: Geben Sie Start- und Enddatum ein
  5. Beantragen: Senden Sie den Antrag ab (wird von Admin/Manager genehmigt)

Dashboard nutzen

  1. Dashboard öffnen: Nach dem Login sehen Sie automatisch das Dashboard
  2. Widgets: Verschiedene Widgets zeigen Live-Kennzahlen
  3. Schnellzugriff: Schneller Zugriff auf wichtige Funktionen
  4. Echtzeit-Updates: Daten werden automatisch aktualisiert

Hauptfunktionen

Für Freelancer

API-Dokumentation

Diese Dokumentation beschreibt die API-Endpunkte von TimeAM für die Integration in externe Systeme oder die Nutzung über API-Tokens.

Authentifizierung

Alle API-Endpunkte erfordern Authentifizierung. Zwei Methoden werden unterstützt:

  1. Firebase ID Token (Standard für Web-App)
  2. API-Token (für externe Nutzung)

Header: Authorization: Bearer <token>

API-Token erstellen

  1. Öffnen Sie die Einstellungen in der Web-App
  2. Gehen Sie zum Tab Sicherheit
  3. Klicken Sie auf Neuer Token unter "API-Tokens"
  4. Geben Sie einen Namen ein (z.B. "Production API", "Script Integration")
  5. Klicken Sie auf Token erstellen
  6. WICHTIG: Kopieren Sie den Token sofort – er wird nicht erneut angezeigt!

Module

TimeAM besteht aus verschiedenen Feature-Modulen, die in Kategorien unterteilt sind:

Core-Module (Immer aktiv)

Diese Module sind immer verfügbar und können nicht deaktiviert werden:

Optionale Module (Pro Tenant aktivierbar)

Diese Module können pro Tenant aktiviert/deaktiviert werden:

Freelancer-Module

Spezielle Module für Freelancer-Accounts:

Firmen-Module (Nur für Firmen-Tenants)

Erweiterte Module für Firmen-Tenants:

Siehe Module-Dokumentation für detaillierte API-Dokumentation zu einzelnen Modulen.

Verfügbare API-Endpunkte nach Modul

Die folgenden Module haben vollständige API-Dokumentation:

Core-Module

Optionale Module

Spezial-Module