L'API REST

Ogni istanza AltiusForms espone un'API REST che restituisce JSON. Serve a script, strumenti di BI e software gestionali che devono leggere o inviare risposte.

Trovare l'indirizzo dell'API

Aprite API e Integrazione nella barra laterale.
Il blocco con il vostro punto di accesso API mostra l'indirizzo di base, per esempio https://votre-nom.altiusforms.com/api/v1/.
Il link alla documentazione API porta alla documentazione interattiva (Swagger UI o ReDoc), che elenca tutti i punti di accesso e permette di provare le richieste. Lo schema OpenAPI (YAML) è disponibile su /api/schema/.

Le risorse principali

Risorsa	Uso
`forms/`	moduli, filtrabili per `category`, `access_level`, `is_active`; ricerca per nome
`submissions/`	leggere le risposte e inviarne di nuove (`GET`, `POST`)
`files/`	file allegati alle risposte (sola lettura), filtrabili per `submission`
`uploads/`	caricare un file prima di collegarlo a una risposta

Le risposte si filtrano per modulo e si ordinano per data d'invio:

curl -H "Authorization: Token IL_VOSTRO_TOKEN" "https://votre-nom.altiusforms.com/api/v1/submissions/?form_template=12&ordering=-date_submitted"

Inviare un file

Caricate prima il file (campo file, massimo 25 MB), poi indicate l'ID restituito nei dati della risposta:

curl -H "Authorization: Token IL_VOSTRO_TOKEN" -F "file=@foto.jpg" https://votre-nom.altiusforms.com/api/v1/uploads/

Diritti

L'API applica i diritti dell'account usato: un account amministratore vede tutte le risposte, ogni altro account solo le proprie. Le risposte non si modificano né si eliminano tramite l'API.

L'autenticazione è descritta in Autenticazione.