Verfügt Day Off über APIs?
Mit der Day Off-API können Sie Ihre Systeme nahtlos mit Day Off verbinden und wichtige Prozesse automatisieren. Damit können Sie programmgesteuert auf Daten wie Mitarbeiterdaten, Urlaubsanträge und Urlaubsguthaben zugreifen und diese verwalten. So lassen sich manuelle Arbeitsschritte reduzieren und alle Daten in Ihren Tools stets synchron halten.
Einrichtungsschritte
1. Gehen Sie im Day Off zum Abschnitt „API“
Rufen Sie zunächst die API-Einstellungen in Ihrem Day Off-Konto auf.
- Gehen Sie im Hauptmenü zu „Integrationen“
- Klicken Sie auf „API“
Sie gelangen auf die Seite „API-Schlüsselverwaltung“.
Zunächst sieht diese Seite möglicherweise leer aus (wie auf Ihrem Screenshot zu sehen), insbesondere wenn Sie noch keine API-Schlüssel erstellt haben. Das ist völlig normal.
Betrachten Sie diese Seite als Ihre Schaltzentrale für alle Angelegenheiten rund um den API-Zugriff.
2. Einen neuen API-Schlüssel erstellen
Bevor Sie eine Verbindung zur API herstellen können, müssen Sie einen API-Schlüssel generieren. Dieser Schlüssel fungiert als sicheres Passwort, das es Ihrem System ermöglicht, mit Day Off zu kommunizieren.
- Klicken Sie auf „API-Schlüssel hinzufügen“
- Es erscheint ein Popup-Fenster
- Geben Sie einen Namen für Ihren Schlüssel ein: „HR-Systemintegration“ oder „Zapier-Automatisierung“
- Wählen Sie ein Ablaufdatum: Dies sorgt für zusätzliche Sicherheit
- Klicken Sie auf „Hinzufügen“
Sobald Sie dies getan haben, wird Ihr API-Schlüssel generiert.
3. Die API-Dokumentation öffnen und verstehen
Nachdem Sie nun Ihren API-Schlüssel haben, geht es im nächsten Schritt darum, zu verstehen, wie man ihn verwendet.
- Klicken Sie auf „Dokumentation“
- Dadurch wird die Day Off API-Dokumentation geöffnet
Darin finden Sie:
- Eine Liste der verfügbaren Endpunkte (Funktionen, die Sie mit der API ausführen können)
- Beispielanfragen und -antworten
- Technische Details für Entwickler
Sie können zum Beispiel:
- Eine Liste der Mitarbeiter abrufen
- Urlaubsanträge abrufen
- Urlaubsguthaben prüfen
- Auf Teams, Rollen und Standorte zugreifen
Es gibt auch eine Option zum Herunterladen der OpenAPI-Spezifikation, was nützlich ist, wenn Sie mit Entwicklern oder Tools wie Postman arbeiten.
Betrachten Sie die Dokumentation als Ihre Gebrauchsanweisung für die API.
4. Verbinden Sie sich mit Ihrem API-Schlüssel
Um Ihr System mit Day Off zu verbinden, müssen Sie Ihren API-Schlüssel beim Senden von Anfragen angeben.
- Fügen Sie Ihren API-Schlüssel wie folgt hinzu:
x-api-key: IHR_API_SCHLÜSSEL
Dieser Schritt teilt Day Off mit, dass die Anfrage von Ihnen stammt.
Wenn der Schlüssel fehlt oder falsch ist:
- Die Anfrage funktioniert nicht.
- Sie erhalten eine Fehlermeldung.
5. Die Integration nutzen
Sobald alles eingerichtet ist, können Sie die API nutzen.
Sie können nun:
- Mitarbeiterdaten abrufen
- Urlaubsanträge verfolgen oder verwalten
- Daten mit Ihren anderen Tools synchronisieren
So sparen Sie Zeit und vermeiden es, dieselben Aufgaben manuell zu erledigen.
Bewährte Verfahren (dringend empfohlen)
So sorgen Sie für eine sichere und zuverlässige Integration:
- Behalten Sie Ihren API-Schlüssel stets geheim
- Wechseln Sie Ihre API-Schlüssel regelmäßig aus (erstellen Sie neue und löschen Sie alte)
- Legen Sie aus Sicherheitsgründen immer ein Ablaufdatum fest
- Geben Sie API-Schlüssel niemals in Frontend-Anwendungen oder öffentlichen Repositorys preis
- Beziehen Sie sich beim Erstellen von Anfragen stets auf die Dokumentation
Die Day Off-API bietet Ihnen volle Kontrolle und Flexibilität bei der Anbindung Ihrer Systeme an Day Off. Die Einrichtung ist zwar einfach, eröffnet Ihnen jedoch vielfältige Möglichkeiten zur Automatisierung und individuellen Anpassung.
Sobald alles eingerichtet ist, kann Ihr Team den manuellen Aufwand reduzieren, Fehler vermeiden und alle Systeme perfekt aufeinander abstimmen.