Dismoi?

Formulaire

Retourne la structure d'un formulaire GET
/api/v1/forms/{key}.json

Liste les champs et la confifuration d'un formulaire Dismoi?. L'identifiant api est à récupérer dans la console d'administration ou l'API Developers.

Paramètres supportés par ce endpoint :

NomTypeDescription
keyObligatoirestringIdentifiant api du formulaire

Format de sortie :

data:{
    "name": "string",
    "has_captcha": "boolean",
    "fields": [
        {
            "label": "string",
            "type": "string",
            "required": "boolean",
            "help": "string",
            "name": "string",
            "options": [
                {
                    "value": "string",
                    "label": "string"
                }
            ],
            "value": "string"
        }
    ],
    "is_consent_required": "boolean",
    "processing_purposes": "string"
}
NomTypeDescription
namestringNom du formulaire
has_captchabooleanActivation du captcha
fieldsobjectChamps du formulaire
labelstringInitutlé du champ
typestringType du champ. Les valeurs possibles sont : text, textarea, chiffres, lettres, email, civilite, fieldset, select, checkbox, upload, radio, date, datetime, regions, departements, pays
requiredbooleanChamp obligatoire
helpstringAide à la saisie
namestringValeur de l'attribut name attendu dans le formulaire
optionsFacultatifobjectValeurs possible du champ
valuestringValeur
labelstringIntitulé
valueFacultatifstringValeur saise
is_consent_requiredbooleanRecueil du consentement requis
processing_purposesstringFinalités de traitement des données du formulaire
Envoie une réponse au formulaire POST
/api/v1/forms/{key}.json

Envoie une réponse au formulaire Dismoi?. L'identifiant api est à récupérer dans la console d'administration ou l'API Developers.

Paramètres supportés par ce endpoint :

NomTypeDescription
keyObligatoirestringIdentifiant api du formulaire
fieldsObligatoirearrayRéponses du formulaire Dismoi?
captchastringRéponse au dernier captcha généré. Ce champ est requis selon la configuration du site
tokenObligatoirestringJeton unique du formulaire
modelstringModele utilisé pour le formulaire, determine quel template d'email sera utilisé pour l'email de notification
consentbooleanDonne le consentement au traitement des données

Format de sortie :

data:{
    "new_captcha": "string",
    "message": "string"
}
NomTypeDescription
new_captchaFacultatifstringNouveau captcha en cas d'échec de soumission du commentaire (vide si reCaptcha est activé)
messageFacultatifstringMessage de confirmation du formulaire

Captcha

Génère un captcha GET
/api/v1/forms/{key}/captcha.json

Génère un nouveau captcha pour un formulaire Dismoi?. L'identifiant api est à récupérer dans la console d'administration ou l'API Developers.

Paramètres supportés par ce endpoint :

NomTypeDescription
keyObligatoirestringIdentifiant api du formulaire

Format de sortie :

data:{
    "captcha": "string"
}
NomTypeDescription
captchastringQuestion du captcha (vide si reCaptcha est activé)