Comment utiliser l'API Table
  • 04 Nov 2023
  • 5 Minutes à lire
  • Contributeurs

Comment utiliser l'API Table


Article Summary

Objectif

Configurer et utiliser l'API de Tulip pour interagir avec Tulip à partir d'autres systèmes.

Note : Article avancé.

Suppose une expérience préalable avec les API.

:::(Info) (NOTE) Article avancé : Suppose une expérience préalable avec les API :: :

Tulip interagit avec de nombreuses API d'autres systèmes via des connecteurs. Utiliser des connecteurs Une application Tulip peut initier une requête HTTP ou SQL.

Dans d'autres cas, vous pouvez vouloir permettre à un système externe d'interroger des données qui n'existent que dans Tulip. Il est possible de communiquer avec Tulip depuis des systèmes externes en utilisant l'API de Tulip. Cet article décrit la mise en place et les tests de l'API de Tulip.

L'API de Tulip est utile pour intégrer ces systèmes externes avec Tulip de plusieurs façons. L'API ne fonctionne actuellement qu'avec les tables de Tulip, ce qui peut inclure la mise à jour d'un enregistrement de table avec de nouvelles informations, la création d'une table, ou l'obtention du nombre d'enregistrements dans une table.

Ajouter une API

Naviguez jusqu'à la page Paramètres de votre compte Tulip.

Dans le menu Paramètres, sélectionnez Jetons API.

Cette page vous permet de configurer des "jetons API", qui sont des configurations API équipées d'une clé API, d'un secret et d'un en-tête d'autorisation. Pour ajouter un jeton API, cliquez sur le bouton Ajouter un jeton API en haut à droite de cette page. Une fois sélectionné, configurez le jeton API comme vous le souhaitez.

Donnez un nom au jeton API et définissez les champs d'application qu'il sera autorisé à exécuter. Dans cet exemple, le jeton API est capable de lire et d'écrire dans les tables Tulip. Les jetons API peuvent être archivés s'ils ne sont pas utilisés.

Lorsque vous cliquez sur Créer, les informations relatives à l'API vous sont communiquées. Veillez à sauvegarder ces informations, elles ne sont plus accessibles !

Ces informations peuvent maintenant être utilisées pour configurer une connexion à l'API de Tulip.

Test de l'API

Fermez la fenêtre d'information et cliquez sur le bouton API Documentation, à côté de l'option Create API Token (Créer un jeton API).

Vous accéderez ainsi à une page qui permet de tester l'API avec la clé créée. Elle fournit également de la documentation et des exemples de corps de demande pour diverses utilisations.

Cette page contient également l'URL du serveur nécessaire pour configurer les demandes d'API à partir de systèmes externes. Pour vous familiariser avec l'API, cliquez sur le bouton Autoriser.

Ce bouton donne des informations supplémentaires sur la configuration de l'API à des fins de test. Dans les champs, entrez les informations suivantes :

  • Nom d'utilisateur : Clé API
  • Mot de passe : Secret

Cliquez sur autoriser, et vous pourrez commencer à tester certaines requêtes HTTP courantes pour les tableaux.

Chacune des options de cette page peut être développée et testée. Chaque requête fournit des informations utiles sur les réponses correspondantes.

Cette page contient également des informations sur les schémas de certains composants de Tulip. Par exemple, pour créer un enregistrement dans un tableau, il est utile de connaître le formatage JSON approprié pour chaque colonne. Exemple de schéma pour les colonnes ci-dessous :

Interroger avec des filtres

Les filtres peuvent être très utiles pour extraire uniquement les données qui vous intéressent. La syntaxe de ces filtres peut parfois être un peu délicate. Les paragraphes suivants décrivent la façon dont chaque filtre est formé dans l'exemple d'une requête GET pour des enregistrements, suivi d'un exemple complet.

Lesnoms des champs personnalisés sont toujours précédés d'un identifiant à cinq chiffres. Il est plus facile de les trouver après une requête GET all pour vérifier le véritable nom du champ.

  • Ex. "field"="maytq_scrap_count"

Les valeurs desarguments sont souvent simples. S'il s'agit d'une valeur textuelle, veillez à la mettre entre guillemets.

  • Ex. "arg":15

Faites correspondre le type de fonction que vous souhaitez utiliser.

  • Ex. "functionType" : "greaterThan" (plus grand que)

Une requête complète pourrait ressembler à ceci :

https://brian.tulip.co/api/v3/tables/W2HPvyCZrjMMHTiip/records?limit=100&sortBy=\_sequenceNumber&sortDir=asc&filters=[{"field" : "maytq\_scrap\_count", "arg":15, "functionType" : "greaterThan"}]&filterAggregator=any

Filtres multiples

Dans certains cas, vous pouvez avoir plusieurs filtres à vérifier dans le tableau. Dans ce cas, vous pouvez ajouter plusieurs filtres à l'objet filters. Cela peut ressembler à ceci

filters=[{"field" : "maytq\scrap\_count", "arg":15, "functionType" : "greaterThan"},{"field" : "maytq\scrap\_reason", "arg" : "scratch", "functionType" : "equal"}]

Exemples

Les exemples suivants décrivent la procédure à suivre pour effectuer des demandes auprès de l'API Tulip. Ces exemples utilisent Postman pour effectuer les requêtes à partir de Tulip.

Obtenir les noms des tables et les informations

Cette requête Get permet au système externe de récupérer les ID et les informations sur les colonnes de toutes les tables de l'instance de Tulip. Cela peut être utile comme méthode pour trouver une table d'intérêt afin de mettre en place une requête POST.

Dans Postman, réglez l'autorisation sur Basic Auth, et entrez la clé API et le secret.

Maintenant, la requête doit être envoyée au bon endroit. Dans Tulip, trouvez la requête que vous souhaitez faire dans la documentation de l'API. Dans ce cas, la requête consiste à obtenir toutes les informations sur le tableau.

Afin d'obtenir l'URL de la requête, exécutez le bouton Execute, et vérifiez les informations de la requête.

Cette URL de requête peut alors être utilisée comme URL de serveur pour traiter la requête GET de Postman.

Appuyez sur Envoyer, et la demande renverra toutes les informations des tables.

Créer un enregistrement de tableau

À l'aide d'une requête POST et de l'identifiant de tableau trouvé ci-dessus, un enregistrement de tableau peut être créé à partir du système externe. L'autorisation et l'en-tête resteront les mêmes, mais l'URL de la requête sera légèrement différente.

Tout d'abord, déterminez la table dans laquelle vous souhaitez créer un enregistrement. L'URL de la requête suivra toujours la structure suivante :

https://.tulip.co/api/v3/tables//records

Une fois saisie, la requête aura également besoin d'un corps pour traiter correctement le POST. Le schéma des colonnes est donné ci-dessus dans la section Test, et peut être trouvé dans la documentation de l'API. La seule colonne qui est entièrement nécessaire pour que la requête aboutisse est la colonne ID. Pour toutes les autres colonnes qui ne sont pas ajoutées, elles seront stockées comme null dans l'enregistrement de la table lors de la création. Ajoutez ce contenu en tant que corps de la demande.

Lors de la soumission, Postman vérifie que l'enregistrement a été créé.


Avez-vous trouvé ce que vous cherchiez ?

Vous pouvez également vous rendre sur community.tulip.co pour poser votre question ou voir si d'autres personnes ont rencontré une question similaire !


Cet article vous a-t-il été utile ?