Importation des collections Workiva API dans Bruno pour Windows

Ce guide vous aide à importer des collections Workiva API dans Bruno à l'aide des spécifications OpenAPI. Vous apprendrez à configurer les variables d'environnement globales, à vous authentifier à l'aide d'OAuth 2.0 et à valider les demandes d'API de bout en bout.

Conditions préalables

Téléchargez et installez Bruno à partir de www.usebruno.com .

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

Naviguez jusqu'à la page Workiva Platform Code Generation .
Téléchargez le fichier OpenAPI .yaml.
Ouvrir Bruno. Dans le coin supérieur gauche, cliquez sur le menu à trois points et sélectionnez Import Collection.
Sélectionnez le fichier OpenAPI V3 et choisissez le fichier .yaml que vous avez téléchargé.
Lorsque vous y êtes invité, créez ou sélectionnez un dossier local dans lequel Bruno stockera la collection (par exemple, Bruno Collections).

Étape 2 : Configuration de l'environnement global

Dans le coin supérieur droit de Bruno, cliquez sur l'icône Globe et sélectionnez Configure.
Choisissez Create Global Environment.
Créez les variables globales suivantes :
- jeton d'accès
- Environnement
- Identifiant du client
- ClientSecret
- api_version
Renseignez les valeurs pour Environment, ClientID, et ClientSecret. Laissez access_token vide et définissez api_version à 2026-01-01.
Préserver l'environnement.

É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 .

Sélectionnez la collection Workiva API.
Sélectionnez l’onglet Variables.
Mettez à jour la variable baseUrl pour utiliser {{environment}} au lieu d’un domaine codé en dur.

Original :
https://api.app.wdesk.com

Mise à jour :
https://api.{{environnement}}.wdesk.com
Réglez l'autorisation sur le jeton porteur et utilisez la variable {{access_token}}.
Sélectionnez l'onglet Scripts.
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.

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")) ; 
```
Dans la collection Workiva API, naviguez jusqu'au dossier oauth2 et ouvrez Retrieve a token.
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) ; 
```
Enregistrez vos modifications.

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

Dans le corps de la requête OAuth2, définir :
- {{ClientID}}
- {{ClientSecret}}
Envoyez la demande Retrieve a token.
En cas de succès, la réponse comprendra un jeton Bearer qui sera automatiquement sauvegardé en tant que variable globale .

Vous pouvez maintenant envoyer des demandes authentifiées. En cas de succès, vous verrez votre liste de documents renvoyée dans la réponse.

Étape 5 : Importer et configurer la collection d'API Wdata et Chains

Allez à la page Wdata Code Generation.
Téléchargez le fichier .yaml et importez-le dans Postman (Suivez les étapes décrites dans Step 1 : Import the Workiva API Collection). Remarque : Le nom de fichier .yaml sera probablement le même que celui de Workiva API Collection.
Dans la collection Wdata :
- Sélectionnez l’onglet Variables.
- Mettez à jour la variable baseUrl pour utiliser {{environment}} au lieu d’un domaine codé en dur.
  
  Original :
  https://h.app.wdesk.com/s/wdata/oc/api
  
  Mise à jour :
  https://h.{{environnement}}.wdesk.com/s/wdata/prep
- Réglez l'autorisation sur le jeton porteur et utilisez la variable {{access_token}}.
- Répétez les mêmes étapes ci-dessus pour la collection Chains API Collection, en vous assurant que les paramètres d'autorisation et la variable baseUrl sont configurés de la même manière.

Dépannage

Assurez-vous de référencer le bon environnement Environnement. Si la collection est définie par défaut sur son environnement No, passez à l’environnement que vous avez spécifié.
Confirmez que la variable baseUrl est cohérente dans les paramètres de votre environnement et de votre collection.
Assurez-vous que la variable de collection baseUrl utilise {{environment}} ; dans le cas contraire, vos requêtes risquent d’échouer.
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.

Support

Communauté

Portail de support Workiva