Dein erster Request in 5 Minuten

Aktiviere das Addon Public API

Aktiviere unter my.kinmu.app → Erweiterungen das Addon Public API. Beim Aktivieren wird automatisch ein Sandbox-Unternehmen provisioniert (5 Demo-Mitarbeitende mit Beispiel-Stempelungen und -Abwesenheiten) für deine Test-Keys.

Nur ein global_admin oder company_manager kann es aktivieren.

Erstelle einen API-Key

Gehe zu Entwickler → API-Keys → Key erstellen. Wähle:

• Einen aussagekräftigen Namen (z. B. quickstart).
• Die Scopes, die du brauchst. Für diesen Quickstart genügt es, dass der Key die Organisation lesen kann (der Organisations-Scope ist implizit).
• Markiere ihn als Test-Key, um gegen die Sandbox zu arbeiten.

Der Key wird nur ein einziges Mal angezeigt. Kopiere ihn und bewahre ihn sicher auf:

kinmu_sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Exportiere den Key in deinem Terminal

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

Mach deinen ersten Request: GET /v1/organization

Dieser Endpoint liefert das aus deinem Credential aufgelöste Unternehmen, die Daten des Keys und deine aktuellen Limits. Er ist der kanonische Weg, um zu prüfen, dass alles funktioniert.

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

Lies die Antwort

{
  "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 bestätigt, dass der Request gegen das Testunternehmen lief. Erster Request geschafft.