Sua primeira chamada em 5 minutos

Ative o addon Public API

Em my.kinmu.app → Extensões, ative o addon Public API. Ao ativá-lo, uma empresa sandbox é provisionada automaticamente (5 funcionários demo com pontos e ausências de exemplo) para suas chaves de teste.

Apenas um global_admin ou company_manager pode ativá-lo.

Crie uma chave de API

Acesse Desenvolvedores → API keys → Criar chave. Escolha:

• Um nome descritivo (por exemplo, quickstart).
• Os scopes de que você precisa. Para este quickstart, basta que a chave possa ler a organização (o scope de organização é implícito).
• Marque a opção de chave de teste para trabalhar contra a sandbox.

A chave é exibida uma única vez. Copie e guarde em um lugar seguro:

kinmu_sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Exporte a chave no seu terminal

export KINMU_API_KEY="kinmu_sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
export KINMU_BASE_URL="https://api.dev.kinmu.app/v1"

Faça sua primeira chamada: GET /v1/organization

Este endpoint retorna a empresa resolvida a partir da sua credencial, os dados da chave e seus limites vigentes. É a forma canônica de confirmar que tudo funciona.

curl -s "$KINMU_BASE_URL/organization" \
  -H "Authorization: Bearer $KINMU_API_KEY" \
  -H "Accept: application/json"

import os
import requests
 
base_url = os.environ["KINMU_BASE_URL"]
api_key = os.environ["KINMU_API_KEY"]
 
resp = requests.get(
    f"{base_url}/organization",
    headers={
        "Authorization": f"Bearer {api_key}",
        "Accept": "application/json",
    },
    timeout=15,
)
resp.raise_for_status()
print(resp.json())

const baseUrl = process.env.KINMU_BASE_URL
const apiKey = process.env.KINMU_API_KEY
 
const resp = await fetch(`${baseUrl}/organization`, {
  headers: {
    Authorization: `Bearer ${apiKey}`,
    Accept: 'application/json'
  }
})
 
if (!resp.ok) {
  throw new Error(`HTTP ${resp.status}`)
}
console.log(await resp.json())

Leia a resposta

{
  "id": "a1b2c3d4-0000-0000-0000-000000000000",
  "name": "Empresa Sandbox",
  "country": "ES",
  "active_employees": 5,
  "key": {
    "name": "quickstart",
    "scopes": ["org:empleados:read"],
    "expires_at": null
  },
  "limits": {
    "rate_per_minute": 30,
    "monthly_quota": 5000,
    "monthly_used": 1
  },
  "sandbox": true
}

"sandbox": true confirma que a chamada foi executada contra a empresa de testes. Primeira chamada feita.