La plupart des gens remplissent les formulaires dans un navigateur. Mais les développeurs intègrent aussi des formulaires dans des applications sur mesure, des applications mobiles, des systèmes embarqués et des outils internes. Ces formulaires n'utilisent pas le créateur de formulaires en glisser-déposer. Ils passent par des API pour envoyer les données directement à votre plateforme de formulaires.
Cet article explique comment fonctionnent les API de formulaires, quand vous en avez besoin et ce qu'il faut chercher dans une plateforme qui offre un accès API solide.
Ce qu'est une API de formulaire et pourquoi les développeurs l'utilisent
Une API de formulaire permet aux développeurs d'envoyer des données de formulaire par programmation, au lieu de passer par un formulaire dans un navigateur. Au lieu qu'une personne clique sur un bouton « envoyer » dans un formulaire web, un développeur écrit du code qui envoie les données directement au système de formulaires.
Dans quels cas le faire ?
Créer une application sur mesure : vous développez votre propre application et voulez collecter des données de formulaire avec votre outil de formulaires comme serveur. Votre code appelle l'API pour envoyer.
Envoi de formulaire depuis une application mobile : votre application mobile contient un formulaire. Quand l'utilisateur l'envoie, le code de l'application appelle l'API.
Intégrer des données de plusieurs sources : vous collectez des données depuis différents systèmes et voulez tout centraliser dans une seule plateforme de formulaires. Votre code d'intégration utilise l'API.
Opérations par lots : vous avez des milliers d'enregistrements à importer. Au lieu de les saisir à la main, votre code les envoie par programmation via l'API.
Comment fonctionnent les API de formulaires (sans avoir à comprendre le code)
Une API de formulaire fonctionne ainsi : votre application a des données. Elle veut les envoyer à la plateforme de formulaires. Elle fait un appel d'API (imaginez un message) qui dit « voici des données, merci de les enregistrer ». La plateforme les reçoit, les valide et les enregistre comme si quelqu'un avait rempli un formulaire web et cliqué sur envoyer.
La plateforme renvoie une réponse qui confirme que l'envoi a bien été reçu et enregistré.
Pour la plateforme, les données d'un envoi par API sont identiques à celles d'un formulaire web. Les deux sont traitées de la même façon.
Authentification et sécurité de l'API
Quand votre code appelle une API de formulaire, il doit prouver qu'il est autorisé. Cela passe par l'authentification, en général une clé d'API.
Une clé d'API est un peu le mot de passe de votre application. Vous la gardez secrète. Quand votre code veut envoyer des données, il inclut la clé. La plateforme la vérifie et répond « oui, cette application est autorisée ».
Ne publiez jamais votre clé d'API dans du code public et ne la partagez pas. Si quelqu'un l'obtient, il peut envoyer des données de formulaire en votre nom (ce qui peut poser problème si vous prenez des décisions importantes à partir des réponses).
Limitation du débit : combien d'appels d'API sont autorisés
La plupart des plateformes limitent le nombre d'appels d'API. Cela évite les abus et protège le système.
Une limite typique peut être « 1 000 appels d'API par heure et par clé ». Si votre application dépasse cette limite, les appels suivants sont rejetés jusqu'à la réinitialisation à l'heure suivante.
Quand vous choisissez une plateforme, vérifiez les limites de débit de l'API. Si vous devez faire 10 000 envois par heure, une limite de 1 000 appels par heure ne conviendra pas. Renseignez-vous sur des limites plus élevées ou des options d'évolution.
Réponses de l'API et gestion des erreurs
Quand votre code appelle l'API de formulaire, il reçoit une réponse. Elle indique si l'envoi a réussi ou échoué.
Réponse de succès : HTTP 200 ou 201. L'envoi a été reçu et enregistré. Votre code peut continuer.
Réponse d'erreur : HTTP 400, 401, 500, etc. Quelque chose s'est mal passé. Votre code doit gérer l'erreur (réessayer, la consigner, alerter quelqu'un).
De bons messages d'erreur disent ce qui s'est passé. « Champ obligatoire manquant : email » est utile. « Erreur » sans détail ne l'est pas.
Envois par lots via l'API
Parfois, vous avez plusieurs envois à faire en même temps. Certaines API gèrent les opérations par lots : vous envoyez 100 réponses en un seul appel au lieu de 100 appels séparés.
Les envois par lots sont plus efficaces. Ils réduisent le nombre d'appels et se terminent plus vite.
Vérifiez si l'API de votre plateforme gère les envois par lots. Si vous devez importer de gros volumes de données, cette fonction compte.
Notifications par webhook côté API
Quand des données arrivent par l'API, vous pouvez vouloir des notifications ou des actions de suivi. Certaines plateformes envoient des notifications par webhook pour les envois par API, comme pour les formulaires web.
Ainsi, si votre code envoie par l'API, vos systèmes en aval (CRM, e-mail, etc.) sont quand même prévenus automatiquement.
Documentation de l'API et expérience développeur
Une bonne API de formulaire s'appuie sur une excellente documentation. Elle explique comment s'authentifier, quel point d'accès appeler, quel format de données utiliser, quelles erreurs peuvent survenir, et fournit des exemples de code.
Une mauvaise documentation rend la vie des développeurs pénible. Si vous choisissez une plateforme et avez besoin d'un accès API, lisez d'abord sa documentation. Est-elle claire ? Y a-t-il des exemples ? La comprenez-vous ?
Quand utiliser l'API et quand utiliser un formulaire web
Utilisez un formulaire web quand : vous voulez que les visiteurs remplissent un formulaire dans leur navigateur. Vous n'avez pas besoin de code. L'interface en glisser-déposer du créateur de formulaires suffit.
Utilisez une API quand : vous êtes développeur et créez une application sur mesure. Vous devez envoyer des données par programmation. Vous intégrez plusieurs sources de données. Vous devez personnaliser toute l'expérience d'envoi.
On utilise souvent les deux. Un site web a des formulaires web pour les visiteurs. Votre application interne utilise l'API pour les envois par programmation.
Comment WEMASY prend en charge les API de formulaires
WEMASY fournit une API REST qui permet aux développeurs d'envoyer des données de formulaire par programmation. Authentifiez-vous avec une clé d'API, envoyez les données au point d'accès, recevez la confirmation. Les envois par API sont traités comme ceux des formulaires web. Ils déclenchent des automatisations, se synchronisent avec les systèmes intégrés et apparaissent dans votre tableau de bord WEMASY. Les limites de débit et l'envoi par lots sont disponibles selon votre offre. Consultez la documentation de l'API dans votre compte WEMASY ou la page des tarifs pour le détail de l'accès API.