Utilisation de variables dans le générateur de connecteurs

De nombreuses applications tierces auxquelles UiPath® peut se connecter nécessitent une certaine configuration dynamique, en particulier lors de la création du connecteur pour un public plus large. L'URL de base peut nécessiter un paramètre d'organisation, chaque appel d'API peut nécessiter une entrée qui a été renvoyée lors de l'authentification, etc.

Comme il existe plusieurs façons de résoudre ce problème, le plus simple consiste à utiliser des variables telles que {organizationId} ou responseKey pour ces types de processus.

Cette page décrit les zones du générateur de connecteurs où vous pouvez ajouter ces variables et comment procéder.

Remarque : La notation des variables utilisée dans le Générateur de connecteurs (Connector Builder) est simplement une chaîne utilisant des accolades, c'est-à-dire {myVariable}.

URL de base

L' URL de base est l'URL utilisée par défaut pour toute requête HTTP. Dans de nombreux cas, cette URL est statique pour l'application tierce et, en tant que telle, l'utilisation de variables est hors de portée. Certains fournisseurs exigent que tous les appels d'API soient ciblés sur votre instance spécifique de leur application ou qu'ils ajoutent un type d'identifiant dans le chemin de base identifiant votre identité.

Utilisons l'exemple de connexion à votre instance UiPath Orchestrator, qui nécessite les détails de l'organisation et du locataire dans l'URL de base. Il est utilisé ultérieurement comme chemin de base pour toute demande future. Lorsque les utilisateurs importent ce connecteur sur leur locataire et créent une connexion, vous pouvez leur demander ces informations en ajoutant ces paramètres en tant que variables et en les demandant sur l'écran d'authentification.

Pour ce faire, commencez par ajouter les variables dans l'URL de base avec la notation {organization} et {tenant} .

Authentification

Dans la configuration de l'authentification, les détails sont localisés dans la table qui répertorie tous les paramètres, sans tenir compte du type d'authentification. La table fournit une modification intégrée rapide ou un écran plus avancé en utilisant le menu Options supplémentaires (More options).

Dans l'exemple de l'API Orchestrator, nous voulons ajouter deux paramètres supplémentaires à la table, car nous exigeons que l'utilisateur crée une connexion pour fournir une entrée pour {organization} et {tenant}.

Lorsque vous ajoutez un nouveau paramètre d'authentification, vous devez définir le Nom (comment vous souhaitez qu'un champ spécifique s'affiche dans l'écran de connexion), sa Valeur (que vous pouvez laisser vide) et de demander au champ utilisateur , si vous souhaitez que le Paramètres requis lors de l'authentification.

Pour définir une variable pour un paramètre, sélectionnez le menu Options supplémentaires (More options).

Dans cet exemple, le paramètre Nom de l'organisation ( Organization name) , qui est demandé à l'utilisateur (Demander à l'utilisateur est défini sur Oui (Yes)), est envoyé au fournisseur sous forme d' organisation (nom) et de chemin (type).

La même chose est faite pour le locataire. Ensuite, dans l'écran d'authentification, le Nom de l'organisation ( Organization name) et le Nom du locataire ( Tenant name ) sont des champs requis, et l'organisation et le locataire font partie de l' URL de base.

Envoi de requêtes

L'utilisation de variables dans vos ressources fonctionne de la même manière. Et après l'importation de fichiers swagger, cela peut déjà être visible sur les ressources qui sont GETBYID qui prennent dans un {id} qui est alors également représenté dans la section des paramètres.

Pour Orchestrator, l'exemple suivant utilise cette variable pour {key}.