L'action Appeler une API envoie une requête HTTP POST à un service externe, avec ou sans authentification.
Elle transmet des données de TimeTonic à un outil d'automatisation externe, une base de données ou un service de notification.
Prérequis : l'URL du webhook du service externe et la méthode POST. Un jeton ou des identifiants si l'appel est sécurisé (Bearer token ou Basic). Les champs de votre table qui fournissent les valeurs à envoyer.
Elle envoie une requête HTTP à un service externe dès que votre scénario d'automatisation atteint l'action. Voici les cas d'usage les plus courants.
Déclencher un scénario externe
Une ligne créée ou modifiée lance un scénario dans un outil d'automatisation externe.
Créer une ligne ailleurs
L'appel crée une ligne dans un autre espace de travail ou un autre outil.
Transmettre un prospect validé
Les informations partent vers une base de gestion commerciale.
Mettre à jour une base externe
Les données saisies dans TimeTonic alimentent une base de données externe.
Envoyer une notification
Un message ou une alerte part vers un utilisateur final.
2. Comment ajouter l'action à une automatisation ?
Ouvrez l'automatisation de votre table, insérez votre déclencheur et vos conditions, puis ajoutez l'action.
1
Ajoutez l'action
Cliquez sur le bouton action +.
2
Sélectionnez Appeler une API
Choisissez Appeler une API dans la liste des actions.
3. Que contient la fenêtre de configuration ?
La fenêtre Appeler une API compte trois zones : l'URL, l'authentification et le contenu envoyé.
1. Insertion de l'URL
Collez l'URL du webhook fournie par l'outil externe.
2. Authentification
Choisissez Sans authentification, Bearer token ou Basic authentification.
3. Le contenu du webhook
Définissez les propriétés et les valeurs à envoyer.
4. Comment choisir l'authentification de l'appel ?
Sans authentification, l'appel n'est pas sécurisé. Avec un Bearer token ou un couple nom et mot de passe, le service externe vérifie l'appel avant de l'accepter. Les valeurs saisies dans TimeTonic doivent être identiques côté outil externe.
4.1 Sans authentification
N'utilisez aucune méthode d'authentification : l'appel n'est pas sécurisé.
Dans TimeTonic
Valeur
Méthode
POST
URL
Collez l'URL du webhook de l'outil externe.
Dans l'outil externe
Valeur
Méthode
POST
URL de l'API
L'URL du webhook créé
Authentification
Aucune
Cette vidéo montre un appel vers un outil d'automatisation externe, sans authentification.
4.2 Bearer token
Créez un jeton d'accès pour protéger l'appel. Le même jeton est saisi dans TimeTonic et dans l'outil externe.
Dans TimeTonic
Valeur
Méthode
POST
URL
Collez l'URL du webhook de l'outil externe.
Authentification
Sélectionnez Utiliser Bearer token
Entrer un jeton d'accès
[définir un jeton d'accès]
Dans l'outil externe
Valeur
Méthode
POST
URL de l'API
L'URL du webhook créé
Authentification
Sélectionnez Bearer Auth
Nom d'en-tête
Authorization
Valeur de l'en-tête attendue
Bearer 123456 Remplacez 123456 par le jeton défini dans TimeTonic.
Cette vidéo montre le mode Bearer qui sécurise l'appel HTTP.
4.3 Basic authentification
Sécurisez l'appel avec un couple nom d'utilisateur et mot de passe. Les deux valeurs sont identiques dans TimeTonic et dans l'outil externe.
Dans TimeTonic
Valeur
Méthode
POST
URL de l'API
Collez l'URL du webhook de l'outil externe.
Authentification
Sélectionnez Authentification basic
Nom
[définir le nom]
Mot de passe
[définir le mot de passe]
Dans l'outil externe
Valeur
Méthode
POST
URL de l'API
L'URL du webhook créé
Authentification
Sélectionnez Basic Auth
Nom
[identique à celui de TimeTonic]
Mot de passe
[identique à celui de TimeTonic]
Cette vidéo montre la connexion à l'API avec un identifiant et un mot de passe.
5. Comment définir les données à envoyer ?
Dans la dernière partie de la fenêtre, vous choisissez les données transmises à l'API. Chaque ligne ajoutée représente une paire clé / valeur.
Élément
Description
Nom de la propriété
Le nom de la propriété JSON attendue par l'API. Exemple : test call.
Valeur
Une valeur fixe, comme "Toto" ou "OK", ou une variable dynamique, comme $ChampInput. Une variable envoie la valeur d'un champ de la ligne TimeTonic : description, nom, date.
Exemple : vous envoyez la valeur du champ Description d'une ligne dans une propriété JSON nommée test call. Vous saisissez ceci :
TimeTonic génère alors le JSON suivant :
{
"test call": Contenu du champ "Description" de la ligne TimeTonic
}
Ajoutez une ligne avec le bouton + si l'API attend plusieurs champs.
6. Comment valider et tester l'appel ?
1
Validez
Cliquez sur Valider, puis activez l'automatisation.
2
Testez
Modifiez ou créez une ligne pour déclencher l'appel API.
3
Vérifiez
Contrôlez dans l'outil externe que l'appel API est bien reçu.
7. Pour aller plus loin
Aller plus loin
Déclencheur : Webhook entrant
Recevez des appels externes pour créer ou mettre à jour des lignes.