Centro de suporte da Workiva

Este guia orienta você na importação de coleções da API da Workiva para o site Bruno usando as especificações da OpenAPI. Você aprenderá a configurar variáveis de ambiente globais, autenticar usando o OAuth 2.0 e validar solicitações de API de ponta a ponta.

Pré-requisitos

1. Faça o download e instale o Bruno em www.usebruno.com .

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

3. Abra Bruno. No canto superior esquerdo, clique no menu de três pontos e selecione Import Collection.

   

4. Selecione o arquivo OpenAPI V3 e escolha o arquivo .yaml baixado.

   

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

   

Etapa 2: Configurar o ambiente global

1. No canto superior direito do Bruno, clique no ícone do globo e selecione Configure.

   

2. Selecione Create Global Environment.
3. Crie as seguintes variáveis globais:
   • access_token
   • Meio ambiente
   • ID do cliente
   • ClientSecret
   • api_version

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

   

5. Salvar o meio ambiente.

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.
2. Selecione a guia Variables (Variáveis ).

3. Atualize a variável baseUrl para usar {{environment}} em vez de um domínio codificado.

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

   Atualizado:
   https://api.{{environment}}.wdesk.com

4. Defina a autorização como Bearer Token e use a variável {{access_token}}.
5. Selecione a guia Scripts.

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

   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")); 

   

7. Na coleção da API da Workiva, navegue até a pasta oauth2 e abra Retrieve a token.

8. 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); 

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

Etapa 4: Gerar um token de portador

1. No corpo da solicitação OAuth2, defina:
   • {{ClientID}}
   • {{ClientSecret}}
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 .

   

Agora você pode enviar solicitações autenticadas. Se for bem-sucedido, você verá sua lista de documentos retornada na resposta.

Etapa 5: Importar e configurar a coleção da API Wdata e Chains

1. Acesse a página Wdata Code Generation.
2. Faça o download do arquivo .yaml e importe-o para o Postman (Siga as etapas descritas em Etapa 1: Importar a coleção da API da Workiva). Observação: O nome do arquivo .yaml provavelmente será o mesmo que Workiva API Collection.
3. Na coleção Wdata :
   • Selecione a guia Variables (Variáveis ).

   • Atualize a variável baseUrl para usar {{environment}} em vez de um domínio codificado.

     Original:
     https://h.app.wdesk.com/s/wdata/oc/api

     Atualizado:
     https://h.{{environment}}.wdesk.com/s/wdata/prep

   • Defina a autorização como Bearer Token e use a variável {{access_token}}.
   • Repita as mesmas etapas acima para a coleção Chains API Collection, garantindo que as configurações de autorização e a variável baseUrl sejam configuradas da mesma forma.

Solução de problemas

• Certifique-se de que você está fazendo referência ao ambiente correto. Se a coleção tiver como padrão o ambiente No, altere-a para e especifique o Environment.
• Confirme se a variável baseUrl é consistente nas configurações do ambiente e da coleção.
• Certifique-se de definir a variável de coleção baseUrl para usar {{environment}}; caso contrário, suas solicitações poderão falhar.
• 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.