Récupérer les données d’un formulaire avec l'API Kizeo Forms
  • 06 Nov 2023
  • 1 Minute à lire
  • Sombre
    Clair

Récupérer les données d’un formulaire avec l'API Kizeo Forms

  • Sombre
    Clair

Article Summary

Prérequis
  • Des connaissances minimums sur le fonctionnement de Kizeo Forms
  • Des compétences en développement

Si vous souhaitez récupérer des données saisies dans vos formulaires pour les insérer automatiquement dans votre CRM, votre ERP ou tout autre logiciel métier, il est nécessaire de passer par notre API. La démarche est simple mais nécessite de suivre un protocole précis. Ce processus est similaire à celui que l’on utilise lorsque l’on passe par l'Interface Web de Kizeo Forms.

1. L’identification

Comme sur l’Interface Web, la toute première étape consiste à s’identifier. Pour cela, il vous faut un Token. Il vous permettra d’accéder à vos données stockées sur nos serveurs par l’intermédiaire de notre API. Si vous n’en possédez pas, consultez le tutoriel Débuter avec l'API Kizeo Forms pour savoir comment faire.

2. Récupérez la liste des données du formulaire

Avec l'Interface Web Kizeo Forms, une fois que vous êtes connecté, allez dans l’historique des données, et sélectionnez votre formulaire pour afficher l’ensemble des enregistrements liés à ce formulaire. Avec l’API nous allons suivre le même chemin. Une fois le Token récupéré, vous pouvez accéder aux informations stockées sur nos serveurs. La procédure est similaire à celle utilisée avec l’interface Web. En effet pour accéder à vos données vous devez en premier lieu passer par l’historique. Ce dernier vous affiche l’ensemble des données liées à un formulaire.

https://forms.kizeo.com/rest/v3/forms/{formId}/data/unread/{flag}/100 : cette URL permet de récupérer la liste des données qui n’ont pas encore été marquées pour un {flag}. Pour plus de renseignements sur l'utilisation et les options de cette requête, suivez ce lien.

3. Sélectionnez ensuite la donnée que vous souhaitez récupérer dans son intégralité

https://forms.kizeo.com/rest/v3/forms/{formId}/data/{dataId} : cette URL vous permet de récupérer la donnée complète.

Accéder aux informations pour utiliser ces requêtes.

4. Les options

  • Afin d’éviter de lire de nouveau des données, vous pouvez les marquer comme lues.
    https://forms.kizeo.com/rest/v3/forms/{formId}/markasreadbyaction/{flag} : Cette URL vous permet de marquer une donnée pour un {flag}.
  • Le Web Service de Kizeo Forms vous offre également la possibilité de réaliser une recherche avancée sur vos données. Cette fonction vous permet d’obtenir la liste des données d’un formulaire qui répondent à une recherche spécifique sur un ou plusieurs champs.
    https://forms.kizeo.com/rest/v3/forms/{formId}/data/advanced : cette URL vous renvoie vers la recherche avancée. Vous trouverez toutes les informations pour utiliser cette requête.

Cet article vous a-t-il été utile ?