Kinmu Public API
Integre o controle de ponto do Kinmu com seu software de folha de pagamento, seu controle de acesso ou suas ferramentas de BI. Uma API REST versionada, com credenciais de empresa, scopes explícitos e webhooks assinados.
curl https://api.kinmu.app/v1/organization \
-H "Authorization: Bearer $KINMU_API_KEY"Comece aqui
Ative o addon, crie uma chave e faça sua primeira chamada em cerca de 5 minutos.
QuickstartScopes, rotação, sandbox e boas práticas.
Autenticação e chaves de APIPaginação, erros, idempotência e limites.
ConvençõesExplore os 9 recursos e teste cada endpoint.
Referência interativaIntegre seu caso de uso
Horas efetivas, ausências e saldos de férias para o seu ciclo de folha.
Folha de pagamento e assessoria trabalhistaRegistre pontos a partir de catracas, cartões ou quiosques com POST /v1/check-ins.
Sincronização incremental por polling para seus dashboards.
BI / Power BIO que a v1 expõe
A superfície da v1 são 9 recursos REST sob https://api.kinmu.app/v1:
| Recurso | Para quê |
|---|---|
| Organization | Introspecção da credencial e da empresa. |
| Employees | Admissão, desligamento e atualização de funcionários. |
| Check-ins | Eventos de ponto (in/out/break) com origem. |
| Work summaries | Agregados de jornada para a folha de pagamento. |
| Absences | Ausências: criação, aprovação e recusa. |
| Vacation balances | Saldos de férias por funcionário e ano. |
| Locations / Units | Estrutura organizacional (somente leitura). |
| Reports | Relatórios assíncronos (registro legal de jornada, exports). |
| Webhooks | Eventos de saída assinados (Standard Webhooks). |
A empresa é resolvida sempre a partir da credencial. Nunca há {companyId} nas rotas públicas nem no body.
Princípios
- Contrato congelado. O que entra na v1 não muda de forma incompatível; toda descontinuação é anunciada com 12 meses de antecedência no changelog.
- Privilégio mínimo. Toda chave carrega scopes explícitos; sem o scope não há acesso (
403 invalid_scope). - Tudo auditado. Cada request com chave de empresa fica registrado com
origin=public_api. - As mesmas regras do app. As escritas via API passam pelas mesmas validações de domínio que a aplicação.