Portail Développeurs

L'API Inbound de FormDZ pour intégrer la puissance de nos formulaires dans votre propre code.

Swagger UI

Introduction

L'API FormDZ est organisée autour de REST. Elle accepte les corps de requête codés en JSON, renvoie des réponses codées en JSON et utilise les codes de réponse HTTP standard.

i

Où est la documentation Swagger ?

Cette page explique les concepts de base (Le Workflow Headless). Pour la documentation technique interactive (Swagger/OpenAPI) contenant tous les endpoints, paramètres et schémas complets, cliquez sur le bouton noir Swagger UI en haut à droite.

Authentification

L'authentification à l'API s'effectue via l'en-tête HTTP Authorization avec un token Bearer. Vous trouverez votre clé secrète dans les paramètres de votre compte FormDZ.

En-tête HTTP
Authorization: Bearer sk_live_votre_cle_secrete

Comprendre le Workflow (Clarification)

Il y a souvent une confusion concernant la création de formulaires. Voici la règle d'or de FormDZ :

⚠️ Un formulaire DOIT exister dans la base de données FormDZ AVANT de pouvoir recevoir des soumissions. Il est impossible d'envoyer une réponse à un formulaire qui n'existe pas en espérant qu'il se crée tout seul. FormDZ a besoin de connaître la structure des champs pour faire fonctionner l'Intelligence Artificielle et les statistiques.

Comment faire alors ? Vous avez 2 solutions :

AMéthode Manuelle

Parfait si vous avez quelques formulaires fixes (ex: Contact, Inscription).

  1. Créez le formulaire sur le tableau de bord FormDZ.
  2. Cliquez sur Exporter JSON pour récupérer les IDs des champs.
  3. Codez votre site en utilisant ces IDs dans vos balises <input>.

BMéthode 100% API (Dynamique)

Parfait si votre plateforme externe génère des formulaires dynamiquement.

  1. Votre code appelle l'endpoint POST /api/v1/forms pour créer le formulaire sur FormDZ programmatiquement.
  2. FormDZ vous renvoie un formId.
  3. Vous utilisez cet ID pour soumettre les réponses.

1. Créer un formulaire (API Dynamique)

Si vous avez choisi la Méthode B, voici comment créer dynamiquement un formulaire depuis votre propre backend.

POST/api/v1/forms
Exemple de payload JSON (Création)
{"title": "Nouveau Formulaire Dynamique","published": true,"content": [{ "id": "nom_client", "type": "text", "label": "Nom complet" },{ "id": "email_client", "type": "email", "label": "Adresse Email" }]}

2. Soumettre une réponse

Une fois le formulaire créé (manuellement ou via l'API), vous pouvez envoyer les réponses des utilisateurs vers cet endpoint.

POST/api/v1/forms/{id}/submit

Important concernant les Fichiers : Cet endpoint n'accepte que du format JSON. Pour envoyer un fichier depuis un site externe, vous devez l'héberger sur votre propre serveur (ou Amazon S3) et envoyer l'URL publique de ce fichier comme réponse texte.

Exemple de payload (Soumission)
{"answers": {"nom_client": "Karim","email_client": "karim@exemple.com"}}
FormDZ API Documentation | FormDZ