19Juin, 2017
0Réaction(s)

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

 

Cette Kize’Astuces nécessite que vous connaissiez un minimum le fonctionnement de Kizeo Forms et que vous ayez des compétences en développement informatique.

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/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 identifiant qui vous sera utile pour 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.

Deuxièmement, vous devez récupérer la liste externe que vous voulez 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 que vous voulez mettre à jour.

Pour en avoir la définition complète, sans appliquer de filtre sur la sélection de ses éléments, il suffit de lancer une requête de type GET à l’URL suivante (sans omettre d’insérer votre token d’identification en en-tête de la requête) https://www.kizeoforms.com/lists/{listId}/complete

Et en remplaçant {listId} par l’identifiant de la liste que vous voulez mettre à 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 voulez insérer dans votre liste externe, puis de renvoyer une requête de type PUT à l’URL suivante  https://www.kizeoforms.com/lists/{listId}

En ajoutant 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 et son nom.

Pour exemple :

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

Attention : Si vous ne renvoyez à cette requête que les nouveaux éléments, les anciens éléments de la liste 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..!

Poster un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *