Test unitaire de l’API Tulip

Objectif

Cet article résume la structure et la conception de l’API Tulip.

À quoi sert le test unitaire de l’API Tulip ?

Il permet de tester certaines des fonctions les plus fréquemment utilisées de l’API Tulip. Fonctions incluses dans l’application :

• Lister les tables Tulip
• Lister les enregistrements d'une table Tulip
• Créer un enregistrement dans une table Tulip
• Compter les enregistrements d’une table Tulip
• Supprimer un enregistrement d'une table Tulip
• Mettre à jour un enregistrement d'une table Tulip
• Supprimer tous les enregistrements d'une table Tulip
• Signer des URL

Table utilisée dans le test unitaire

Pour tester les fonctions de l'API Tulip Table, l'utilisateur a besoin d'une table de test, à savoir la table d'exemple de l'API Tulip.

Structure de l'application

Un menu est disponible à gauche de chaque étape.

Dans les étapes « Introduction » et « Configurer la connexion », l’utilisateur peut découvrir l’objectif de l’application et trouver des instructions sur la manière de configurer la connexion entre le connecteur de l’API Tulip et son instance.

Si les espaces de travail ne sont pas activés sur votre instance, accédez à Paramètres du compte > API Tulip pour générer votre compte de service. Dans ce cas, vous n’avez pas besoin de référencer /w/DEFAULT dans votre point de terminaison API ; par exemple, pour récupérer des tables, votre point de terminaison sera : URL de base + api/v3/tables

Si la fonctionnalité « Workspaces » est activée et que vous utilisez un compte de service API global (accessible via Paramètres du compte > API Tulip), vous devrez définir l’espace de travail dans votre point de terminaison API ; ainsi, pour récupérer des tables, votre point de terminaison sera -URL de base + api/v3/w/<workspaceID>/tables. Pour en savoir plus, consultez cette page : https://support.tulip.co/apidocs/introduction#workspaces

Si vous avez activé les espaces de travail et que vous utilisez un compte de service limité à un espace de travail (accessible sous « Paramètres de l’espace de travail » > « API Tulip »), vous n’avez pas besoin de définir l’espace de travail dans votre point de terminaison API. Ainsi, pour récupérer les tables, votre point de terminaison sera : -URL de base + api/v3/tables

À l’étape « Récupérer les tables », la fonction du connecteur s’exécute lorsque l’utilisateur clique sur le bouton « Récupérer les tables » afin de répertorier toutes les tables de l’instance. L’utilisateur peut sélectionner une table dans le tableau interactif situé à gauche et consulter ses détails à droite.

Dans l’étape « Créer un enregistrement », l’utilisateur peut créer un nouvel enregistrement en remplissant les champs de saisie. Lorsque l’utilisateur clique sur le bouton « Créer un enregistrement » et que tous les champs sont remplis, le nouvel enregistrement s’affiche dans le tableau interactif situé à droite.

Dans l’étape « Récupérer les enregistrements », les enregistrements du tableau « Tulip API Sample » s’affichent lorsque l’on clique sur le bouton « Récupérer les enregistrements ». L’utilisateur peut sélectionner un enregistrement dans le tableau interactif situé à gauche et consulter ses détails à droite.

Dans l’étape « Compter les enregistrements », la fonction du connecteur s’exécute lorsque l’on clique sur le bouton, et le nombre d’enregistrements s’affiche à droite.

Dans l’étape « Mettre à jour un enregistrement », l’utilisateur peut sélectionner l’ID de l’enregistrement à mettre à jour et remplir les champs de saisie à modifier. Dès qu’il clique sur le bouton « Mettre à jour l’enregistrement », l’enregistrement mis à jour s’affiche à droite.

Dans l'étape « Supprimer un enregistrement », l'utilisateur doit sélectionner un enregistrement dans le tableau interactif situé à gauche. Lorsqu'il clique sur le bouton « Supprimer l'enregistrement », l'enregistrement est supprimé du tableau d'exemple.

À l’étape « Supprimer tous les enregistrements », lorsque l’utilisateur clique sur le bouton « Supprimer tous les enregistrements », tous les enregistrements sont supprimés du tableau d’exemple.

Dans l'étape « Signer une URL », l'utilisateur peut saisir une URL et la signer. Une fois l'URL signée, celle-ci s'affiche dans le volet de droite.