Ditt första anrop på 5 minuter

Aktivera addonet Public API

Gå till my.kinmu.app → Tillägg och aktivera addonet Public API. Vid aktiveringen provisioneras automatiskt ett sandbox-företag (5 demomedarbetare med exempel på stämplingar och frånvaro) för dina testnycklar.

Endast en global_admin eller company_manager kan aktivera det.

Skapa en API-nyckel

Gå till Utvecklare → API-nycklar → Skapa nyckel. Välj:

• Ett beskrivande namn (t.ex. quickstart).
• De scopes du behöver. För den här quickstarten räcker det att nyckeln kan läsa organisationen (organisations-scopet är implicit).
• Markera att det är en testnyckel för att arbeta mot sandboxen.

Nyckeln visas en enda gång. Kopiera den och spara den på ett säkert ställe:

kinmu_sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Exportera nyckeln i din terminal

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

Gör ditt första anrop: GET /v1/organization

Endpointen returnerar företaget som härleds från din nyckel, nyckelns uppgifter och dina aktuella limits. Det är det kanoniska sättet att kontrollera att allt fungerar.

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

Läs svaret

{
  "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 bekräftar att anropet gick mot testföretaget. Första anropet klart.