Crediti / Wallet

Endpoint in sola lettura (GET) sul saldo crediti dell'utente autenticato. Sono gratuiti (non consumano credito) e già disponibili con il tuo Bearer token — non serve una whitelist di origin configurata.

Auth: header Authorization: Bearer <api_token> su ogni chiamata. Base URL: https://api.dokicasa.it (produzione) · https://api-dev.dokicasa.it (sandbox).

Crediti per gruppo

GET /api/users/me/credits

I crediti a disposizione dell'utente, aggregati per gruppo di servizio (Firma Elettronica, visure, ...) e per origine. Sono i crediti non scaduti: quelli consumati restano nel conteggio come used.

[
  { "group": "Firma Elettronica", "used": 3, "total": 10, "source": "smart", "is_unlimited": false },
  { "group": "Visure catastali",  "used": 0, "total": 5,  "source": "single", "is_unlimited": false }
]

Campo	Tipo	Note
group	string	Gruppo di servizio. I crediti senza gruppo finiscono in Altri crediti
total	integer	Crediti del gruppo (usati compresi)
used	integer	Quanti ne sono gia' stati consumati
source	string	smart (inclusi in Dokicasa Smart) · market_scanner · single (acquisto singolo)
is_unlimited	boolean	true = il piano da' il gruppo illimitato: mostra "illimitato" invece del conteggio

Lo stesso gruppo puo' comparire in piu' righe con source diverso: la firma elettronica inclusa nell'abbonamento e quella comprata a parte restano contate separatamente.

Query	Default	Note
only_dokicasa_smart	assente	1 = solo i crediti inclusi in un abbonamento Dokicasa Smart. Senza il parametro quei crediti sono esclusi

Se preferisci passare il tuo id, GET /api/users/{id}/credits risponde allo stesso modo, ma l'id deve essere quello dell'utente del token: altrimenti la risposta e' 403.

Saldo wallet

GET /api/users/me/wallet

Restituisce il saldo dell'utente, comprensivo dei costi futuri previsti (job schedulati e censimenti pendenti).

{
  "wallet": 120.00,
  "real_wallet": 89.50
}

Campo	Tipo	Note
wallet	number	Saldo nominale attuale sul wallet
real_wallet	number	Saldo realmente disponibile, al netto dei costi già impegnati (pendenti)

Storico transazioni

GET /api/users/me/wallet-transactions

Storico paginato delle movimentazioni del wallet (le più recenti prima).

Query	Default	Note
per_page	20	elementi per pagina
page	1	pagina da leggere

Risposta: paginatore Laravel — { current_page, data: [ … ], per_page, total, last_page, … }.

Prova rapida (curl)

curl https://api-dev.dokicasa.it/api/users/me/wallet \
  -H "Authorization: Bearer HfBfYShns3E02no3kkwCRWQugkVNcJCtrRN2BPoI5NxhqsiXaxxnSPpIHY2O"
# → { "wallet": 120.00, "real_wallet": 89.50 }

TIP

Puoi provarli subito con il token di test sulla sandbox: sono chiamate di sola lettura, gratuite.