Changelog

Änderungshistorie der Kinmu Public API. Inkompatible Änderungen passieren nie innerhalb einer Major-Version: Sie kommen in eine neue Version und werden hier angekündigt.

Versionierungspolitik

Die Version steht in der URL: https://api.kinmu.app/v1.
Eingefrorener Vertrag innerhalb von v1. Wir führen keine inkompatiblen Änderungen in v1 ein.

Was wir als kompatible Änderung betrachten (bricht nichts)

Diese Änderungen können in v1 ohne Vorankündigung passieren; deine Integration muss sie tolerieren:

Neue Endpoints oder Ressourcen hinzufügen.
Neue Felder in einer Antwort hinzufügen.
Neue Werte in einem als erweiterbar dokumentierten Enum hinzufügen (z. B. eigene Abwesenheitstypen).
Optionale Parameter in Query oder Body hinzufügen.
Den Text von Fehlermeldungen ändern (title, detail) — deshalb muss deine Logik auf dem stabilen Feld code basieren.

Baue tolerante Clients. Ignoriere unbekannte Felder und verlasse dich nicht auf eine feste Reihenfolge in Listen. So betreffen dich kompatible Änderungen nicht.

Was wir als inkompatible Änderung betrachten (bricht)

Erfordert eine neue Major-Version (v2):

Einen Endpoint, ein Feld oder einen Enum-Wert entfernen oder umbenennen.
Den Typ eines Felds ändern oder es verpflichtend machen.
Die Bedeutung eines Felds oder den Code eines Fehlers ändern.

Deprecation-Policy (12 Monate)

Wenn wir einen Endpoint, ein Feld oder eine Version deprecaten:

Wird es in diesem Changelog und auf der Entwickler-Mailingliste angekündigt.
Wird es im OpenAPI-Spec als deprecated markiert und, wo zutreffend, mit den Response-Headern Deprecation + Sunset versehen.
Bleibt es ab der Ankündigung mindestens 12 Monate in Betrieb, bevor es entfernt wird.

Abonniere die Ankündigungen auf der Support-Seite.

Historie

`v1` · 1.0.0

OpenAPI-Spec veröffentlicht (openapi-v1.json, v1.0.0). Die interaktive Referenz liest den echten Spec. Die Oberfläche von v1 ist ein eingefrorener Vertrag; Änderungen werden hier mit der 12-monatigen Deprecation-Policy angekündigt.

Ressourcen des Launch (MVP):

Organization — GET /v1/organization (Introspektion).
Employees — auflisten, abrufen, anlegen, aktualisieren und austragen.
Check-ins — Stempelungen auflisten, abrufen und erfassen.
Work summaries — aggregierte Arbeitszeiten für die Lohnabrechnung.
Absences — auflisten, abrufen, erstellen, genehmigen und ablehnen.
Vacation balances — Urlaubssalden.
Locations / Units — Organisationsstruktur (nur lesend).
Reports — asynchrone Reports (gesetzlicher Arbeitszeitnachweis und Exporte), mit Datei-Download über GET /v1/reports/{id}/download.

Webhooks:

Signierte ausgehende Events (Standard Webhooks): Verwaltung von Endpoints, ping-Versand, Auflisten der Zustellungen und manuelles Neueinstellen einer Zustellung über POST /v1/webhook-endpoints/{id}/deliveries/{deliveryId}/retry.