Entwicklerportal

Die Public API von Shiftavo ist eine REST-Schnittstelle für Maschine-zu-Maschine. Ein Programm meldet sich als Unternehmen an — nicht als Person —, sodass ein nächtlicher Lohnabgleich läuft, ohne dass jemand angemeldet bleiben muss.

Die API-Referenz öffnen →

Tipp

Jede Ressource, jedes Feld, jede Methode, jeder Scope und jeder Fehler wird aus der API selbst erzeugt. Hinter der Referenz steht ein OpenAPI-3.0-Dokument unter https://app.shiftavo.com/api/public/schema/, das du jedem Client-Generator übergeben kannst. Jeder Shard liefert das Schema für die Version, die er fährt, ausserdem unter {api_base}/api/public/schema/.

Was du bauen kannst

• Lies Dienstpläne, Mitarbeitende, Zeiterfassungen, Abwesenheitsanträge und -salden, Verfügbarkeiten, Arbeitsrichtlinien und Personalkosten.

• Schreiben von Schichten und Zuteilungen, Verfügbarkeiten, Korrekturen in der Zeiterfassung, Entscheidungen zu Abwesenheiten und der Konfiguration des Unternehmens wie Standorte, Positionen und Anstellungsarten.

• Abonnier Webhooks, damit Änderungen dich erreichen, sobald sie passieren, statt dass du abfragen musst.

Volles CRUD, kein reiner Lese-Export: POST zum Anlegen, PATCH zum Ändern, DELETE zum Entfernen und POST auf einen Aktions-Unterpfad für Übergänge im Lebenszyklus.

Was sie bewusst nicht kann

• Dich als Person anmelden. Es werden nur Zugangsdaten von Integrationen akzeptiert; der eigene Login einer mitarbeitenden Person funktioniert nicht.

• Ein anderes Unternehmen erreichen. Ein Satz Zugangsdaten ist serverseitig an genau ein Unternehmen gebunden.

• Unveröffentlichte Dienstpläne lesen. Schichten im Entwurf bleiben unsichtbar, bis auch das Team sie sehen kann.

• Angebote der Schichtbörse übernehmen oder vergeben. Offene Schichten und Tausche sind hier nur lesbar — diese Entscheidungen bleiben bei den Menschen.

• Mehr Befugnisse vergeben, als ein Admin hat. Eine Integration kann einer Person jede Rolle bis Admin geben, nie Inhaber oder Terminal; eine Anfrage für eine höhere Rolle ergibt ein 400. Ebenso wenig kann sie den Inhaber des Unternehmens entfernen oder deaktivieren.

Erste Schritte

• Schnellstart
• Authentifizierung
• Scopes
• Konventionen
• Den Menschen hinter einem Schreibvorgang benennen
• Webhooks

Wie eine Integration aussieht

1. Frag uns nach Zugangsdaten (siehe Schnellstart). Du bekommst eine Client-ID, ein Client-Secret und einen Satz Scopes.

2. Tausch sie beim Identitätsanbieter gegen ein kurzlebiges Zugriffstoken.

3. Lies den Claim api_base aus diesem Token — er nennt den aufzurufenden Host. Verdrahte nie einen Daten-Host fest.

4. Ruf {api_base}/api/public/v1/… mit Authorization: Bearer <token> auf.

Support

Etwas unklar, oder fehlt dir ein Endpunkt? Schreib dem Support und nenn die X-Request-Id aus der Antwort, um die es geht — jede Antwort trägt eine.