Je eerste call in 5 minuten

Activeer de addon Public API

Activeer in my.kinmu.app → Extensies de addon Public API. Bij activatie wordt automatisch een sandboxbedrijf aangemaakt (5 demomedewerkers met voorbeeldklokkingen en -afwezigheden) voor je test-keys.

Alleen een global_admin of company_manager kan de addon activeren.

Maak een API-key aan

Ga naar Developers → API keys → Key aanmaken. Kies:

• Een beschrijvende naam (bijv. quickstart).
• De scopes die je nodig hebt. Voor deze quickstart is het genoeg dat de key de organisatie kan lezen (de organisatiescope is impliciet).
• Vink aan dat het een test-key is, zodat je tegen de sandbox werkt.

De key wordt maar één keer getoond. Kopieer hem en bewaar hem op een veilige plek:

kinmu_sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Exporteer de key in je terminal

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

Doe je eerste call: GET /v1/organization

Dit endpoint retourneert het bedrijf dat uit je credential is afgeleid, de gegevens van de key en je actuele limieten. Het is de canonieke manier om te controleren dat alles werkt.

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())

Lees de response

{
  "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 bevestigt dat de call tegen het testbedrijf is uitgevoerd. Eerste call gedaan.