Panoramica API
L'API REST di Workledger consente di gestire datori di lavoro, contratti domestici, eventi lavorativi e cedolini in modo programmatico.
URL base
https://api.workledger.it/v1
Versioning
L'API utilizza il versioning tramite URL. La versione corrente è v1. Le versioni precedenti restano disponibili ma non ricevono nuove funzionalità.
Formato richieste e risposte
- Le richieste con body devono usare
Content-Type: application/json. - Tutte le risposte sono in formato JSON.
- Le date seguono il formato ISO 8601 (
2026-03-15T14:30:00Z). - Gli importi monetari sono espressi come stringhe decimali (es.
"1500.00").
Paginazione
Gli endpoint che restituiscono elenchi supportano la paginazione tramite parametri query:
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
page | integer | No | Numero di pagina (default 1). |
limit | integer | No | Numero massimo di risultati per pagina (default 20, max 100). |
search | string | No | Termine di ricerca testuale. |
sortField | string | No | Campo per l'ordinamento. |
sortDirection | string | No | Direzione ordinamento: asc o desc. |
Codici di errore
| Codice HTTP | Significato |
|---|---|
400 | Richiesta non valida (parametri mancanti o errati) |
401 | Autenticazione mancante o non valida |
403 | Permessi insufficienti |
404 | Risorsa non trovata |
429 | Limite di richieste superato |
500 | Errore interno del server |
Formato errore:
{
"error": {
"code": "invalid_request",
"message": "Il campo 'first_name' è obbligatorio.",
"param": "first_name"
}
}Risorse disponibili
- Datori di lavoro — gestione anagrafica dei datori di lavoro domestici.
- Contratti domestici — configurazione dei rapporti di lavoro, orari, retribuzioni e impostazioni contrattuali.
- Eventi lavorativi — registrazione di presenze, assenze, ferie, malattia e straordinari.
- Cedolini — elaborazione, consultazione e finalizzazione delle buste paga.
- Contributi — consultazione e gestione dei contributi INPS e Cassa Colf trimestrali.