Tu primera llamada en 5 minutos

Activa el addon Public API

En my.kinmu.app → Extensiones, activa el addon Public API. Al activarlo se aprovisiona automáticamente una empresa sandbox (5 empleados demo con fichajes y ausencias de ejemplo) para tus keys de test.

Solo un global_admin o company_manager puede activarlo.

Crea una API key

Ve a Desarrolladores → API keys → Crear key. Elige:

• Un nombre descriptivo (p. ej. quickstart).
• Los scopes que necesites. Para este quickstart basta con que la key pueda leer la organización (el scope de organización es implícito).
• Marca que sea una key de test para trabajar contra la sandbox.

La key se muestra una sola vez. Cópiala y guárdala en un lugar seguro:

kinmu_sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Exporta la key en tu terminal

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

Haz tu primera llamada: GET /v1/organization

Este endpoint devuelve la empresa resuelta desde tu credencial, los datos de la key y tus límites vigentes. Es la forma canónica de comprobar que todo 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())

Lee la respuesta

{
  "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 la llamada se ejecutó contra la empresa de pruebas. Primera llamada hecha.