Skip to Content
Changelog och versionshantering

Changelog

Ändringshistorik för Kinmu Public API. Inkompatibla ändringar införs aldrig inom en major-version: de kommer i en ny version och annonseras här.

Versionspolicy

  • Versionen ligger i URL:en: https://api.kinmu.app/v1.
  • Fryst kontrakt inom v1. Vi inför inga inkompatibla ändringar i v1.

Vad vi räknar som en kompatibel ändring (icke-brytande)

Dessa ändringar kan ske i v1 utan förvarning; din integration måste tolerera dem:

  • Nya endpoints eller resurser läggs till.
  • Nya fält läggs till i ett svar.
  • Nya värden läggs till i ett enum som dokumenterats som utbyggbart (t.ex. anpassade frånvarotyper).
  • Valfria parametrar läggs till i query eller body.
  • Texten i felmeddelanden (title, detail) ändras — därför ska din logik bygga på det stabila fältet code.

Bygg toleranta klienter. Ignorera fält du inte känner igen och anta ingen fast ordning i listor. Då påverkas du inte av kompatibla ändringar.

Vad vi räknar som en inkompatibel ändring (brytande)

Kräver en ny major-version (v2):

  • Ta bort eller byta namn på en endpoint, ett fält eller ett enum-värde.
  • Ändra typen på ett fält eller göra det obligatoriskt.
  • Ändra betydelsen av ett fält eller koden för ett fel.

Depreceringspolicy (12 månader)

När vi deprecerar en endpoint, ett fält eller en version:

  1. Det annonseras i den här changeloggen och på utvecklarnas e-postlista.
  2. Det markeras som deprecated i OpenAPI-specen och, där det är tillämpligt, med svarsheadrarna Deprecation + Sunset.
  3. Det hålls i drift i minst 12 månader från annonseringen innan det tas bort.

Prenumerera på aviseringarna via supportsidan.

Historik

v1 · 1.0.0

OpenAPI-spec publicerad (openapi-v1.json, v1.0.0). Den interaktiva referensen läser den riktiga specen. Ytan i v1 är ett fryst kontrakt; ändringar annonseras här enligt depreceringspolicyn på 12 månader.

Resurser vid lanseringen (MVP):

  • Organization — GET /v1/organization (introspektion).
  • Employees — lista, hämta, skapa, uppdatera och avsluta.
  • Check-ins — lista, hämta och registrera stämplingar.
  • Work summaries — aggregerad arbetstid per period för lön.
  • Absences — lista, hämta, skapa, godkänna och avslå.
  • Vacation balances — semestersaldon.
  • Locations / Units — organisationsstruktur (endast läsning).
  • Reports — asynkrona rapporter (lagstadgad tidregistrering och exporter), med filnedladdning via GET /v1/reports/{id}/download.

Webhooks:

  • Signerade utgående events (Standard Webhooks): hantering av endpoints, ping-utskick, lista över leveranser och manuell omkörning av en leverans via POST /v1/webhook-endpoints/{id}/deliveries/{deliveryId}/retry.
Last updated on
API-referensSupport