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 :

Nom		Type	Description
`key`	Obligatoire	string	Identifiant api du formulaire

Format de sortie :

Schéma JSON
Modèle

data:{
    "name": "string",
    "has_captcha": "boolean",
    "fields": [
        {
            "label": "string",
            "type": "string",
            "required": "boolean",
            "help": "string",
            "name": "string",
            "alias": "string",
            "options": [
                {
                    "value": "string",
                    "label": "string"
                }
            ],
            "value": "string"
        }
    ],
    "is_consent_required": "boolean",
    "processing_purposes": "string"
}

Nom	Type	Description
`name`	string	Nom du formulaire
`has_captcha`	boolean	Activation du captcha
`fields`	object	Champs du formulaire
`label`	string	Initutlé du champ
`type`	string	Type du champ. Les valeurs possibles sont : text, textarea, chiffres, lettres, email, civilite, fieldset, select, checkbox, upload, radio, date, datetime, regions, departements, pays, hidden
`required`	boolean	Champ obligatoire
`help`	string	Aide à la saisie
`name`	string	Valeur de l'attribut name attendu dans le formulaire
`alias`Facultatif	string	Alias
`options`Facultatif	object	Valeurs possible du champ
`value`	string	Valeur
`label`	string	Intitulé
`value`Facultatif	string	Valeur saise
`is_consent_required`	boolean	Recueil du consentement requis
`processing_purposes`	string	Finalité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 :

Nom		Type	Description
`key`	Obligatoire	string	Identifiant api du formulaire
`fields`	Obligatoire	array	Réponses du formulaire Dismoi?
`captcha`		string	Réponse au dernier captcha généré. Ce champ est requis selon la configuration du site
`token`	Obligatoire	string	Jeton unique du formulaire
`model`		string	Modele utilisé pour le formulaire, determine quel template d'email sera utilisé pour l'email de notification
`consent`		boolean	Donne le consentement au traitement des données

Format de sortie :

Schéma JSON
Modèle

data:{
    "new_captcha": "string",
    "message": "string"
}

Nom	Type	Description
`new_captcha`Facultatif	string	Nouveau captcha en cas d'échec de soumission du commentaire (vide si reCaptcha est activé)
`message`Facultatif	string	Message 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 :

Nom		Type	Description
`key`	Obligatoire	string	Identifiant api du formulaire

Format de sortie :

Schéma JSON
Modèle

data:{
    "captcha": "string"
}

Nom	Type	Description
`captcha`	string	Question du captcha (vide si reCaptcha est activé)