Kinmu Public API
Integreer de tijdregistratie van Kinmu met je salarissoftware, je toegangscontrole of je BI-tools. Een geversioneerde REST API met bedrijfscredentials, expliciete scopes en ondertekende webhooks.
curl https://api.kinmu.app/v1/organization \
-H "Authorization: Bearer $KINMU_API_KEY"Begin hier
Activeer de addon, maak een key aan en doe je eerste call in zo’n 5 minuten.
QuickstartScopes, rotatie, sandbox en best practices.
Authenticatie en API-keysPaginering, fouten, idempotentie en limieten.
ConventiesVerken de 9 resources en probeer elk endpoint uit.
Interactieve referentieIntegreer je use case
Effectieve uren, afwezigheden en verlofsaldi voor je salarisrun.
SalarisadministratieRegistreer check-ins vanaf poortjes, passen of kiosken met POST /v1/check-ins.
Incrementele synchronisatie via polling voor je dashboards.
BI / Power BIWat v1 biedt
De v1-surface bestaat uit 9 REST-resources onder https://api.kinmu.app/v1:
| Resource | Waarvoor |
|---|---|
| Organization | Introspectie van de credential en het bedrijf. |
| Employees | Aanmaken, bijwerken en uit dienst melden van medewerkers. |
| Check-ins | Klok-events (in/out/break) met herkomst. |
| Work summaries | Geaggregeerde werktijden voor de salarisadministratie. |
| Absences | Afwezigheden: aanmaken, goedkeuren en afwijzen. |
| Vacation balances | Verlofsaldi per medewerker en jaar. |
| Locations / Units | Organisatiestructuur (alleen-lezen). |
| Reports | Asynchrone rapporten (wettelijke urenregistratie, exports). |
| Webhooks | Ondertekende uitgaande events (Standard Webhooks). |
Het bedrijf wordt altijd afgeleid uit de credential. Er staat nooit een {companyId} in de publieke routes of in de body.
Principes
- Bevroren contract. Wat in v1 zit, verandert nooit op een incompatibele manier; elke deprecation wordt 12 maanden vooraf aangekondigd in de changelog.
- Least privilege. Elke key heeft expliciete scopes; zonder scope geen toegang (
403 invalid_scope). - Alles geauditeerd. Elke request met een bedrijfskey wordt gelogd met
origin=public_api. - Dezelfde regels als de app. Schrijfacties via de API doorlopen dezelfde domeinvalidaties als de applicatie.