Votre premier appel en 5 minutes

Activez l’addon Public API

Dans my.kinmu.app → Extensions, activez l’addon Public API. L’activation provisionne automatiquement une entreprise sandbox (5 salariés de démo avec des pointages et des absences d’exemple) pour vos clés de test.

Seul un global_admin ou un company_manager peut l’activer.

Créez une clé d’API

Allez dans Développeurs → API keys → Créer une clé. Choisissez :

• Un nom descriptif (p. ex. quickstart).
• Les scopes nécessaires. Pour ce démarrage rapide, il suffit que la clé puisse lire l’organisation (le scope d’organisation est implicite).
• Cochez clé de test pour travailler sur la sandbox.

La clé n’est affichée qu’une seule fois. Copiez-la et conservez-la en lieu sûr :

kinmu_sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Exportez la clé dans votre terminal

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

Faites votre premier appel : GET /v1/organization

Cet endpoint renvoie l’entreprise résolue à partir de votre clé, les informations de la clé et vos limites en vigueur. C’est la façon canonique de vérifier que tout fonctionne.

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

Lisez la réponse

{
  "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 confirme que l’appel a été exécuté contre l’entreprise de test. Premier appel réussi.