Portail de support Workiva

Arrière-plan

Les API de Workiva sont publiées au format OpenAPI (.yaml). Ces spécifications peuvent être importées directement dans des clients API tels que Bruno, ce qui vous permet de travailler avec des collections entièrement structurées sans avoir à élaborer manuellement des requêtes.

Étape 1 : Importer la collection Workiva API

1. Naviguez jusqu'à la page Workiva Platform Code Generation.
2. Téléchargez le fichier OpenAPI oas.yaml.

3. Ouvrir Bruno. Dans le coin supérieur gauche, cliquez sur l'icône + et sélectionnez Import Collection.

   

4. Cliquez sur le lien "choose file(s)" et choisissez le fichier .yaml téléchargé.

   

5. Lorsque vous y êtes invité, créez ou sélectionnez un dossier local dans lequel Bruno stockera la collection (par exemple, ../Documents/Bruno).

   Si vous le souhaitez, modifiez l'agencement de vos dossiers en remplaçant "Tags" par "Chemins" et cliquez sur Importer.

   

Étape 2 : Configuration de l'environnement global

1. Dans la section Espace de travail de Bruno, cliquez sur l'onglet Global Environments puis sur Create Environment.

   

2. Saisissez un nom pour votre environnement global, puis cliquez sur Create.

    

3. Créez les variables globales suivantes :
   • jeton d'accès
   • Identifiant du client
   • ClientSecret
   • api_version

4. Renseignez les valeurs pour ClientID, et ClientSecret. Laissez access_token vide et définissez api_version à 2026-01-01.

   

5. Sauvegarder les variables.

Étape 3 : Configurer OAuth 2.0 - Récupérer un jeton

Pour réutiliser l'authentification dans plusieurs collections, le jeton d'accès OAuth sera stocké sous la forme d'une variable d'environnement globale .

1. Sélectionnez la collection Workiva API dans l'espace de travail de Bruno.

   

2. Cliquez sur le menu déroulant Workiva dans le coin supérieur droit de l'écran Bruno et sélectionnez l'environnement/la région approprié(e) dans la liste Collection.

   

3. Cliquez sur l'onglet "Auth", sélectionnez "Bearer Token" dans la liste déroulante et définissez le champ "Token" pour utiliser la variable {{access_token}}.

   

4. Sélectionnez l'onglet Script.

5. Ajoutez le script suivant à la section Pre-request.

   Pour 2026 Platform APIs, l'en-tête X-Version est requis pour chaque demande. Ce script garantit que l'en-tête est appliqué de manière cohérente dans l'ensemble de la collection, conformément aux exigences de versionnement de l'API 2026 de Workiva. La documentation est disponible ici : https://developers.workiva.com/2026-01-01/versioning.html

   Note : Cette exigence ne s'applique actuellement qu'aux API de plate-forme.

   // Ajouter ou mettre à jour l'en-tête X-Version (Bruno) req.setHeader("X-Version", bru.getGlobalEnvVar("api_version")) ; 

   

   Cliquez sur le bouton "Enregistrer" en bas à gauche de l'espace de travail lorsque vous avez terminé.

6. Dans la collection Workiva API, naviguez jusqu'au dossier oauth2 > token et cliquez sur Retrieve a token pour l'ouvrir.

   

7. Cliquez sur l'icône ">>" sous l'Url et cliquez sur l'onglet "Script".

   

   Dans la section du script Post Response, ajoutez ce qui suit pour enregistrer le jeton globalement :

   const body = res.getBody() ; bru.setGlobalEnvVar("access_token", body.access_token) ; 

8. Enregistrez vos modifications.

Étape 3a (facultative) : Importer des API Workiva supplémentaires

Suivez la même séquence d'étapes ci-dessus pour importer d'autres API de Workiva :

wData OpenAPI oas.yaml fichier peut être téléchargé à partir de ici

Chaînes OpenAPI oas.yaml Le fichier peut être téléchargé à partir de ici

Étape 4 : Générer un jeton porteur

1. Pour le corps de la requête OAuth2, définissez les variables suivantes (si elles n'ont pas déjà été définies) :
   • {{ClientID}}
   • {{ClientSecret}}

     • Pour définir (ou vérifier) les variables, cliquez sur Workiva en haut à droite de l'espace de travail Bruno, cliquez sur l'onglet Global et choisissez "Configurer".

       

       Modifiez les variables, si nécessaire.

       

2. Envoyez la demande Retrieve a token.
3. En cas de succès, la réponse comprendra un jeton Bearer qui sera automatiquement sauvegardé en tant que variable globale .

Dépannage

• Assurez-vous que vous faites référence au bon Environment. Si la collection utilise par défaut l'environnement No, passez à l'environnement que vous avez spécifié.
• Si votre demande renvoie une réponse 401 ou vide, vérifiez à nouveau que les valeurs de l'identifiant du client, du secret du client, de la version de l'API et de l'environnement sont correctes.