Documentazione  /  API REST

API REST

ETS in Cloud espone un'API REST che consente di leggere i dati della tua associazione da applicazioni esterne, in modo sicuro tramite token di autenticazione.

🔁
La versione attuale (v1) è in sola lettura. Le operazioni di scrittura (creazione/modifica) sono previste in una fase successiva — vedi roadmap.

Autenticazione

L'API usa l'autenticazione a token Bearer (Laravel Sanctum). Ogni richiesta deve includere il token nell'header Authorization:

Authorization: Bearer <il-tuo-token>
Accept: application/json

Il token viene rilasciato all'utente dell'associazione e ne eredita i permessi. Le richieste sono limitate (rate limiting) e operano sempre nel contesto della tua associazione.

Endpoint disponibili

Tutte le rotte sono prefissate con /api/v1.

  • GET /api/v1/soci — elenco dei soci
  • GET /api/v1/soci/{id} — dettaglio di un socio
  • GET /api/v1/soci/{id}/quote — quote di un socio
  • GET /api/v1/quote/{id} — dettaglio di una quota
  • GET /api/v1/documenti — elenco dei documenti
  • GET /api/v1/documenti/{id} — dettaglio di un documento
  • GET /api/v1/donazioni — elenco delle donazioni
  • GET /api/v1/donazioni/{id} — dettaglio di una donazione

Esempio di chiamata

curl https://nomeassociazione.etsincloud.it/api/v1/soci \
  -H "Authorization: Bearer <il-tuo-token>" \
  -H "Accept: application/json"

Risposte

Le risposte sono in formato JSON. Gli elenchi sono paginati e includono i metadati di paginazione. In caso di errore, l'API restituisce un codice HTTP appropriato (401 non autenticato, 403 non autorizzato, 404 non trovato, 429 troppe richieste).

🔑
Per richiedere un token API o maggiori dettagli sull'integrazione, contatta supporto@etsincloud.it.