REST-API: Wie binden Sie SL-UP an eigene Systeme an?

Warum eine API?

Unternehmen arbeiten selten mit nur einem Tool. Lohnsoftware, ERP-Systeme, Intranet-Portale – alle brauchen Zugriff auf Abwesenheitsdaten. Die SL-UP REST-API macht Ihre Urlaubsverwaltung zum zentralen Datenhub, der sich nahtlos in bestehende Infrastruktur einfügt.

Was kann die API?

Authentifizierung

Jeder API-Request erfordert einen gültigen API-Key im Header X-API-KEY:

API-Keys werden in den Einstellungen generiert und sind an Ihre Firma gebunden. Ein Key hat nur Zugriff auf die Daten der eigenen Firma.

Welche Endpoints gibt es?

Benutzer

• GET /api/?endpoint=users – Alle Benutzer auflisten
• GET /api/?endpoint=users&id={id} – Einzelnen Benutzer abrufen
• POST /api/?endpoint=users – Neuen Benutzer anlegen
• PUT /api/?endpoint=users&id={id} – Benutzer aktualisieren

Abwesenheiten

• GET /api/?endpoint=absences – Alle Abwesenheiten (mit Datumsfilter)
• GET /api/?endpoint=absences&id={id} – Einzelne Abwesenheit
• POST /api/?endpoint=absences – Abwesenheit erstellen
• PUT /api/?endpoint=absences&id={id} – Abwesenheit bearbeiten
• DELETE /api/?endpoint=absences&id={id} – Abwesenheit löschen

Abteilungen & Feiertage

• GET /api/?endpoint=departments – Alle Abteilungen
• GET /api/?endpoint=holidays – Feiertage und Schulferien

Berichte

• GET /api/?endpoint=reports&report=vacation_summary – Urlaubsübersicht
• GET /api/?endpoint=reports&report=time_tracking – Zeiterfassung

Beispiel: Abwesenheiten abrufen

Wie sieht die Fehlerbehandlung aus?

Die API verwendet Standard-HTTP-Statuscodes:

• 200: Erfolgreiche Anfrage
• 201: Ressource erfolgreich erstellt
• 400: Ungültige Anfrage (Validierungsfehler)
• 401: Nicht authentifiziert (fehlender oder ungültiger API-Key)
• 403: Keine Berechtigung für diese Ressource
• 404: Ressource nicht gefunden
• 429: Rate-Limit überschritten
• 500: Interner Serverfehler

Praxisbeispiel: Kalender-Integration

Das folgende Beispiel zeigt einen typischen Response des GET /api/absences Endpoints mit zwei Einträgen. Dieser Response-Typ eignet sich direkt für den Import in externe Kalender-Systeme:

{
  "success": true,
  "data": [
    {
      "id": 101,
      "user_id": 7,
      "user_name": "Meier, Sandra",
      "department": "Vertrieb",
      "type": "vacation",
      "date_from": "2026-06-02",
      "date_to": "2026-06-06",
      "status": "approved",
      "days": 5,
      "note": null
    },
    {
      "id": 102,
      "user_id": 12,
      "user_name": "Hofmann, Peter",
      "department": "IT",
      "type": "homeoffice",
      "date_from": "2026-06-03",
      "date_to": "2026-06-03",
      "status": "approved",
      "days": 1,
      "note": "Kundenprojekt remote"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 2
  }
}

Webhooks: Push statt Pull

Die SL-UP REST-API arbeitet nach dem Pull-Prinzip: Ihr System fragt regelmäßig neue Daten ab (Polling). Das ist einfach zu implementieren, erzeugt aber bei häufigen Abfragen unnötige Last. Deshalb gibt es zusätzlich Webhooks: SL-UP schickt aktiv eine HTTP-Anfrage an Ihr System, sobald ein Ereignis eintritt — zum Beispiel wenn ein Urlaub beantragt, genehmigt oder abgelehnt wird, eine Zeiterfassung abgeschlossen ist, eine Schicht zugewiesen oder ein Benutzer angelegt bzw. deaktiviert wird.

Jede Meldung ist mit einem geheimen Schlüssel signiert, sodass Ihr System prüfen kann, dass sie wirklich von SL-UP kommt. Im Admin-Bereich gibt es eine Testauslösung, ein Zustellprotokoll mit Antwortcode und automatische Wiederholungen bei Fehlern. Wer lieber abfragt, nutzt weiterhin den since-Parameter bei GET /api/absences und holt nur Einträge, die sich seit dem letzten Abruf verändert haben.

Use Cases in der Praxis

Verwandte Artikel

• 2-Faktor-Authentifizierung & Sicherheit
• Automatische Backups & Datensicherung
• Berichte & CSV-Export
• datenschutzfreundliche Personalverwaltung