CLP - HTTP Request List Spreadsheets (Feuilles de calcul des requêtes HTTP) – Centre d’assistance

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.

Note : Bien qu’il s’agisse d’une requête HTTP, le protocole HTTPS (Secure HTTP) 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	Configurez la subvention API de Workiva Configurez le connecteur de requête 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.

Depuis Chain Builder, naviguez jusqu’à Workspace Settings.
Sous Workspace Variables, cliquez sur le signe plus 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 contrôlant l’URL ; si l’URL contient EU ou APAC, utilisez l’URL correspondante. Dans le cas contraire, utilisez la valeur US.
Remarque : La région des États-Unis contient uniquement « app ».
Champ Valeur US

URL de base IAM https://api.app.wdesk.com/platform/v1

Champ Valeur UE

URL de base IAM https://api.eu.wdesk.com/platform/v1

Champ Valeur APAC

URL de base IAM https://api.apac.wdesk.com/platform/v1
Enregistrer Paramètres de l’espace de travail.

Note : Vous devriez voir ces quatre variables dans les paramètres de votre espace de travail. Si ce n’est pas le cas, consultez à nouveau le document Prerequisites mentionné ci-dessus.

Étape 2 : Copier et modifier une chaîne

Naviguez vers Chain Builder et localisez la chaîne nommée CLP | Generate a Token.
Cliquez sur l’ellipse verticale sur le côté droit et sélectionnez Copiez.
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 Chain Settings en haut à droite.
Renommez la chaîne : CLP | HTTP Request List Spreadsheets.
(Optional) Entrez une Description : « Cette chaîne génère un nouveau jeton d’accès à l’API de 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 une liste de nos feuilles de calcul, cette chaîne utilise une commande GET du connecteur de requête HTTP.

Ajoutez une commande Get du connecteur HTTP Request au canevas Chain.
Connectez la commande Post - Retrieve a Token à la commande Get.
Double-cliquez sur la commande pour la configurer.
1. Renommez la commande : Obtenir - Liste des feuilles de calcul
2. Cliquez sur la commande, puis sur l’icône représentant un crayon pour modifier la commande.
3. Cochez la case Show Response.
4. Cliquez sur URL puis sur Workspace dans le panneau « Select a variable », et sélectionnez la variable que vous avez créée à l’étape 1 (wsv-BaseURL-Platform).
5. Ajoutez /spreadsheets après la variable.
  
  Nous indiquerons ensuite au point de terminaison comment s’exécuter, en spécifiant Headers dans le formulaire Get.
  Ces en-têtes transmettront le jeton Bearer à l’API pour montrer que nous avons accès à une liste de feuilles de calcul.
6. Cliquez deux fois sur le bouton gris plus (+) à côté de la section Header et remplissez chaque champ avec les valeurs ci-dessous, en faisant particulièrement attention à la casse et à l’espace après « Bearer ».
  - Champ d’en-tête 1 :
    - Clé : Accept Accept
    - Valeur : application/json
  - Champ d’en-tête 2 :
    - Clé : Autorisation
    - Value : Bearer <Post>
      Remplacez <Post> par le résultat de la commande POST - Retrieve a Token.
      1. Dans le panneau Select a Variable, cliquez sur la flèche vers le bas Runtime pour développer POST - Retrieve a Token.
      2. Cliquez sur la flèche vers le bas à côté de Response pour développer les options de la variable.
      3. Sélectionnez Access_token.
Remplissez Content type avec : application/json.

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.

{"data » : [ { { « created » : { « dateTime » : « 2018-10-21T15 :03 :27Z » }, « name » : « Examen de fin d’année », « id » : « 124efa2a142f472ba1ceab34ed18915f », « modified » : {"dateTime » : « 2018-10-21T15 :03 :27Z » }, « template » : false }, { « created » : { « dateTime » : « 2020-02-20T15 :03 :27Z » }, « name » : « Q1 Review », « id » : « 164cfb2b132c4623a2cfaa31ef13925a », « modified » : {"dateTime » : « 2020-03-29T13 :15 :27Z » }, « template » : false } ], « @nextLink » : « <opaque_url> » }

(Facultatif) Entrez une Description : « Cette commande renvoie une page d’une liste de feuilles de calcul. Pour plus d’informations, consultez la documentation du développeur à l’adresse https ://developers.workiva.com/platform-v1/platform-getspreadsheets/ »

Astuce ! Pour déterminer comment remplir les champs Header et Response, consultez la documentation du développeur pour le point de terminaison de l’API auquel vous vous connectez, dans ce cas 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 Execute puis sur Run Chain.
Une fois que la chaîne a terminé son exécution, vous devriez voir une liste de feuilles de calcul dans l’onglet Outputs - Response Body de la commande Get.

Pour continuer à vous dépasser et en savoir plus sur l’utilisation du connecteur de requêtes HTTP pour vous connecter à une API tierce, consultez l’exercice suivant : CLP - Demande HTTP Obtenir une seule feuille de calcul.

Support

Communauté

Portail de support Workiva