Die REST-API

Jede AltiusForms-Instanz stellt eine REST-API bereit, die JSON zurückgibt. Sie dient Skripten, BI-Werkzeugen und Fachanwendungen, die Antworten lesen oder senden müssen.

Die API-Adresse finden

Öffnen Sie API & Integration in der Seitenleiste.
Der Block mit Ihrem API-Endpunkt zeigt die Basisadresse, zum Beispiel https://votre-nom.altiusforms.com/api/v1/.
Der Link zur API-Dokumentation führt zur interaktiven Dokumentation (Swagger UI oder ReDoc), die alle Endpunkte auflistet und Anfragen direkt ausprobieren lässt. Das OpenAPI-Schema (YAML) liegt unter /api/schema/.

Die wichtigsten Ressourcen

Ressource	Verwendung
`forms/`	Formulare, filterbar nach `category`, `access_level`, `is_active`; Suche nach Name
`submissions/`	Antworten lesen und neue senden (`GET`, `POST`)
`files/`	Dateien zu Antworten (nur lesen), filterbar nach `submission`
`uploads/`	eine Datei hochladen, bevor sie einer Antwort zugeordnet wird

Antworten lassen sich nach Formular filtern und nach Eingangsdatum sortieren:

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

Eine Datei senden

Laden Sie zuerst die Datei hoch (Feld file, höchstens 25 MB) und verweisen Sie dann in den Daten der Antwort auf die zurückgegebene ID:

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

Berechtigungen

Die API wendet die Rechte des verwendeten Kontos an: Ein Administratorkonto sieht alle Antworten, jedes andere Konto nur seine eigenen. Antworten lassen sich über die API weder ändern noch löschen.

Die Anmeldung ist unter Authentifizierung beschrieben.