Requête HTTP
La requête HTTP est une automatisation qui permet d'intégrer un système à un autre système. Il s'agit d'une fonctionnalité intéressante à utiliser si vous souhaitez intégrer FieldPro à un système externe, c'est-à-dire à des systèmes ERP tiers disposant d'une API. Grâce à la méta-expression, vous pouvez réutiliser le résultat de la requête dans un autre travail.
La requête HTTP est une tâche située dans la section Workflow, Job de l'application Web, comme indiqué ci-dessous :
Dans la section Job, cliquez sur le bouton Créer en haut à droite de l'écran de l'application web et cliquez sur Requête HTTP pour créer le job.
Les requêtes HTTP sont stockées dans la table des requêtes http.
Sur la page de création, un objet requête http a les attributs suivants :
Nom : Définissez ici un nom convivial qui s'applique au job.
Url : Indiquez ici l'url de la demande d'API.
Method : peut être Get, Post, Patch, Put ou Delete en fonction des actions que vous souhaitez que le job effectue.
GET - Récupérer
La méthode GET est utilisée pour récupérer des données à partir d'une ressource spécifiée.
Elle est principalement utilisée pour lire ou récupérer des informations sur un serveur.
Exemple : Récupérer des informations sur le profil d'un utilisateur en envoyant une demande GET à "/users/{userID}".
POST - Créer
La méthode POST est utilisée pour soumettre et envoyer des données à traiter à une ressource spécifiée.
Elle est souvent utilisée pour créer une nouvelle ressource sur le serveur.
Exemple : Création d'un nouvel utilisateur en envoyant une requête POST à "/users" avec les données de l'utilisateur dans le corps de la requête.
PUT & PATCH - Modification
PUT et PATCH sont utilisés pour mettre à jour une ressource sur le serveur, mais ils diffèrent dans leur approche.
PUT : Généralement utilisé pour mettre à jour ou remplacer une ressource entière à une URL spécifique.
Exemple : Mise à jour du profil d'un utilisateur en envoyant une requête PUT à "/users/{userID}" avec les données actualisées de l'utilisateur.
PATCH : Utilisé pour appliquer des modifications ou des mises à jour partielles à une ressource.
Exemple : Mise à jour de l'adresse électronique d'un utilisateur en envoyant une requête PATCH à "/users/{userID}" avec les données modifiées.
DELETE - Supprimer
Utilisé pour demander la suppression d'une ressource.
Corps : le corps doit être au format JSON comme indiqué ci-dessous
{
"key1": "value1",
"key2": "value2",
"key3": {
"nestedKey1": "nestedValue1",
"nestedKey2": "nestedValue2"
},
"key4": ["arrayValue1", "arrayValue2"]
}
Assurez-vous que votre JSON est valide et qu'il suit la structure appropriée aux exigences de votre API.
Requête : est le tableau de paires clé-valeur à ajouter comme requête à la requête http.
En-têtes : un tableau de paires clé-valeur à ajouter en tant qu'en-tête de la requête http.
Une fois que vous avez rempli tous les champs nécessaires, cliquez sur "sauvegarde" pour enregistrer la demande http..
Allez ensuite dans le workflow et créez un workflow pour exécuter la tâche de requête HTTP qui a été créée, comme indiqué ci-dessous.
Dans les paramètres du workflow, donnez un nom au workflow pour le différencier de ceux qui existent déjà. Une fois terminé, enregistrez.
Localisez le workflow que vous venez de créer, naviguez jusqu'à l'icône de modification, cliquez pour modifier et ajoutez les étapes ; Http job, timer et start workflow comme indiqué ci-dessous.
Dans l'étape Timer, ajoutez la fréquence à laquelle vous voulez que le job Http soit exécuté dans la section des valeurs relatives et absolues, une fois que vous avez terminé, enregistrez les changements.
Cliquez sur l'étape de démarrage du workflow et sélectionnez le nom du workflow comme indiqué, puis enregistrez les modifications.
Une fois cette opération effectuée, enregistrez le workflow modifié et accédez à la page des paramètres du même workflow.
Faites défiler jusqu'à la partie inférieure de la page des paramètres du workflow, activez l'option Exécuter le workflow à la création et enregistrez les modifications afin de créer la boucle du job http comme indiqué ci-dessous.
Vous devriez recevoir la notification conformément à ce qui a été défini, c'est-à-dire recevoir des notifications sur Slack toutes les 24 heures.
L'URL utilisée dans l'exemple est modifiée pour des raisons de sécurité. Mais vous pouvez utiliser une requête HTTP avec n'importe quel point de terminaison.
La requête HTTP est une tâche située dans la section Workflow, Job de l'application Web, comme indiqué ci-dessous :
Comment configurer
Dans la section Job, cliquez sur le bouton Créer en haut à droite de l'écran de l'application web et cliquez sur Requête HTTP pour créer le job.
Les requêtes HTTP sont stockées dans la table des requêtes http.
Sur la page de création, un objet requête http a les attributs suivants :
Nom : Définissez ici un nom convivial qui s'applique au job.
Url : Indiquez ici l'url de la demande d'API.
Method : peut être Get, Post, Patch, Put ou Delete en fonction des actions que vous souhaitez que le job effectue.
GET - Récupérer
La méthode GET est utilisée pour récupérer des données à partir d'une ressource spécifiée.
Elle est principalement utilisée pour lire ou récupérer des informations sur un serveur.
Exemple : Récupérer des informations sur le profil d'un utilisateur en envoyant une demande GET à "/users/{userID}".
POST - Créer
La méthode POST est utilisée pour soumettre et envoyer des données à traiter à une ressource spécifiée.
Elle est souvent utilisée pour créer une nouvelle ressource sur le serveur.
Exemple : Création d'un nouvel utilisateur en envoyant une requête POST à "/users" avec les données de l'utilisateur dans le corps de la requête.
PUT & PATCH - Modification
PUT et PATCH sont utilisés pour mettre à jour une ressource sur le serveur, mais ils diffèrent dans leur approche.
PUT : Généralement utilisé pour mettre à jour ou remplacer une ressource entière à une URL spécifique.
Exemple : Mise à jour du profil d'un utilisateur en envoyant une requête PUT à "/users/{userID}" avec les données actualisées de l'utilisateur.
PATCH : Utilisé pour appliquer des modifications ou des mises à jour partielles à une ressource.
Exemple : Mise à jour de l'adresse électronique d'un utilisateur en envoyant une requête PATCH à "/users/{userID}" avec les données modifiées.
DELETE - Supprimer
Utilisé pour demander la suppression d'une ressource.
Corps : le corps doit être au format JSON comme indiqué ci-dessous
{
"key1": "value1",
"key2": "value2",
"key3": {
"nestedKey1": "nestedValue1",
"nestedKey2": "nestedValue2"
},
"key4": ["arrayValue1", "arrayValue2"]
}
Assurez-vous que votre JSON est valide et qu'il suit la structure appropriée aux exigences de votre API.
Requête : est le tableau de paires clé-valeur à ajouter comme requête à la requête http.
En-têtes : un tableau de paires clé-valeur à ajouter en tant qu'en-tête de la requête http.
Une fois que vous avez rempli tous les champs nécessaires, cliquez sur "sauvegarde" pour enregistrer la demande http..
Allez ensuite dans le workflow et créez un workflow pour exécuter la tâche de requête HTTP qui a été créée, comme indiqué ci-dessous.
Dans les paramètres du workflow, donnez un nom au workflow pour le différencier de ceux qui existent déjà. Une fois terminé, enregistrez.
Localisez le workflow que vous venez de créer, naviguez jusqu'à l'icône de modification, cliquez pour modifier et ajoutez les étapes ; Http job, timer et start workflow comme indiqué ci-dessous.
Dans l'étape Timer, ajoutez la fréquence à laquelle vous voulez que le job Http soit exécuté dans la section des valeurs relatives et absolues, une fois que vous avez terminé, enregistrez les changements.
Cliquez sur l'étape de démarrage du workflow et sélectionnez le nom du workflow comme indiqué, puis enregistrez les modifications.
Une fois cette opération effectuée, enregistrez le workflow modifié et accédez à la page des paramètres du même workflow.
Faites défiler jusqu'à la partie inférieure de la page des paramètres du workflow, activez l'option Exécuter le workflow à la création et enregistrez les modifications afin de créer la boucle du job http comme indiqué ci-dessous.
Vous devriez recevoir la notification conformément à ce qui a été défini, c'est-à-dire recevoir des notifications sur Slack toutes les 24 heures.
L'URL utilisée dans l'exemple est modifiée pour des raisons de sécurité. Mais vous pouvez utiliser une requête HTTP avec n'importe quel point de terminaison.
Mis à jour le : 20/01/2024
Merci !