L'API REST
Chaque instance AltiusForms expose une API REST qui renvoie du JSON. Elle sert aux scripts, aux outils de BI et aux logiciels métier qui doivent lire ou envoyer des réponses.
Trouver l'adresse de l'API
- Ouvrez API et intégration dans la barre latérale.
- Le bloc Votre point d'accès API affiche l'adresse de base, par exemple
https://votre-nom.altiusforms.com/api/v1/. - Ouvrir la documentation API mène à la documentation interactive
(Swagger UI ou ReDoc), qui liste chaque point d'accès et permet d'essayer
les requêtes. Le schéma OpenAPI (YAML) se télécharge à
/api/schema/.
Les ressources principales
| Ressource | Usage |
|---|---|
forms/ |
formulaires, filtrables par category, access_level, is_active ; recherche par nom |
submissions/ |
lire les réponses et en envoyer de nouvelles (GET, POST) |
files/ |
fichiers joints aux réponses (lecture), filtrables par submission |
uploads/ |
déposer un fichier avant de l'associer à une réponse |
Les réponses se filtrent par formulaire et se trient par date d'envoi :
curl -H "Authorization: Token VOTRE_JETON" "https://votre-nom.altiusforms.com/api/v1/submissions/?form_template=12&ordering=-date_submitted"
Envoyer un fichier
Déposez d'abord le fichier (champ file, 25 Mo au maximum), puis
référencez l'identifiant renvoyé dans les données de la réponse :
curl -H "Authorization: Token VOTRE_JETON" -F "file=@photo.jpg" https://votre-nom.altiusforms.com/api/v1/uploads/
Droits
L'API applique les droits du compte utilisé : un compte administrateur voit toutes les réponses, un autre compte seulement les siennes. Les réponses ne se modifient pas et ne se suppriment pas par l'API.
L'authentification est décrite dans Authentification.
Une question reste sans réponse ?
Écrire à l'équipe