Centro de suporte da Workiva

Você deseja se conectar a um aplicativo de terceiros além dos Premium Connectors pré-construídos da Workiva? Você pode fazer isso utilizando os comandos do conector de solicitações HTTP para interagir com as APIs REST. 

Neste Connected Learning Path, criaremos uma cadeia que se autentica em uma API de terceiros para obter um token de portador.  Embora demonstremos isso usando a API da Workiva, os princípios e o processo podem ser aplicados para que você se conecte a várias outras APIs.

Etapa 1: criar variáveis de espaço|workspace

Para que você possa usar os detalhes da API da Workiva em várias Cadeias e Comandos, criaremos variáveis de espaço de trabalho|workspace para armazenar essas informações. Criaremos três variáveis de espaço de trabalho|workspace para os seguintes dados: ID do cliente concedido pela API, segredo do cliente e URL base do IAM (gerenciamento de identidade e acesso).

1. Em Construtor de Cadeias, navegue até Configurações do espaço de trabalho/workspace.
2. Em Workspace Variables, clique no sinal de mais (+) três vezes para criar três Workspace Variables e configurá-las da seguinte forma:
   • Variável 1:
     • Nome: wsv-Workiva API Client ID
     • Valor: Insira o ID do cliente da concessão da API que você concedeu.
       Para localizar o ID do cliente, vá até o seu perfil na Workiva Platform e localize a concessão da API na guia Segurança.
       Siga estas instruções para obter mais assistência com concessões de API.
   • Variável 2:
     • Nome: wsv-Workiva API Client Secret (Segredo do cliente da API da Workiva)
     • Valor: Insira o ID do cliente da concessão da API que você concedeu.
       Para localizar o segredo do cliente, vá até o seu perfil na Workiva Platform e localize a concessão da API na guia Segurança.
       Siga estas instruções para obter mais ajuda para localizar o segredo do cliente

     • Clique no botão de bloqueio para criptografar o segredo do cliente.

       É importante manter os segredos do cliente seguros; salve o segredo do cliente em um local seguro, caso você precise acessá-lo novamente.

   • Variável 3:

     • Nome: wsv-BaseURL-IAM
     • Valor: Insira o valor abaixo com base em sua região. Você pode verificar a região verificando o URL. Se o URL contiver EU ou APAC, use o URL correspondente.

     Nota: A região dos EUA contém apenas "app".

     • Região dos EUA
     • Região da UE
     • Região da APAC

     Campo	Valor nos EUA
     URL da base do IAM	https://api.app.wdesk.com

     Campo	Valor da UE
     URL da base do IAM	https://api.eu.wdesk.com

     Campo	Valor da APAC
     URL da base do IAM	https://api.apac.wdesk.com

   • Salve as configurações do espaço de trabalho/workspace.

Etapa 2: Criar uma corrente

Para gerar o token do portador, criaremos uma nova cadeia com um comando POST; isso nos dará o token do portador de que precisamos.

1. Navegue até a guia Cadeias no Construtor de cadeias.
2. Você pode criar uma nova cadeia e nomeá-la: CLP | Generate Access Token.
3. Inclua um Description: Essa cadeia gera um novo token de acesso à API da Workiva.  Você deve fornecer uma ID de cliente e um segredo de cliente válidos de uma concessão de API gerada anteriormente nos valores variáveis abaixo.
4. Salve a Cadeia.

Etapa 3: recuperar um token

Esta cadeia usa um comando POST do conector de solicitação HTTP para recuperar nosso token de portador. Um token de portador é uma credencial de autenticação crucial necessária para acessar APIs. Uma vez obtido na Cadeia, o token pode ser usado em comandos subsequentes para fornecer autorização para você interagir com a API.

1. Adicione um comando Post do conector HTTP Request à área Start.
2. Clique duas vezes no comando para configurá-lo.
   • Renomeie o comando: POST - Retrieve a Token.
   • Marque a caixa de seleção Show response.
   • Preencha o campo URL com o URL do ponto de extremidade que você precisa acessar. Para recuperar um token para a API da Workiva, preencha o URL com o seguinte, usando a variável do espaço de trabalho|workspace para preencher o URL de base do IAM.
     1. Clique em URL e, em seguida, clique em Workspace no painel "Select a variable" e selecione a variável que você criou na etapa 1 (wsv-BaseURL-IAM).
     2. Adicione /oauth2/token após a variável.
   • No campo Content Type, insira: application/x-www-form-urlencoded.

• Use o sinal Plus para adicionar um campo Title .
  • Chave: Aceitar
  • Valor: application/json

• Use o sinal Plus para adicionar outro campo Header .
  • Chave: X-Versão
  • Valor: 2026-01-01

Diremos ao ponto de extremidade como executar usando os parâmetros postados no Post Form. Para fazer isso, clique quatro vezes no botão verde de adição ao lado da seção Form e preencha cada campo com os valores abaixo, prestando atenção especial às letras maiúsculas e minúsculas.

• Campo 1:
  • Nome: client_id
  • Valor: <wsv-Workiva>
    No painel Select a Variable, clique na seta para baixo para expandir Espaço de trabalho|workspace e selecione wsv-Workiva API Client ID.
• Campo 2:
  • Nome: client_secret
  • Valor: <wsv-Workiva>
    No painel Select a Variable, clique na seta para baixo para expandir Espaço de trabalho|workspace e selecione wsv-Workiva API Client Secret.
• Campo 3:
  • Nome: grant_type
  • Valor: client_credentials
• Campo 4:
  • Nome: escopo
  • Valor: Opcionalmente, você pode adicionar um valor aqui para especificar a quais escopos esse token deve acessar.

• Preencha a resposta com a amostra de carga útil abaixo. Ao fazer isso, estamos fornecendo uma formatação para a saída do comando, facilitando o uso de cada variável retornada.

  { "access_token": "string", "expires_in": "inteiro", "escopo": "string", "token_type": "string" }

3. (Opção) Insira uma Descrição: "Esse comando HTTP executa uma chamada postada para gerar um token de acesso necessário para autenticação em comandos HTTP subsequentes usando a API Workiva IAM. Esse comando aproveita as variáveis do espaço|workspace para armazenar o URL de base da API do Workiva IAM e o ID do cliente concedido pela API e o segredo do cliente. Mais informações podem ser encontradas aqui: https://developers.workiva.com/2026-01-01/tokenrequest.html".
4. Salve o comando.

Dica Para determinar como preencher os campos Form e Response, consulte a documentação do desenvolvedor para o ponto de extremidade da API ao qual você está se conectando. Para a API da Workiva, você pode localizar a documentação do token do portador aqui.

Etapa 4: testar o exercício

Agora que a cadeia está concluída, teste o resultado.

1. Publicar a cadeia
2. Clique em Execute e, em seguida, em Run Chain.

3. Depois que a cadeia for executada, você verá que o token de acesso foi gerado na guia Outputs - Response Body do comando Post.

   

Confira o próximo exercício da trilha de aprendizado conectada HTTP Request para saber como usar o token do portador em um comando subsequente List Spreadsheets.