Vous cherchez à vous connecter à une application tierce au-delà des connecteurs Premium prédéfinis de Workiva ? Vous pouvez y parvenir en exploitant les commandes du connecteur de requêtes HTTP pour interagir avec les API REST. Dans ce parcours pédagogique connecté, nous allons mettre à jour notre chaîne pour utiliser le jeton de support dans une commande qui utilise le point de terminaison list Spreadsheets pour nous donner une liste de feuilles de calcul dans l’espace de travail.
Remarque : bien que cette option soit intitulée « Requête HTTP », le protocole HTTPS (HTTP sécurisé) est pris en charge (et recommandé).
| Cas d'utilisation principal | Se connecter à des systèmes tiers |
| Objectif d'apprentissage principal | Apprenez les concepts fondamentaux de Chains en utilisant le HTTP Request Connector |
| Conditions préalables | Configurer l'autorisation de l'API Workiva Configurer le connecteur de requêtes HTTP CLP - Requête HTTP Générer un jeton |
| Modèle de support | CLP - HTTP Request List Spreadsheets (Feuilles de calcul des requêtes HTTP) |
Étape 1 : Créer les variables de l’espace de travail
Afin d’utiliser les détails de l’API de Workiva dans plusieurs chaînes et commandes, nous allons créer des variables d’espace de travail pour stocker ces informations. Nous allons créer une nouvelle variable d’espace de travail pour l’URL de l’API de la plate-forme.
- Dans Chain Builder , accédez aux « Paramètres de l'espace de travail ».
- Dans la section « Variables d'espace de travail », cliquez sur le signe « + » pour créer une nouvelle variable d'espace de travail.
-
Configurez les variables en utilisant les informations suivantes :
- Nom : wsv-BaseURL-Platform
- Valeur : en fonction de votre région, utilisez la valeur appropriée. Vous pouvez vérifier la région en consultant l'URL ; si celle-ci contient «
EU» ou «APAC», utilisez l'URL correspondante. Dans le cas contraire, utilisez la valeur US.
Remarque : la région « États-Unis » ne contient que l'« application ».
Champ Valeur US URL de base IAM https://api.app.wdesk.com Champ Valeur UE URL de base IAM https://api.eu.wdesk.com Champ Valeur APAC URL de base IAM https://api.apac.wdesk.com Champ Valeur CA URL de base IAM https://api.ca.wdesk.com - Enregistrer les paramètres de l'espace de travail .
Remarque : toutes ces variables devraient apparaître dans les paramètres de votre espace de travail. Si ce n'est pas le cas, revoyez les conditions préalables mentionnées ci-dessus.
Étape 2 : Copier et modifier une chaîne
- Accédez à Chain Builder et recherchez la chaîne intitulée « CLP | Générer un jeton ».
- Cliquez sur les trois points verticaux situés à droite, puis sélectionnez « Copier ».
- Une fois la copie de la chaîne créée, cliquez sur l’icône en forme de crayon pour modifier la chaîne.
- Cliquez sur « Paramètres de la chaîne » en haut à droite.
- Renommer la chaîne : CLP | Fiches de calcul de la liste des requêtes HTTP .
- ( Facultatif ) Saisissez une description : « Cette chaîne génère un nouveau jeton d'accès à l'API Workiva. » Vous devez fournir un ID client et un secret client valides provenant d’une API Grant précédemment générée dans les valeurs de variables ci-dessous. Il récupère ensuite une liste de toutes les feuilles de calcul de l’espace de travail. Votre Espace de travail doit comporter au moins une ou plusieurs feuilles de calcul. »
- Sauvez la chaîne.
Étape 3 : Lister les feuilles de calcul
Pour récupérer la liste de nos feuilles de calcul, cette chaîne utilise un Commande GET à partir du connecteur de requêtes HTTP.
- Ajoutez une commande « Get » provenant du connecteur de requête HTTP au canevas de la chaîne.
- Reliez la commande « Post - Récupérer un jeton » à la commande « Get ».
- Double-cliquez sur la commande pour la configurer.
- Renommer la commande : Get - Liste des feuilles de calcul
- Cliquez sur la commande, puis sur l’icône représentant un crayon pour modifier la commande.
- Cochez la case « Afficher la réponse ».
- Cliquez sur « URL » , puis sur « Workspace » dans le panneau « Sélectionner une variable », et sélectionnez la variable que vous avez créée à l'étape 1 ( wsv-BaseURL-Platform ).
- Ajoutez /spreadsheets après la variable. Nous
allons ensuite indiquer au point de terminaison comment s'exécuter, en spécifiant les en-têtes dans le formulaire GET . - Cliquez deux fois sur le bouton gris « + » situé à côté de la section « En-tête » et renseignez chaque champ avec les valeurs ci-dessous, en veillant tout particulièrement à respecter la casse et à ne pas oublier l'espace après « Bearer ».
- Champ d’en-tête 1 :
- Utilisez le signe « + » pour ajouter un champ d'en-tête .
- Légende : Accepter
- Valeur : application/json
- Champ d'en-tête 2 :
- Utilisez le signe « + » pour ajouter un autre champ d'en-tête .
- Clé : Version X
- Valeur : 01/01/2026
-
Nous allons indiquer au point de terminaison comment s'exécuter à l'aide des paramètres renseignés dans le formulaire de publication . Pour ce faire, cliquez 4 fois sur le bouton vert plus à côté de la section Formulaire et remplissez chaque champ avec les valeurs ci-dessous, en respectant les majuscules et les minuscules.
-
- Champ 1 :
- Nom : client_id
- Valeur : <wsv-Workiva API Client ID>
Dans le panneau « Sélectionner une variable », cliquez sur la flèche vers le bas pour développer « Espace de travail », puis sélectionnez « wsv-Workiva API Client ID ».
- Champ 2 :
- Nom : client_secret
- Valeur : <wsv-Workiva API Client Secret>
Dans le panneau « Sélectionner une variable », cliquez sur la flèche vers le bas pour développer « Espace de travail », puis sélectionnez « wsv-Workiva API Client Secret ».
- Champ 3 :
- Nom : grant_type
- Valeur : client_credentials
- Champ 4 :
- Nom : scope
- Valeur : vous pouvez, si vous le souhaitez, ajouter ici une valeur pour préciser les périmètres auxquels ce jeton doit avoir accès.
- Champ 1 :
- Remplissez la réponse avec l’exemple de charge utile ci-dessous. En procédant ainsi, nous donnons un format à la sortie de la commande, ce qui facilite l’utilisation de chaque variable renvoyée.
{"access_token » : « string », « expires_in » : « integer », « scope » : « string », « token_type » : « string » }-
( Facultatif ) Saisissez une description : « Cette commande renvoie une page d'une liste de feuilles de calcul. » Pour plus d'informations, consultez la documentation destinée aux développeurs à l'adresse https://developers.workiva.com/2026-01-01/getspreadsheets.html
Astuce ! Pour savoir comment remplir les champs « Header » et « Response », consultez la documentation destinée aux développeurs relative au point de terminaison de l'API auquel vous vous connectez ; dans le cas présent, nous utilisons le point de terminaison « Get Spreadsheets ».
- Sauvegarder la commande.
Étape 4 : Testez l’exercice
Maintenant que la chaîne est terminée, testez le résultat.
- Publier la chaîne.
- Cliquez sur « Exécuter », puis sur « Exécuter la chaîne ».
- Une fois que la chaîne a terminé son exécution, vous devriez voir apparaître une liste de feuilles de calcul dans l'onglet « Outputs » (Résultats) — corps de la réponse de la commande GET.
Pour continuer à vous mettre au défi et en savoir plus sur l'utilisation du connecteur de requête HTTP pour vous connecter à une API tierce, passez à l'exercice suivant : CLP - Requête HTTP : récupérer une seule feuille de calcul .