Changelog

Wijzigingshistorie van de Kinmu Public API. Incompatibele wijzigingen worden nooit binnen een major versie doorgevoerd: ze komen in een nieuwe versie en worden hier aangekondigd.

Versiebeleid

De versie staat in de URL: https://api.kinmu.app/v1.
Bevroren contract binnen v1. We voeren geen incompatibele wijzigingen door in v1.

Wat we een compatibele wijziging noemen (breekt niet)

Deze wijzigingen kunnen zonder aankondiging in v1 plaatsvinden; je integratie moet ze kunnen verwerken:

Nieuwe endpoints of resources toevoegen.
Nieuwe velden toevoegen aan een response.
Nieuwe waarden toevoegen aan een enum die als uitbreidbaar is gedocumenteerd (bijv. custom afwezigheidstypen).
Optionele parameters toevoegen aan query of body.
De tekst van foutmeldingen wijzigen (title, detail) — baseer je logica daarom op het stabiele veld code.

Bouw tolerante clients. Negeer velden die je niet kent en ga niet uit van een vaste volgorde in lijsten. Dan raken compatibele wijzigingen je niet.

Wat we een incompatibele wijziging noemen (breekt)

Vereist een nieuwe major versie (v2):

Een endpoint, veld of enum-waarde verwijderen of hernoemen.
Het type van een veld wijzigen of het verplicht maken.
De betekenis van een veld of de code van een fout wijzigen.

Deprecatiebeleid (12 maanden)

Wanneer we een endpoint, veld of versie depreceren:

We kondigen het aan in deze changelog en op de developer-mailinglijst.
We markeren het als deprecated in de OpenAPI-spec en, waar van toepassing, met de response-headers Deprecation + Sunset.
Het blijft minimaal 12 maanden na de aankondiging werken voordat het verdwijnt.

Abonneer je op de aankondigingen via de supportpagina.

Historie

`v1` · 1.0.0

OpenAPI-spec gepubliceerd (openapi-v1.json, v1.0.0). De interactieve referentie leest de echte spec. De v1-surface is een bevroren contract; wijzigingen worden hier aangekondigd volgens het deprecatiebeleid van 12 maanden.

Resources bij de launch (MVP):

Organization — GET /v1/organization (introspectie).
Employees — medewerkers weergeven, ophalen, aanmaken, bijwerken en uit dienst melden.
Check-ins — check-ins weergeven, ophalen en registreren.
Work summaries — geaggregeerde werktijden voor de salarisadministratie.
Absences — weergeven, ophalen, aanmaken, goedkeuren en afwijzen.
Vacation balances — verlofsaldi.
Locations / Units — organisatiestructuur (alleen-lezen).
Reports — asynchrone rapporten (wettelijke urenregistratie en exports), met download van het bestand via GET /v1/reports/{id}/download.

Webhooks:

Ondertekende uitgaande events (Standard Webhooks): endpointbeheer, ping versturen, deliveries weergeven en het handmatig opnieuw in de wachtrij zetten van een delivery via POST /v1/webhook-endpoints/{id}/deliveries/{deliveryId}/retry.