Utilisez l\'onglet Paramètres de la demande pour ajouter divers paramètres, tels que le chemin et la requête, à vos demandes. Assurez-vous que les paramètres ajoutés correspondent à ceux utilisés dans l\'URL du point de terminaison.

Actions

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

Ajouter
Pour ajouter des paramètres à la requête.
Cliquez sur l\'icône Ajouter pour ajouter un paramètre. Le nombre de paramètres affiché dans le titre du tableau Paramètres est mis à jour automatiquement.
Modifier
Pour modifier les paramètres existants disponibles dans la demande.
Dans le tableau des paramètres, survolez l\'icône de l\'ellipse verticale du paramètre approprié, puis cliquez sur l\'icône Modifier pour éditer le Type de paramètre, la Clé, la Valeur ou le Type de valeur.
Activer/Désactiver
Pour activer ou désactiver les paramètres disponibles dans la demande. Vous pouvez désactiver un paramètre pour les scénarios suivants :
  • Lorsque la requête API utilise des valeurs par défaut.
  • Lors de l\'introduction d\'une nouvelle fonctionnalité dans le déploiement contrôlé d\'un ensemble de connecteurs.
  • Lors des tests et de l\'itération de nouvelles fonctionnalités dans un package de connecteur.
  • Lors du dépannage d\'un package de connecteur contenant des paramètres avec des erreurs.
Dans le tableau Paramètres, survolez l\'icône de l\'ellipse verticale du paramètre que vous souhaitez activer ou désactiver, puis cliquez sur le bouton Activer/Désactiver. Le statut du paramètre est mis à jour en conséquence dans le tableau Parameters. Les paramètres désactivés ne sont pas inclus dans le package de connecteur publié.
Copier
Pour reproduire les paramètres existants disponibles dans la demande.
Dans le tableau des Paramètres, survolez l\'icône de l\'ellipse verticale du paramètre approprié, puis cliquez sur l\'icône Copier pour dupliquer le paramètre sélectionné. Assurez-vous de saisir une nouvelle clé dans la fenêtre modale Copier. Tous les autres attributs du paramètre original sont copiés dans le nouveau paramètre. Une fois copié, le nouveau paramètre est activé par défaut. Si nécessaire, utilisez le bouton Activer/Désactiver pour désactiver le paramètre manuellement. Le nombre de paramètres dans le titre du tableau Paramètres est mis à jour automatiquement lorsqu\'un nouveau paramètre est créé en utilisant l\'option Copier.
Vous pouvez modifier le type de paramètre, la valeur ou le type de valeur du paramètre dupliqué dans la fenêtre modale de copie.
Supprimer
Pour supprimer les paramètres disponibles dans la requête.
Pour supprimer des paramètres, effectuez l\'une des actions suivantes :
  • Cliquez sur la case à cocher Sélectionner tout dans l\'en-tête du tableau, puis cliquez sur l\'icône Supprimer disponible au-dessus du tableau pour supprimer plusieurs paramètres.
  • Survolez le menu à points de suspension vertical de chaque paramètre, puis cliquez sur l\'icône Supprimer pour supprimer le paramètre individuellement.

Tableau de paramètres

Le titre du tableau des paramètres affiche le nombre total de paramètres de requête dans une action. Ce nombre inclut à la fois les paramètres activés et désactivés.

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

Colonne Description
Type affiche le type du paramètre. Le paramètre peut être un paramètre de requête ou un paramètre de chemin. L\'utilisateur du package ne peut pas afficher le type de paramètre dans Bot editor ou dans l\'éditeur de API Task.
Clé Affiche la clé du paramètre. L\'utilisateur du package ne peut pas afficher la clé dans Bot editor ou dans l\'éditeur de API Task. La clé est envoyée en tant que partie de l\'en-tête.
Valeur Affiche la valeur du paramètre. L\'utilisateur du package peut afficher cette valeur dans Bot editor ou API Task l\'éditeur et peut la mettre à jour.
La valeur est fournie par l\'utilisateur affiche le statut de la valeur.
  • Oui : si la valeur est fournie par l\'utilisateur. L\'utilisateur du package doit fournir une valeur appropriée lors de la configuration du paramètre dans Bot editor ou API Task éditeur.
  • Non : si la valeur est codée en dur. L\'utilisateur du package ne peut pas afficher cette valeur dans Bot editor ou API Taskéditeur. Cette valeur est envoyée en tant que partie de l\'en-tête.
Statut Affiche le statut du paramètre.
  • Activé : si le paramètre est activé.
  • Désactivé : si le paramètre est désactivé.
Étiquette Affiche l\'étiquette du paramètre pour les valeurs fournies par l\'utilisateur. L\'utilisateur du package peut afficher l\'étiquette du paramètre dans Bot editor ou API Taskéditeur.
Description Affiche la description du paramètre. L\'utilisateur du package peut afficher la description du paramètre dans Bot editor ou API Taskéditeur.

Ajouter des paramètres de demande

Pour ajouter un paramètre de requête, suivez ces étapes :

  1. Cliquez sur l\'onglet Paramètres de la requête dans le volet Configuration.
  2. Cliquez sur Ajouter un paramètre ou sur l\'icône plus (+) en haut du tableau pour ajouter un paramètre.
  3. Effectuez les actions suivantes dans la fenêtre modale Ajouter un paramètre.
    1. Type de paramètre : sélectionnez l\'une des options suivantes :
      • 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}.
    2. Clé : saisissez un nom de clé approprié. Le nom de clé n\'est pas affiché pour l\'utilisateur du package dans Bot editor ou dans l\'éditeur de API Task. Ce nom est envoyé en tant que partie de l\'en-tête.

      Vous pouvez inclure des caractères spéciaux tels que . et @ dans la clé du paramètre de requête.

    3. Sélectionnez l\'une des options suivantes dans la section La valeur sera :
      Type Description
      Codé en dur Entrez une valeur codée en dur pour le paramètre. L\'utilisateur du package ne peut pas afficher cette valeur dans Bot editor ou API Taskéditeur. Cette valeur est envoyée en tant que partie de l\'en-tête.
      Fourni par l\'utilisateur
      1. Type de valeur d\'entrée : cochez cette case si vous souhaitez sécuriser le type de valeur d\'entrée. Lorsque vous activez la case à cocher, vous pouvez entrer le paramètre via une information d\'identification, une variable ou une chaîne non sécurisée.
      2. Ce champ est-il obligatoire ? : sélectionnez Non ou Oui en fonction des exigences du paramètre.
      3. Valeur (facultatif) : saisissez une valeur. L\'utilisateur du package peut afficher cette valeur dans Bot editor ou API Taskéditeur et peut la mettre à jour.
      4. Étiquette : saisissez une étiquette pour le paramètre. L\'utilisateur du package peut afficher l\'étiquette du paramètre dans Bot editor ou API Taskéditeur.
      5. Description (Facultatif) : saisissez une description pour le paramètre. L\'utilisateur du package peut afficher la description du paramètre dans Bot editor ou API Taskéditeur. La description apparaît comme texte d\'aide dans l\'éditeur.
  4. Cliquez sur Ajouter pour ajouter le paramètre à la requête.

    Le nouveau paramètre est affiché dans le tableau des Paramètres et le nombre de paramètres dans le titre du tableau est mis à jour automatiquement.

Répétez les étapes pour ajouter d\'autres paramètres.