This article assumes previous experience with APIs.
Veuillez consulter les articles « Tables », « Opérateurs » et « Machines » pour savoir comment configurer la clé API.
Utilisez les connecteurs Tulip pour tester l’API de Tulip
Prior to r383, Service Accounts were called "API Tokens".
Découvrez comment configurer un connecteur et le mettre en place à l’aide du compte de service API que vous avez configuré (consultez cet article pour savoir comment configurer un compte de service).
Une fois votre connecteur configuré, cliquez sur « Créer une fonction ». Dans cet exemple, nous allons vous expliquer comment récupérer des enregistrements à partir d’une table.
Vous devez d’abord formuler une requête à l’aide des méthodes GET, POST, PUT, HEAD, PATCH ou DELETE, puis indiquer l’URL précise vers laquelle vous souhaitez envoyer cette requête (cliquez ici pour plus d’informations sur les fonctionnalités de notre API et ) .
If you are using a global Service Account, you need to specify the workspace. If your Service Account is workspaced scoped, it is optional.
https://(votrenomd'instancenici).tulip.co/api/v3/w/(espace de travail)/tables/(ID de la table)/records
Veillez à ajouter vos informations d’authentification (provenant du compte de service lui-même), les en-têtes de requête (si nécessaire) et les paramètres de requête (soit dans l’URL elle-même, soit dans les paramètres de requête — consultez la documentation sur la configuration des paramètres de requête pour plus d’informations).
De plus, vous pouvez spécifier toutes les entrées ou sorties dont la fonction du connecteur pourrait avoir besoin pour renvoyer des données vers une application ou un processus d’automatisation.
Utilisation de Postman pour tester l’API de Tulip
La section suivante explique comment créer un opérateur. Dans cet exemple, nous utiliserons Postman pour effectuer la création.
Commencez par ajouter votre point de terminaison API à la requête POST.
Ensuite, sous « Authorization », sélectionnez « Basic Auth » et saisissez la clé API comme nom d'utilisateur, ainsi que le secret API comme mot de passe.
Sous « En-têtes », ajoutez l’en-tête d’authentification.
Dans le corps de la requête, formatez la requête pour qu’elle prenne en charge l’objet JSON. Le format générique de cette requête est le suivant :
{"role": "operator","name": "string","badge_id": "string"}
Cela ressemblera à peu près à ceci :
Cliquez sur « Envoyer » pour lancer la requête ; vous recevrez une réponse 201 indiquant que l'opération a réussi. Pour vérifier, vous pouvez consulter votre liste d'utilisateurs dans les « Paramètres » et vous assurer que l'utilisateur a bien été créé.
Si la requête a échoué, assurez-vous que la clé et le secret sont corrects. Pour plus d’informations sur les codes de réponse spécifiques, consultez la section « Documentation de l’API » sur la page de l’API Tulip.
Utilisation de la documentation de l'API pour tester l'API de Tulip
Dans les paramètres de votre espace de travail ou de votre compte, accédez à « API Tulip ». De là, cliquez sur « En savoir plus » à côté de l’option « Créer un compte de service ».
Vous serez alors redirigé vers une page qui vous permettra de tester l’API avec la clé générée. Cette page fournit également de la documentation et des exemples de corps de requête pour diverses utilisations.
Cette page contient également l’URL du serveur nécessaire pour configurer les requêtes API depuis des systèmes externes. Pour vous familiariser avec l’API, cliquez sur le bouton « Autoriser ».
Ce bouton vous fournira des informations supplémentaires sur la configuration de l’API à des fins de test. Dans les champs, saisissez les informations suivantes :
- Nom d'utilisateur : Clé API
- Mot de passe : Secret
Cliquez sur « Autoriser » pour commencer à tester certaines requêtes HTTP courantes pour les tables.
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 de table, il est utile de connaître le format JSON approprié pour chaque colonne. Exemple de schéma pour les colonnes ci-dessous :
