Créer votre premier connecteur

Cette section explique comment créer un connecteur à l'aide de Connector Builder et l'utiliser dans une automatisation. L'exemple couvre la création d'un connecteur via un processus manuel, de sorte que nous abordons automatiquement les points qui peuvent sinon généralement être ignorés.

Le workflow que nous concevons est destiné à recevoir quotidiennement des messages Slack concernant le cours des actions qui vous intéressent. Polygon.io fournit un ensemble d'API gratuites qui récupère des informations de stock et peut être utilisé à nos fins. Ils ont un processus d'inscription rapide qui, en retour, nous fournit une clé API pour effectuer les appels API nécessaires.

Remarque :

Vous pouvez également consulter la section Créer votre connecteur à partir d'une définition d'API (Building your connector from an API definition) . Cela explique comment importer une définition Swagger et laisser Connector Builder terminer la majeure partie du travail pour vous.

S’inscrire avec Polygon.io

La plupart des applications des fournisseurs nécessitent des détails d'authentification sous la forme d'un nom d'utilisateur et d'un mot de passe, d'une application OAuth, d'une clé API, etc. Polygon.io n'est pas différent. Il propose une inscription gratuite pour essayer certaines de leurs API.

1. Accédez à polygone.io et créez un compte.
2. Ouvrez votre tableau de bord et sélectionnez Clés API (API Keys) pour afficher votre clé.

Créer un connecteur dans le générateur de connecteurs

Within Automation Suite, navigate to Integration Service and select Build your connector.

Commençons par un connecteur vierge. Si vous avez une définition d'API à portée de main (Swagger, YAML, etc.), vous pouvez sélectionner Commencer à partir de la définition d'API ( Start from API definition ) et laisser Générateur de connecteurs (Connector Builder) effectuer la plus grande partie du travail de configuration à votre place.

1. Téléchargez l'icône polygon.svg depuis le Web pour ajouter son logo à votre catalogue.
   Remarque :

   Tous les types d'images sont pris en charge, mais nous vous recommandons d'utiliser un fichier SVG carré.

2. Ajoutez un nom et une description pour votre connecteur personnalisé, puis sélectionnez Créer(Create).

Configurer l'authentification et se connecter

La documentation de démarrage de Polygone indique que tout appel API à leur plate-forme vous oblige à envoyer votre clé API dans les en-têtes ou en tant que paramètre de requête. Pour ce faire, vous devez l'ajouter aux en-têtes, comme expliqué dans l'exemple suivant :

1. Transmettez votre clé API dans la chaîne de requête comme suit, où <your_token> est la clé API :

   https://api.polygon.io/v2/aggs/ticker/AAPL/range/1/day/2023-01-09/2023-01-09?apiKey=<your_token>

2. Vous pouvez également ajouter un en-tête d'autorisation à la requête avec votre clé API comme jeton, sous la forme suivante, où <your_token> est la clé API :

   Authorization: Bearer <your_token>

3. Dans Générateur de connecteurs (Connector Builder), accédez à Paramètres (Settings) et sélectionnez l'onglet API de base (Base API) . Définissez l' URL de base ( Base URL) sur https://api.polygon.io.
   Remarque : dans cet exemple, nous n'ajoutons pas la section version "v2" à l' URL de base. Cela nous permet d’exécuter certains des anciens appels d’API de stock.
   
   

   

   
   
4. Ensuite, accédez à l'onglet Authentification (Authentication) pour sélectionner le type d'authentification préféré dans la liste déroulante. Pour cet exemple, sélectionnons Jeton d' accès personnel (PAT) (Personal Access Token (PAT)).
   Remarque :

   La documentation de Polygon fait référence à une clé API, mais étant donné qu'elle doit être envoyée comme autorisation : porteur <your_token>, elle est en fait plus proche d'un jeton de style OAuth. Par conséquent, le jeton d'accès personnel (PAT) est techniquement la meilleure définition. En savoir plus sur les différents types d'authentification.

5. Copiez votre clé API à partir de Polygon et définissez la Valeur (Value) sur : Bearer <your_key>.
6. Définissez le champ Demander à l'utilisateur ( Ask the user ) sur Non ( No), afin que les utilisateurs ne soient pas invités à fournir leur clé lors de la création d'une connexion à ce connecteur. En effet, nous n'allons pas partager ce connecteur au-delà de notre locataire. Si, toutefois, vous souhaitez partager le connecteur au-delà du locataire, n'ajoutez pas votre propre clé. Configurez Demander à l'utilisateur ( Ask the user ) sur Oui(Yes) pour que les autres utilisateurs soient invités à s'abonner eux-mêmes au service Polygon.

   Les types d'authentification préconfigurés dans Générateur de connecteurs (Connector Builder) prennent en charge la majeure partie du travail à votre place. Par exemple, le jeton d'accès personnel envoie automatiquement Autorisation : Porteur <your_token> comme en-tête d'authentification, plutôt que d'avoir à créer cette configuration vous-même.

   
   

   

   
   
7. Définissez une connexion avec la configuration ci-dessus en sélectionnant le bouton Non connecté (Not connected) > Ajouter une connexion (Add connection). Notez qu'il fonctionne déjà comme n'importe quel autre connecteur Integration Service. Sélectionnez Connecter ( Connect) pour disposer d'une connexion de test vers laquelle effectuer des appels API.

Testez vos appels API

Après avoir établi une connexion avec le logiciel tiers, nous passons à l'exécution des appels d'API réels.

1. Accédez au panneau de gauche pour API (API) > Créer un nouveau groupe de ressources (Create new resource group). L'objectif est d'obtenir une notification Slack quotidienne sur le cours d'ouverture d'une action donnée. Le point de terminaison que nous allons mettre en œuvre maintenant est l' API d'ouverture/fermeture quotidienne de Polygon.
   
   

   

   
   
2. Dans la fenêtre Créer un nouveau groupe de ressources (Create new resource group ), copiez les informations de point de terminaison des documents Polygon.
3. Définissez le chemin d'accès sur /open-close/{stocksTicker}/{date}.
4. Dans la liste Sélectionner des méthodes (Select methods), activez Obtenir l'enregistrement (GETBYID), puisque nous sélectionnons un seul objet, plutôt qu'un tableau d'objets.
5. Indiquez un nom d'affichage, tel que Ouvrir - Fermer pour le stock (Open - Close for stock). Le générateur de connecteurs convertira automatiquement les variables {x} en variables de chemin d’accès.
6. Sélectionnez Créer (Create) pour ajouter cette ressource.
   
   

   

   
   
   

   

   
   
7. Pour tester si la configuration fonctionne, sélectionnez le bouton Envoyer une demande (Send request) à côté de votre ressource. Cela crée des valeurs pour les deux paramètres de chemin. Nous pouvons les reprendre à partir de l'exemple d'utilisation dans la documentation de Polygon.
   
   

   

   
   

Publier le connecteur dans le catalogue

Vous pouvez effectuer quelques étapes supplémentaires pour améliorer l’apparence et le comportement des ressources et des paramètres. Par exemple, identifiez que le paramètre Date est de type DateTime et fournissez le masque comme exemple. Le fait de fournir des noms complets permet à votre connecteur d'être mieux affiché dans l'activité Studio. Vous pouvez voir un exemple dans la capture d'écran suivante

Lors de la dernière étape, sélectionnez Publier ( Publish ) pour publier votre connecteur sur votre locataire. Le connecteur apparaît dans la liste des connecteurs présentés sur votre locataire, et toute personne qui utilise le même locataire peut voir et utiliser le connecteur Polygon.

Pour plus d'informations, consultez la section Publier votre connecteur (Publishing your connector) détaillée.

Utiliser le connecteur dans UiPath Studio

Faire apparaître un connecteur dans Integration Service n'est pertinent que si vous pouvez réellement l'utiliser dans un workflow.

Pour tester votre connecteur personnalisé dans un workflow :

1. Ouvrez UiPath Studio et créez un projet. Par exemple, le cours quotidien des actions Slack. Puisque nous voulons recevoir des messages quotidiennement, la première activité utilisée dans ce workflow est un Déclencheur temporel ( Time Trigger).
   
   

   

   
   
2. Ensuite, lorsque vous faites glisser une activité Polygone vers la zone de dessin, vous êtes invité à vous connecter à Polygon.io avec votre compte.
3. Une fois la connexion établie, configurez l'activité Polygon pour récupérer les informations sur les actions Apple (AAPL). Vous pouvez coder en dur le stock qui vous intéresse, mais vous devez formater la date pour qu'elle soit la date du runtime.
4. Ensuite, ajoutez une activité Slack Envoyer un message au canal (Slack Send Message to Channel ) pour envoyer ces informations à un canal. Si vous souhaitez vous envoyer les informations à vous-même, utilisez Envoyer un message à l'utilisateur (Send Message to User).

Remarque : l'API de Polygon ne prend en compte qu'un seul stock à la fois, mais vous pouvez configurer Studio pour effectuer plusieurs appels via le connecteur et également notifier le prix quotidien à l'ouverture des actions (PATH) d'UiPath.

Votre flux doit ressembler à ceci :