Configuration de la requête

Configuration de la requête d'une vérification API

Qu'est-ce que la configuration de la requête ?

La configuration de la requête est l'endroit où vous définissez les détails du endpoint d'API que vous voulez tester. Cela comprend l'URL, la méthode HTTP et tous les paramètres ou en-têtes supplémentaires nécessaires à la requête.

Configurer la requête

1. URL du endpoint : Définissez l'URL du endpoint d'API à tester. C'est l'adresse à laquelle la vérification enverra les requêtes.
2. Méthodes HTTP : Choisissez parmi les méthodes HTTP autorisées suivantes selon ce que votre endpoint prend en charge :

• GET : Récupérer des données du serveur.
• POST : Envoyer des données au serveur pour créer ou mettre à jour une ressource.
• PUT : Mettre à jour une ressource existante sur le serveur.
• PATCH : Mettre à jour partiellement une ressource existante sur le serveur.
• DELETE : Supprimer une ressource du serveur.

Configurations supplémentaires de la requête

Vous pouvez personnaliser davantage votre vérification API avec les options suivantes :

• Paramètres de requête (onglet Paramètres, Ajouter un Paramètre de Requête) : Ajoutez des paires clé/valeur pour transmettre des données supplémentaires par l'URL. Le champ URL et la liste restent synchronisés : une paire que vous ajoutez apparaît dans l'URL, et un paramètre que vous saisissez dans l'URL apparaît dans la liste.

  • Exemple : https://api.example.com/resource?key1=value1&key2=value2

• En-têtes (onglet En-têtes, Ajouter un En-tête) : Ajoutez des en-têtes personnalisés à votre requête. Les en-têtes servent à envoyer des métadonnées et à contrôler le traitement de la requête.

  • Exemple : Content-Type: application/json

• Corps POST (onglet Corps) : Choisissez un type de corps (none, JSON, form-data, GraphQL ou raw) et saisissez le corps. C'est utile pour envoyer des données qui créent ou mettent à jour des ressources.

  • Exemple : {"name": "example", "value": "data"}

• Authentification de base (onglet Authentification, Configurer l'Authentification de Base) : Saisissez un nom d'utilisateur et un mot de passe. Cela sert à authentifier la requête auprès du serveur.

  • Exemple : Username: user, Password: pass

• Ignorer SSL (onglet Paramètres) : Option pour ignorer la vérification SSL. Cela peut servir pour tester des endpoints avec des certificats auto-signés.

• Suivre les redirections (onglet Paramètres) : Option pour suivre les redirections HTTP. Ainsi la vérification suit toutes les réponses de redirection du serveur.

Importer depuis cURL

Au lieu de remplir la requête à la main, vous pouvez coller une commande cURL. Cliquez sur Importer depuis cURL, juste sous le champ de l'URL, collez la commande (par exemple copiée depuis les outils de développement de votre navigateur avec « Copier en cURL » ou depuis la documentation de votre API) et cliquez sur Importer. LoadFocus remplit l'URL, la méthode HTTP, les paramètres de requête, les en-têtes, le corps (JSON, encodé en URL ou brut, avec son en-tête Content-Type) et l'authentification basique issue de -u, et active Ignorer SSL pour -k et Suivre les redirections pour -L. Une commande avec un corps mais sans méthode est importée en POST, comme curl l'enverrait.

Rien n'est enregistré tant que vous ne cliquez pas sur Enregistrer : le panneau affiche « Requête importée. Vérifiez les en-têtes et le corps ci-dessous avant d'enregistrer. » pour que vous puissiez d'abord contrôler le résultat.

Certains éléments sont signalés au lieu d'être importés : les champs de formulaire multipart (-F), les corps lus depuis un fichier (@file), les options que la vérification ne peut pas représenter (l'import se termine quand même et le panneau liste chacune d'elles), une deuxième URL (seule la première est utilisée) et un en-tête sans deux-points ou avec un saut de ligne. Seules les URL http et https peuvent être importées, et une commande est limitée à 100 Ko.

Cas d'utilisation pratiques

• Tester des requêtes GET : Vérifiez que votre API récupère correctement les données.
• Tester des requêtes POST : Assurez-vous que votre API gère la création ou la mise à jour de données.
• Utiliser des en-têtes pour l'authentification : Transmettez des jetons d'authentification dans les en-têtes pour accéder à des ressources protégées.
• Envoyer des paramètres de requête complexes : Testez la façon dont votre API gère les requêtes complexes.

En configurant ces paramètres, vous pouvez adapter vos vérifications API aux exigences exactes de votre endpoint, pour des tests et une surveillance complets.