Mettre à jour vos Listes Externes automatiquement via l'API

Vous saisissez quotidiennement des fiches d’interventions 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. Inventorier 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.

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"
    ]
}