Les possibilités de l'API Kizeo Forms
  • 06 Nov 2023
  • 3 Minuten zu lesen
  • Dunkel
    Licht

Les possibilités de l'API Kizeo Forms

  • Dunkel
    Licht

The content is currently unavailable in German. You are viewing the default French version.
Artikel-Zusammenfassung

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

Kizeo Forms, une application connectable

Vous avez la possibilité d'ouvrir Kizeo Forms à d’autres logiciels métiers déjà en votre possession. Comment ? En utilisant notre API (ou Web Service).

Kizeo Forms étant une application de remontée d’informations terrain, il est souvent nécessaire de partager ces données avec d’autres systèmes d’information.

Afin de vous faciliter le développement, nous mettons à votre disposition un Swagger pour vous permettre de tester les réponses. Vous trouverez l’aide sur l’utilisation de chacune des requêtes citées dans ce tutoriel.

Voici quelques exemples de ce que vous pourriez réaliser.

1. Comment mettre à jour automatiquement mes Listes Externes ?

Oui, il est possible de faire en sorte que votre Liste Externe soit mise à jour en fonction des saisies sur un ou des formulaires. Vous avez par exemple un formulaire dans lequel vous saisissez les informations des nouveaux clients, cette fonctionnalité vous permettra d’implémenter automatiquement votre liste externe. Pour réaliser cela, voici la méthode à suivre :

  1. Appelez la requête https://forms.kizeo.com/rest/v3/lists/{listId}. Vous récupérez la définition de la liste que vous souhaitez mettre à jour.
  2. Appelez la requête https://forms.kizeo.com/rest/v3/forms/{formId}/data/unread/test/100?includeupdated. Vous récupérez ainsi toutes les informations des données qui ont été saisies ou modifiées sur le formulaire {formId} depuis le dernier appel de la fonction. 
  3. Modifiez le json de votre liste externe.
  4. Exécutez la requête https://forms.kizeo.com/rest/v3/lists/{listId} en passant dans le body, votre fichier json.
  5. Votre liste externe est désormais à jour.
Attention
  • Chaque mise à jour d’une liste externe écrase la précédente définition. Il est donc impératif de renvoyer la liste complète et pas uniquement les ajouts ou modifications.
  • Cela nécessite aussi que les utilisateurs les rechargent sur leurs mobiles. Selon la taille, le temps peut être plus ou moins long. Nous préconisons donc d’espacer les mises à jour au maximum. Par exemple 1 à 2 fois par jour.

2. Comment gérer mes stocks ?

Vous pouvez gérer vos stocks grâce la méthode expliquée dans l'exemple précédent.

3. Comment synchroniser mon ERP / CRM avec Kizeo Forms ?

Il est possible de mettre en place une synchronisation entre votre application métier et Kizeo Forms. Cela vous permettrait, par exemple, de maintenir à jour vos informations commerciales (nom de la société, adresse, CA, interlocuteurs, …) dans une Liste Externe Référentielle. Pour que cela soit réalisable, il faut que votre logiciel possède une API afin de pouvoir réaliser une connexion avec Kizeo Forms.

📖 Pour en savoir plus sur les Listes Externes Référentielles, consultez ce tutoriel.

Il est également possible de réaliser des envois automatiques de planning d’intervention. Je prendrai pour exemple une société de dépannages multiservice qui reçoit toute la journée des demandes d’intervention. Les rendez-vous sont saisis dans l’ERP. Le soir, une « moulinette » est exécutée qui génère et réalise, en automatique, l’ensemble des Push. Ainsi le lendemain matin chaque technicien sur le terrain, à son planning d’intervention dans son mobile/tablette.

4. Création/modification en masse d’utilisateurs et de groupes

Vous possédez un grand nombre d’utilisateurs et vos équipes changent souvent ? Comment gérer cela plus rapidement que par l’Interface Web ?

L'API vous permet de faire de la création/modification en masse d’utilisateurs et de groupes. Nous allons prendre l’exemple du démarrage d’un nouveau chantier. Voici les requêtes que vous pouvez utiliser :

  • https://forms.kizeo.com/rest/v3/group en POST pour créer votre groupe correspondant au chantier.
  • https://forms.kizeo.com/rest/v3/group/{groupId}/users en POST pour ajouter une liste d'utilisateurs.
  • https://forms.kizeo.com/rest/v3/group/{groupId}/leaders en POST pour ajouter les chefs de groupe.

Il est également possible d’ajouter ou enlever des utilisateurs et des chefs de groupe, avec les requêtes suivantes :

  • https://forms.kizeo.com/rest/v3/group/{groupId}/user/{userId} en POST pour ajouter, en DELETE pour la suppression.
  • https://forms.kizeo.com/rest/v3/group/{groupId}/leader/{leaderId} en POST pour ajouter, en DELETE pour la suppression.

📖 Pour en savoir plus sur les Groupes, consultez ce tutoriel.