Paramètres de la demande

La section Paramètres de la demande permet d'ajouter divers paramètres, tels que le chemin et la requête de vos demandes. Assurez-vous que ces paramètres correspondent à ceux utilisés dans l'URL du point de terminaison.

Actions

Les actions de paramètre de demande suivantes sont activées :

Ajouter
Cliquez sur cette option pour ajouter un paramètre.
Modifier
Passez la souris sur l'icône des trois points du paramètre que vous souhaitez modifier et cliquez sur l'icône Modifier.
Supprimer
Permet de supprimer les paramètres sélectionnés.

Tableau de paramètres

Affichez les détails des paramètres suivants dans le tableau.

Élément du tableau Description
Type Indique si le paramètre est un paramètre de requête ou un paramètre de type. Le type de paramètre n'est pas affiché pour l'utilisateur du package dans Éditeur de robots ou dans l'éditeur de API de tâche.
La valeur est fournie par l'utilisateur Indique si la valeur est fournie par l'utilisateur.
  • Affiche Oui si la valeur est fournie par l'utilisateur. L'utilisateur du package devra fournir une valeur appropriée lors de la configuration de ce paramètre dans Éditeur de robots ou dans l'éditeur de API de tâche.
  • Affiche Non si la valeur est codée en dur. L'utilisateur du package ne pourra pas afficher cette valeur dans Éditeur de robots ou dans l'éditeur de API de tâche. Cette valeur est envoyée en tant que partie de l'en-tête.
Clé Indique le nom de clé. Le nom de clé n'est pas affiché pour l'utilisateur du package dans Éditeur de robots ou dans l'éditeur de API de tâche. Ce nom est envoyé en tant que partie de l'en-tête.
Valeur Affiche la valeur du paramètre. L'utilisateur du package pourra afficher cette valeur dans Éditeur de robots ou dans l'éditeur de API de tâche et peut la mettre à jour.
Étiquette Affiche l'étiquette du paramètre. L'utilisateur du package pourra afficher cette étiquette pour le paramètre dans Éditeur de robots ou dans l'éditeur de API de tâche.
Description Affiche la description du paramètre. L'utilisateur du package pourra afficher cette description pour le paramètre dans Éditeur de robots ou dans l'éditeur de API de tâche.

Ajouter des paramètres de demande

  1. Cliquez sur l'onglet Paramètres de la demande.
  2. Cliquez sur Ajouter un paramètre ou sur l'icône plus (+) en haut du tableau pour ajouter un paramètre.
  3. Dans la fenêtre Ajouter un paramètre, sélectionnez l'un des types de paramètres suivants :
    • Requête : Ces paramètres sont ajoutés au chemin de l'URL après le caractère ?. Par exemple : /accounts?user_account=company.
    • Chemin : Ces paramètres sont directement ajoutés au chemin de l'URL. Par exemple : /accounts/{user_account}.
  4. Dans le champ Clé, saisissez un nom de clé approprié. Le nom de clé n'est pas affiché pour l'utilisateur du package dans Éditeur de robots ou dans l'éditeur de API de tâche. Ce nom est envoyé en tant que partie de l'en-tête.
  5. Sélectionnez l'une des options suivantes :
    Codé en dur Saisissez une valeur codée en dur pour le paramètre. L'utilisateur du package ne pourra pas afficher cette valeur dans Éditeur de robots ou dans l'éditeur de API de tâche. Cette valeur est envoyée en tant que partie de l'en-tête.
    Fourni par l'utilisateur
    1. Indiquez si ce champ est obligatoire.
    2. Saisissez une valeur. L'utilisateur du package pourra afficher cette valeur dans Éditeur de robots ou dans l'éditeur de API de tâche et peut la mettre à jour.
    3. Saisissez une étiquette. L'utilisateur du package pourra afficher cette étiquette pour le paramètre dans Éditeur de robots ou dans l'éditeur de API de tâche.
    4. Saisissez une description. L'utilisateur du package pourra afficher cette description pour le paramètre dans Éditeur de robots ou dans l'éditeur de API de tâche.