Débuter avec l'API REST

1.  Création de la clé de l'API

2. Créer une table de donnée à partir d'un fichier csv

3. Mettre à jour une table de donnée à partir d'un ficher csv

4. Trouver l'identificateur unique d'un jeu de donnée

1. Création de la clé de l'API

Pré-requis

  1. Une licence serveur avec le module API REST activé.
  2. Un compte administrateur pour la création de la clé

    Procédure

    1. Sélectionnez le module « Utilisateurs » dans le menu de gauche
    2. Sélectionnez l'utilisateur pour lequel une clé doit être créée, alternativement créer un utilisateur dédié à l’usage de la clé pour votre application.
    3. Ajoutez une nouvelle clé, assurez-vous d'entrer une adresse IP valide. L’usage de l’API est contrôlé par une liste blanche.

    Une fois générée, vous aurez une clé de 32 caractères composée d'une combinaison de lettres et de chiffres. C’est tout ce dont vous avez besoin pour initier le dialogue avec le serveur.

    api-3

    2. Créer une table de donnée à partir d’un fichier CSV

    Le téléchargement d'un jeu de données est aussi simple que de se connecter à l'API, ouvrir un flux et de le transmettre sur le serveur.

    Pré-requis

    Un document .CSV

    Exemple avec C#

    api-1

    3. Mettre à jour une table de donnée à partir d'un fichier CSV

    De la même manière que pour l'exemple de création, la mise à jour d'un jeu de données est le même processus avec une méthode différente.

    Pré-requis

    Un document .CSV

    ℹ️   Veillez à ce que le fichier CSV utilisé pour la mise à jour contienne les mêmes colonnes que le fichier CSV d'origine.

    Exemple en C#

    Dans l’exemple précédent, simplement remplacer la ligne 24 par celle-ci.

    api-2

    4. Trouver l’identificateur unique d’un jeu de données

    Pour cela, tout simplement…

    1. Accédez à votre section de données
    2. Sélectionnez le jeu de données qui vous intéresse
    3. L’identifiant unique est la valeur à droite de l'attribut « Identifiant ».

    api-portal