Changelog

Histórico de mudanças da Kinmu Public API. Mudanças incompatíveis nunca são aplicadas dentro de uma versão maior: elas entram em uma nova versão e são anunciadas aqui.

Política de versionamento

A versão vai na URL: https://api.kinmu.app/v1.
Contrato congelado dentro da v1. Não introduzimos mudanças incompatíveis na v1.

O que consideramos uma mudança compatível (não quebra)

Estas mudanças podem acontecer na v1 sem aviso prévio; sua integração deve tolerá-las:

Adicionar novos endpoints ou recursos.
Adicionar novos campos a uma resposta.
Adicionar novos valores a um enum documentado como extensível (por exemplo, tipos de ausência custom).
Adicionar parâmetros opcionais de query ou de body.
Mudar o texto de mensagens de erro (title, detail) — por isso sua lógica deve se basear no campo estável code.

Escreva clientes tolerantes. Ignore campos que você não conhece e não assuma uma ordem fixa nas listas. Assim as mudanças compatíveis não afetam você.

O que consideramos uma mudança incompatível (quebra)

Exige uma nova versão maior (v2):

Remover ou renomear um endpoint, campo ou valor de enum.
Mudar o tipo de um campo ou torná-lo obrigatório.
Mudar o significado de um campo ou o código de um erro.

Política de descontinuação (12 meses)

Quando descontinuarmos um endpoint, campo ou versão:

O anúncio é feito neste changelog e na lista de e-mail de desenvolvedores.
O item é marcado como deprecated no spec OpenAPI e, quando aplicável, com os headers de resposta Deprecation + Sunset.
Ele segue operacional por pelo menos 12 meses a partir do anúncio antes de ser retirado.

Inscreva-se nos avisos na página de suporte.

Histórico

`v1` · 1.0.0

Spec OpenAPI publicado (openapi-v1.json, v1.0.0). A referência interativa lê o spec real. A superfície da v1 é contrato congelado; as mudanças são anunciadas aqui com a política de descontinuação de 12 meses.

Recursos do lançamento (MVP):

Organization — GET /v1/organization (introspecção).
Employees — listar, obter, criar, atualizar e desligar.
Check-ins — listar, obter e registrar pontos.
Work summaries — agregados de jornada para a folha de pagamento.
Absences — listar, obter, criar, aprovar e recusar.
Vacation balances — saldos de férias.
Locations / Units — estrutura organizacional (somente leitura).
Reports — relatórios assíncronos (registro legal de jornada e exports), com download do arquivo via GET /v1/reports/{id}/download.

Webhooks:

Eventos de saída assinados (Standard Webhooks): gestão de endpoints, envio de ping, listagem de entregas e reenfileiramento manual de uma entrega via POST /v1/webhook-endpoints/{id}/deliveries/{deliveryId}/retry.