|
Les types de fichiers classiques ne pourront plus être utilisés à partir de janvier 2021. Vous pouvez transférer vos fichiers classiques ou télécharger un PDF. En savoir plus

Portail de support Workiva

CLP - Demande HTTP Générer un jeton d’accès

CLP - Demande HTTP Générer un jeton d’accès

  • Dernière mise à jour le
Associé à chains Http

Vous cherchez à vous connecter à une application tierce au-delà des connecteurs Premium prédéfinis de Workiva ? Pour ce faire, vous pouvez vous appuyer sur HTTP Request Connector Commands pour interagir avec les API REST. 

Dans ce parcours d’apprentissage connecté, nous allons créer une chaîne qui s’authentifie auprès d’une API tierce pour obtenir un jeton de porteur.  Bien que nous fassions la démonstration à l’aide de l’API Workiva, les principes et le processus peuvent être appliqués pour se connecter à diverses autres API.

Cas d'utilisation principal Se connecter à des systèmes tiers
Objectif d'apprentissage principal Apprendre les concepts fondamentaux de Chains et exploiter les commandes HTTP Request Connector de Workiva pour se connecter et s’authentifier à des API REST tierces.
Objectif d’apprentissage secondaire Création de variables d’espace de travail
Conditions préalables Configurer l’API Grant de Workiva
Configurer le HTTP Request Connector
Modèle de support CLP | Générer un jeton d’accès

 

Étape 1 : Créer des variables d’espace de travail

Afin d’utiliser les détails de l’API Workiva dans plusieurs chaînes et commandes, nous créerons des variables d’espace de travail pour stocker ces informations. Nous allons créer trois variables d’espace de travail pour les données suivantes : API Grant Client ID et Client Secret, et IAM (gestion de l’identité et de l’accès) Base URL.

  1. Depuis Chain Builder, naviguez jusqu’à Workspace Settings.
  2. Dans Workspace Variables, cliquez trois fois sur le signe plus (+) pour créer trois Workspace Variables et les configurer comme suit :
    • Variable 1 :
    • Variable 2 :
      • Nom : wsv-Workiva API Client Secret
      • Valeur : Saisissez l’ID client de votre subvention API.
        Pour trouver le secret du client, accédez à votre profil dans la plateforme Workiva et localisez la subvention API sous l’onglet Sécurité.
        Suivez ces instructions pour obtenir plus d’aide pour trouver votre secret client.

      • Cliquez sur le bouton de verrouillage pour crypter votre Secret de Client.

        Il est important de préserver la sécurité des secrets des clients ; sauvegardez le secret du client dans un endroit sûr au cas où vous auriez besoin d’y accéder à nouveau.

    • Variable 3 :

      • Nom : wsv-BaseURL-IAM
      • Valeur : Saisissez la valeur ci-dessous en fonction de votre région. Vous pouvez vérifier la région en consultant l’URL. Si l’URL contient EU ou APAC, utilisez l’URL correspondant.
      Note : La région des États-Unis contient uniquement « app ».
      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
    • Sauvegardez les paramètres de l’espace de travail.

Étape 2 : Créer une chaîne

Pour générer le jeton de porteur, nous allons créer une nouvelle chaîne avec une commande POST ; cela nous donnera le jeton de porteur dont nous avons besoin.

  1. Naviguez jusqu’à l’onglet Chains dans Chain Builder.
  2. Créez une nouvelle chaîne et nommez-la : CLP | Generate Access Token : CLP | Générer un jeton d’accès.
  3. Inclure 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 subvention API précédemment générée dans les valeurs variables ci-dessous.
  4. Sauvez la chaîne.

Étape 3 : Récupérer un jeton

Cette chaîne utilise une commande POST du connecteur de requêtes HTTP afin de récupérer notre jeton de porteur. Le jeton du porteur est un élément d’authentification essentiel pour l’accès aux API. Une fois obtenu au sein de la chaîne, le jeton peut être utilisé dans les commandes suivantes pour fournir l’autorisation d’interagir avec l’API.

  1. Ajoutez une commande Post du connecteur HTTP Request à la zone de démarrage.
  2. Double-cliquez sur la commande pour la configurer.
    • Renommez la commande : POST - Récupérer un jeton.
    • Cochez la case Show response.
    • Remplissez le champ URL avec l’URL du point de terminaison que vous devez atteindre. Pour récupérer un jeton pour l’API Workiva, remplissez l’URL avec ce qui suit, en utilisant la variable de l’espace de travail pour remplir l’URL de base IAM.
      1. 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-IAM).
      2. Ajoutez /oauth2/token après la variable.
    • Dans le champ Content Type, entrez : application/x-www-form-urlencoded.
  • Utilisez le signe Plus pour ajouter un champ Header .
    • Clé : valeur d’acceptation Accepter
    • Valeur : application/json
  • Utilisez le signe Plus pour ajouter un autre champ Header .
    • Clé : X-Version
    • Valeur: 2026-01-01

Nous indiquerons au point final comment s’exécuter en utilisant les paramètres introduits dans le formulaire . 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>
      Dans le panneau Select a Variable, cliquez sur la flèche vers le bas pour développer Workspace et sélectionnez wsv-Workiva API Client ID.
  • Champ 2 :
    • Nom : client_secret
    • Valeur : <wsv-Workiva>
      Dans le panneau Select a Variable, cliquez sur la flèche vers le bas pour développer Workspace et sélectionnez wsv-Workiva API Client Secret.
  • Champ 3 :
    • Nom : grant_type
    • Valeur : client_credentials
  • Champ 4 :
    • Nom : scope
    • Valeur : Ajoutez éventuellement une valeur ici pour spécifier à quels champs d’application ce jeton doit avoir accès.

  • 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 » }
  1. (Facultatif) Saisissez une Description : « Cette commande HTTP exécute un appel POST pour générer un jeton d’accès nécessaire à l’authentification dans les commandes HTTP suivantes utilisant l’API Workiva IAM. Cette commande exploite les variables de l’espace de travail pour stocker l’URL de base de l’API Workiva IAM ainsi que l’ID et le secret du client de l’API Grant. De plus amples informations sont disponibles à l'adresse suivante : https://developers.workiva.com/2026-01-01/tokenrequest.html".
  2. Enregistrez la commande.
Astuce ! Pour savoir comment remplir les champs du formulaire et de la réponse, consultez la documentation du développeur pour le point final de l’API auquel vous vous connectez. Pour l’API Workiva, vous pouvez trouver la documentation sur le Bearer Token ici.

Étape 4 : Testez l’exercice

Maintenant que la chaîne est terminée, testez le résultat.

  1. Publier la chaîne.
  2. Cliquez sur Execute puis sur Run Chain.

  3. Une fois que la chaîne a terminé son exécution, vous devriez voir que le jeton d’accès a été généré dans l’onglet Outputs - Response Body de la commande Post.

 

Consultez l’exercice suivant dans le cadre de la formation connectée sur les requêtes HTTP pour apprendre comment utiliser le jeton de support dans le cadre d’une commande ultérieure Liste des feuilles de calcul.

Vous cherchez à vous connecter à une application tierce au-delà des connecteurs Premium prédéfinis de Workiva ? Pour ...