Centro de suporte da Workiva

Histórico

As APIs da Workiva são publicadas no formato OpenAPI (.yaml). Essas especificações podem ser importadas diretamente para clientes de API como o Bruno, permitindo que você trabalhe com coleções totalmente estruturadas sem criar solicitações manualmente.

Etapa 1: Importar a coleção da API da Workiva

1. Navegue até a página Workiva Platform Code Generation.
2. Faça o download do arquivo OpenAPI oas.yaml.

3. Abra Bruno. No canto superior esquerdo, clique no ícone + e selecione Import Collection.

   

4. Clique no link "choose file(s)" e escolha o arquivo .yaml baixado.

   

5. Quando solicitado, crie ou selecione uma pasta local onde o Bruno armazenará a coleção (por exemplo, ../Documents/Bruno).

   Opcionalmente, altere a organização da pasta de "Tags" para "Paths" e clique em Import.

   

Etapa 2: Configurar o ambiente global

1. Na seção Workspace do Bruno, clique na guia Global Environments e, em seguida, clique em Create Environment.

   

2. Digite um nome para seu Ambiente Global e clique em Create.

    

3. Crie as seguintes variáveis globais:
   • access_token
   • ID do cliente
   • ClientSecret
   • api_version

4. Preencha os valores de ClientID e ClientSecret. Deixe access_token em branco e defina api_version para 2026-01-01.

   

5. Salve as variáveis.

Etapa 3: Configurar o OAuth 2.0 - Recuperar um token

Para reutilizar a autenticação em várias coleções, o token de acesso OAuth será armazenado como uma variável de ambiente global .

1. Selecione a coleção Workiva API na área Workspace do Bruno.

   

2. Clique no menu suspenso Workiva no canto superior direito da tela Bruno e selecione o Ambiente/região apropriado na lista Collection (Coleção).

   

3. Clique na guia "Auth", selecione "Bearer Token" no menu suspenso e defina o campo "Token" para usar a variável {{access_token}}.

   

4. Selecione a guia Script.

5. Adicione o seguinte script à seção Pre-request.

   Para as APIs da plataforma 2026, o cabeçalho X-Version é necessário em todas as solicitações. Esse script garante que o cabeçalho seja aplicado de forma consistente em toda a coleção, de acordo com os requisitos de controle de versão da API 2026 da Workiva. A documentação pode ser encontrada aqui: https://developers.workiva.com/2026-01-01/versioning.html

   Observação: Atualmente, esse requisito se aplica apenas às APIs da plataforma.

   // Adicionar ou atualizar o cabeçalho X-Version (Bruno) req.setHeader("X-Version", bru.getGlobalEnvVar("api_version")); 

   

   Quando terminar, clique no botão "Save" (Salvar) na parte inferior esquerda da área do espaço de trabalho.

6. Na coleção da API da Workiva, navegue até a pasta oauth2 > token e clique em Retrieve a token para abrir.

   

7. Clique no ícone ">>" abaixo do URL e clique na guia "Script".

   

   Na seção de script Post Response, adicione o seguinte para salvar o token globalmente:

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

8. Salve as alterações que você fez.

Etapa 3a (opcional): Importar APIs adicionais da Workiva

Siga a mesma sequência de etapas acima para importar APIs adicionais da Workiva:

wData OpenAPI oas.yaml arquivo pode ser baixado de aqui

Cadeias OpenAPI oas.yaml arquivo pode ser baixado de aqui

Etapa 4: Gerar um token de portador

1. Para o corpo da solicitação OAuth2, defina as seguintes variáveis (se ainda não tiverem sido definidas):
   • {{ClientID}}
   • {{ClientSecret}}

     • Para definir (ou verificar) as variáveis, clique em Workiva no canto superior direito do espaço de trabalho do Bruno, clique na guia Global e escolha "Configure" (Configurar).

       

       Edite as variáveis, conforme necessário.

       

2. Envie a solicitação Retrieve a token.
3. Se for bem-sucedida, a resposta incluirá um token de portador e ele será salvo automaticamente como uma variável global .

Solução de problemas

• Certifique-se de que esteja fazendo referência ao Environment correto. Se a coleção tiver como padrão o ambiente No, altere-o para o ambiente especificado.
• Se sua solicitação retornar uma resposta 401 ou em branco, verifique novamente se os valores de Client ID, Client Secret, API_version e Environment estão corretos.