Skip to Content
Quickstart

La tua prima chiamata in 5 minuti

Alla fine di questa guida avrai fatto una chiamata autenticata reale sull’ambiente di sviluppo con una chiave di test, senza toccare dati di produzione.

Base URL di sviluppo: https://api.dev.kinmu.app/v1 · Produzione: https://api.kinmu.app/v1. Le chiavi di test (kinmu_sk_test_…) operano su un’azienda sandbox con dati sintetici.

Attiva l’addon Public API

In my.kinmu.appEstensioni, attiva l’addon Public API. All’attivazione viene creata automaticamente un’azienda sandbox (5 dipendenti demo con timbrature e assenze di esempio) per le tue chiavi di test.

Solo un global_admin o company_manager può attivarlo.

Crea una chiave API

Vai su Sviluppatori → API keys → Crea chiave. Scegli:

  • Un nome descrittivo (es. quickstart).
  • Gli scopes che ti servono. Per questo quickstart basta che la chiave possa leggere l’organizzazione (lo scope di organizzazione è implicito).
  • Seleziona chiave di test per lavorare sulla sandbox.

La chiave viene mostrata una sola volta. Copiala e conservala in un posto sicuro:

kinmu_sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Non potrai rivedere la chiave completa. Se la perdi, revocala e creane un’altra.

Esporta la chiave nel terminale

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

Fai la tua prima chiamata: GET /v1/organization

Questo endpoint restituisce l’azienda risolta dalla tua credenziale, i dati della chiave e i limiti in vigore. È il modo canonico per verificare che tutto funzioni.

curl -s "$KINMU_BASE_URL/organization" \ -H "Authorization: Bearer $KINMU_API_KEY" \ -H "Accept: application/json"

Leggi la risposta

{ "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 conferma che la chiamata è stata eseguita sull’azienda di prova. Prima chiamata fatta.

E adesso?

Un 401? Controlla l’header Authorization: Bearer … e che la chiave non sia revocata o scaduta. Un 403 invalid_scope? Alla chiave manca uno scope. Un 429? Hai superato il limite al minuto; attendi i secondi indicati da Retry-After.

Last updated on