Webservices liés aux formulaires
Les APIs de participations aux formulaires peuvent être utilisés pour faire le lien entre Actito et des formulaires qui n'ont pas forcément été définis par Actito.
Ceci peut être utile d'une part pour pouvoir collecter des données qui proviennent d'un partenaire extérieur et de les soumettre vers Actito à des fins d'enrichissement, tout en conservant la source de l'information d'une façon qui s'accorde avec la réglementation RGPD.
D'autre part, cela peut être typiquement utilisé quand la conception du formulaire est gérée par une autre plateforme. Les réponses données par les profils peuvent être ainsi directement poussées dans un formulaire technique Actito via l'utilisation des APIs de formulaires.
La conception en tant que telle d'un formulaire Actito n'est pas possible via l'utilisation des APIs. Ceci doit être fait via l'interface Actito. Pour plus d'informations à ce sujet, vous pouvez vous référez au chapitre consacré aux formulaires.
En revanche, les APIs liés aux formulaires vous permettent :
- d'obtenir la structure d'un formulaire
- d'obtenir les détails de participation d'un profil
- de créer et de mettre à jour des participations à un formulaire, en appliquant les règles d'enrichissement
Préparer un formulaire compatible avec l'utilisation d'API
L'utilisation des APIs liés aux formulaires implique que votre formulaire devra respecter certaines contraintes pour garantir que l'utilisation des webservices se fasse avec succès. Il convient de les garder à l'esprit lors de la création de votre formulaire dans l'interface Actito.
Noms d'affichage et traductions
Lors de la création de votre formulaire dans l'interface d'Actito, si vous optez pour des questions à réponses multiples, vous avez la possibilité de définir des valeurs d'affichages différentes des valeurs techniques. Vous pouvez également traduire ces valeurs en fonction du langage.
Néanmoins, cette notion n'est pas prise en compte dans les APIs liés aux formulaires. Seules les valeurs techniques, qui restent identiques quel que soit le langage, peuvent être obtenues ou poussées via un appel.
Les questions peuvent par contre être traduites, car elles pourront être associées à des noms techniques.
Définition des noms techniques du formulaire
Les APIs liés aux formulaires font usage de noms techniques pour soumettre les données. Il est important de donner des noms clairs et précis à vos questions, à la fois pour des questions de facilité d'usage et pour éviter tout risque d'erreur dans la paramétrisation des APIs.
Le texte court que vous pouvez associer à chaque question lors de la création de votre formulaire est utilisé pour le reporting mais il ne s'agit pas du nom technique. Ceux-ci doivent être ajoutés ultérieurement. Pour cela, rendez-vous dans la liste des formulaires existant dans l'onglet "Activés". Cliquez sur le bouton "Plus" puis, dans le menu déroulant, cliquez sur "Définir les noms techniques".
Vous pouvez alors définir des noms techniques pertinents à la fois pour l'enquête générale et pour chaque question individuelle.
Astuce
Si vous avez inclus des "Question Prédéfinies", celles-ci auront déjà un nom technique prérempli.
Règles d'enrichissement de la base de données
Les formulaires permettent à vos contacts de modifier directement leurs informations de profils. Lors de la création d'un formulaire destiné à être utilisé avec un API Actito, il est important de définir de bonnes règles d'enregistrement de profils.
En effet, une des règles d'enrichissement disponible consiste à enrichir la base de données si les réponses d'une page en particulier sont enregistrées. Or la notion de page n'est pas prise en compte dans le cas d'une utilisation des APIs.
De ce fait, il est nécessaire de ne pas utiliser cette règle mais de plutôt privilégier une condition d'enrichissement quand "la participation au formulaire est terminée".
Pour des informations plus complètes sur les règles d'enrichissement, nous vous invitons à vous référer à la page "Enrichir une base de données".
