Prefer to view the site in English? For relevant information, visit the English version of the website.
19Juin, 2017
10Réaction(s)
liste-externe-api

Comment mettre à jour une liste externe en utilisant l’API de Kizeo Forms ?

 

PREREQUIS
  • Des connaissances minimum sur le fonctionnement de Kizeo Forms,
  • Des connaissances en développement.

Vous saisissez quotidiennement des fiches d’interventions, par exemple, et vous avez besoin que vos listes externes avec les coordonnées de vos clients, la liste du matériel disponible ou encore une liste de références soient mises à jour automatiquement ? Voici comment le mettre en place en passant par notre API !

1. Inventoriez vos listes externes.

La première étape consiste à récupérer la liste de toutes vos listes externes en utilisant une requête de type GET à l’URL https://www.kizeoforms.com/rest/v3/lists/.

Cette étape vous permettra de récupérer l’identifiant (« id« ) de chacune de vos listes externes associé à son nom, et c’est cet id qui vous permettra d’utiliser les fonctions suivantes.

Vous récupèrerez ces données sous la forme suivante :

[
    {
        "id1": "Numero_liste_1",
        "name1": "Nom_liste_1"
    },
    {
        "id2": "Numero_liste_2",
        "name2": "Nom_liste_2"
    },
    {
        "id3": "Numero_liste_3",
        "name3": "Nom_liste_3"
    }
]

2. Récupérez tous les éléments de vos listes externes.

Vous devez récupérer la liste externe que vous souhaitez mettre à jour en utilisant son identifiant obtenu lors de la requête précédente.

Info : Cette opération est à réitérer pour chaque liste externe à mettre à jour.

Pour en avoir la définition complète, sans appliquer de filtre sur la sélection de ces éléments, il suffit de lancer une requête de type GET à l’URL suivante https://www.kizeoforms.com/rest/v3/lists/{listId}/complete.

Attention, n’oubliez pas d’insérer votre token d’identification en en-tête de la requête.

Il faudra également remplacer {listId} par l’identifiant de la liste qui doit être mise à jour.

Vous recevrez votre liste sous le format JSON suivant :

{
    "id": "integer",
    "name": "string",
    "items": [
        "Element1",
        "Element2",
        "Element3"
    ]
}

« id » représentant l’identifiant de la liste demandée, « name » le nom de la liste, « items » le tableau contenant tous les éléments de la liste sous forme de string.

Il vous suffira alors d’ajouter à cette liste les éléments que vous souhaitez insérer dans votre liste externe, puis de renvoyer une requête de type PUT à l’URL suivante  https://www.kizeoforms.com/rest/v3/lists/{listId}.

Vous devrez ajouter dans le corps de la requête la liste que vous venez de modifier, contenant les anciens éléments ainsi que les nouveaux, sans repréciser son identifiant ni son nom.

Par exemple :

{
    "items": [
        "Element1",
        "Element2",
        "Element3",
        "Nouvel_Element1",
        "Nouvel_Element2"
    ]
}

Attention : Si vous ne renvoyez à cette requête que les nouveaux éléments de la liste, les anciens que vous n’aurez pas remis dans le corps de la requête PUT seront supprimés.

N’hésitez pas à commenter cet article !
Nous sommes disponibles pour répondre à vos questions, suggestions, remarques, etc..!


Il y a 10 commentaires

  • Amandine

    13 Déc, 2022

    Bonjour,

    Apres avoir lu les divers réponses, je me demandais s’il existait une méthode simple pour que ma liste externe soit toujours égale à mon stock?
    En effet j’ai un formulaire d’inventaire pour gérer mon Stock d’équipement, et un formulaire d’intervention directement lier à mon stock. (avec la liste externe)
    Hors lors d’ajout d’équipement dans mon stock via le formulaire d’inventaire je vais devoir mettre à jour ma liste externe pour que mon formulaire d’intervention puisse être en lien sur mon stock complet.

    N’étant pas développeuse je cherche un moyen simple pour ne pas avoir à faire manuellement la mise a jour de ma liste externe avec mon extraction de donnée de mon inventaire.
    J’avoue être perdu dans vos tutos API

    Merci de votre aide

    • Yannick Audigier

      14 Déc, 2022

      Bonjour Madame Ernst,

      La mise à jour automatique de vos listes externes peut effectivement se faire à l’aide de nos API.

      En revanche, l’utilisation des API nécessite des connaissances avancées en informatique.
      Il est donc conseillé de faire appel à un développeur pour vous accompagner dans leur utilisation.

      Si vous avez des questions spécifiques à ce sujet, je vous invite à contacter notre service support par mail à l’adresse support@kizeo.com

      En vous souhaitant une bonne journée.
      Cordialement,

      Yannick

  • Benjamin

    22 Sep, 2020

    Bonjour,
    Est-il possible d’actualiser une liste externe grâce au formulaire que l’on envoi ? Comme par exemple un inventaire, que dans la liste il y ai différentes pièces qui s’actualisent en fonction de si on en reçoit ou on en utilise. Ce qui ferait que l’on ai toujours un suivi de combien de pièce nous avons dans notre stock.
    Merci d’avance,
    Cordialement,
    Benjamin

    • Patrick Carloni

      23 Sep, 2020

      Bonjour,
      Si je comprends bien, vous souhaitez faire de la gestion de stock avec Kizeo Forms.
      C’est possible, toutefois il vous faudra utiliser notre Web Service et donc faire du développement.
      Vous trouverez notre aide API en suivant ce lien.
      En espérant avoir répondu à votre question.

  • Robert M

    29 Mai, 2019

    Bonjour,

    Est-ce qu’en utilisant cette API il est possible de mettre à jour automatiquement une liste référentielle avec des données renseignées dans des champs d’un formulaire précédemment enregistré ? (l’enregistrement d’un formulaire enverrai le contenu de certains de ses champs dans une liste référentielle ?)
    L’objectif est d’utiliser des informations envoyées par un formulaire dans la saisie du même formulaire ou d’un autre formulaire.

    Merci

    • Patrick Carloni

      29 Mai, 2019

      Bonjour,

      Avec l’API, vous pouvez effectivement récupérer les données d’un formulaire. Pour vous permettre de voir toutes les fonctions disponibles, je vous suggère de vous rendre ICI pour lire la documentation qui y est liée.
      En espérant avoir répondu à votre question.

  • Ecorchard

    20 Fév, 2018

    Bonjour, je viens de prendre connaissance de votre procédure de exporte et d’import de liste externe . je me demandais si vous aviez une procédure détaillé avec le tutoriel complet ( avec la création des requêtes Get et PUT ?

    Je reste à votre disposition.
    Cordialement.

  • Oxeo

    20 Fév, 2018

    Bonjour, est-ce possible de rajouter des articles automatiquement lors de la saisie d’un formulaire ? Comment utiliser cet Api ? Merci

Poster un commentaire

Votre adresse e-mail ne sera pas publiée.