Você quer se conectar a um aplicativo de terceiros além dos Premium Connectors pré-construídos da Workiva? Você pode conseguir isso aproveitando os comandos do conector de solicitação HTTP para interagir com as APIs REST. Nesta trilha de aprendizagem conectada, atualizaremos nossa cadeia para usar o token do portador em um comando que usa o ponto de extremidade list Spreadsheets para nos fornecer uma lista de planilhas no espaço de trabalho|workspace.
Observação: Embora isso seja identificado como “Solicitação HTTP”, o HTTPS (HTTP seguro) é compatível (e recomendado).
| Caso de uso primário de negócios | Conectando-se a sistemas de terceiros |
| Objetivo principal de aprendizado | Você aprenderá os conceitos básicos de Cadeias usando o conector de solicitação HTTP |
| Pré-requisitos | Configurar a autorização da API do Workiva Configurar o conector de solicitação HTTP CLP - Solicitação HTTP Gerar um token |
| Modelo de suporte | CLP - Planilhas de lista de solicitações HTTP |
Etapa 1: criar as variáveis do espaço de trabalho|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. Você criará uma nova variável de espaço de trabalho para o URL da API da plataforma.
- No Chain Builder , acesse as Configurações do Espaço de Trabalho .
- Na seção “Variáveis do espaço de trabalho ”, clique no sinal de mais para criar uma nova variável do espaço de trabalho.
-
Configure as variáveis usando as seguintes informações:
- Nome: wsv-BaseURL-Platform
- Valor: Dependendo da sua região, utilize o valor adequado. Você pode verificar a região analisando a URL; se a URL contiver “
EU” ou “APAC” , use a URL correspondente. Caso contrário, use o valor dos EUA.
Observação: a região dos EUA contém apenas “app”.
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 Campo Valor CA URL da base do IAM https://api.ca.wdesk.com - Salvar as configurações da área de trabalho .
Observação: você deve ver todas essas variáveis nas Configurações do seu Espaço de Trabalho. Caso contrário, verifique novamente os pré-requisitos mencionados acima
Etapa 2: copiar e alterar uma cadeia
- Acesse o Chain Builder e localize a cadeia chamada CLP | Gerar um token .
- Clique na elipse vertical do lado direito e selecione “Copiar ”.
- Depois que a cópia da cadeia tiver sido criada, clique no ícone de lápis para editar a cadeia.
- Clique em “Configurações da cadeia” , no canto superior direito.
- Renomear a cadeia: CLP | Planilhas da lista de solicitações HTTP .
- ( Opcional ) Insira uma descrição : “Esta cadeia gera um novo token de acesso à API do Workiva.” Você deve fornecer um Client ID e um Client Secret válidos de um API Grant gerado anteriormente nos valores variáveis abaixo. Em seguida, você obtém uma lista de todas as planilhas no espaço de trabalho|workspace. Você deve ter pelo menos uma ou mais planilhas no espaço de trabalho|workspace."
- Salvar a corrente
Etapa 3: Listar planilhas
Para recuperar uma lista das nossas planilhas, essa sequência utiliza um Comando GET do Conector de Solicitação HTTP.
- Adicione um comando “Get” do Conector de Solicitação HTTP à tela da cadeia.
- Conecte o comando “Post - Retrieve a Token ” ao comando “Get ”.
- Clique duas vezes no comando para configurá-lo.
- Renomear o comando: Get - Lista de planilhas
- Clique no comando e, em seguida, no ícone de lápis associado para editar o comando.
- Marque a caixa de seleção “Mostrar resposta ”.
- Clique em “URL” e, em seguida, clique em “Workspace” no painel “Selecionar uma variável” e selecione a variável que você criou na Etapa 1 ( wsv-BaseURL-Platform ).
- Adicione /spreadsheets após a variável. A seguir
, vamos informar ao endpoint como executar a operação, especificando os cabeçalhos no formulário GET . - Clique duas vezes no botão cinza com o sinal de mais (+) ao lado da seção “Cabeçalho” e preencha cada campo com os valores abaixo, prestando atenção especial às maiúsculas e minúsculas e ao espaço após “Bearer”.
- Campo de cabeçalho 1:
- Use o sinal de mais para adicionar um campo de cabeçalho .
- Chave: Aceitar
- Valor : application/json
- Campo de cabeçalho 2 :
- Use o sinal de mais para adicionar outro campo de cabeçalho .
- Chave: Versão X
- Valor : 01/01/2026
-
Vamos informar ao endpoint como executar a operação usando os parâmetros preenchidos no formulário de envio . 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 API Client ID>
No painel “Selecionar uma variável ”, clique na seta para baixo para expandir “Workspace ” e selecione “wsv-Workiva API Client ID ”.
- Campo 2:
- Nome: client_secret
- Valor: <wsv-Workiva API Client Secret>
No painel “Selecionar uma variável ”, clique na seta para baixo para expandir “Workspace ” e selecione “wsv-Workiva API Client Secret ”.
- Campo 3:
- Nome: grant_type
- Valor: client_credentials
- Campo 4:
- Nome: escopo
- Valor: Opcionalmente, insira um valor aqui para especificar a quais escopos esse token deve ter acesso.
- Campo 1:
- Preencha o Response com a amostra de carga útil abaixo. Ao fazer isso, estamos fornecendo uma formatação para a saída do comando, tornando cada variável retornada mais fácil de usar.
{ "access_token": "string", "expires_in": "inteiro", "escopo": "string", "token_type": "string" }-
( Opcional ) Insira uma descrição : “Este comando retorna uma página de uma lista de planilhas.” Para obter mais informações, consulte a documentação para desenvolvedores em https://developers.workiva.com/2026-01-01/getspreadsheets.html
Dica Para saber como preencher os campos “Header” e “Response”, consulte a documentação para desenvolvedores do endpoint da API ao qual você está se conectando; neste caso, estamos usando o endpoint “Get Spreadsheets ”.
- Salvar o comando
Etapa 4: testar o exercício
Agora que a cadeia está concluída, teste o resultado.
- Publique a cadeia.
- Clique em “Executar ” e, em seguida, em “Executar cadeia ”.
- Assim que a cadeia concluir sua execução, você deverá ver uma lista de planilhas na guia “Saídas” — no corpo da resposta do comando GET.
Para continuar se desafiando e aprender mais sobre como usar o Conector de Solicitação HTTP para se conectar a uma API de terceiros, confira o próximo exercício: CLP – Solicitação HTTP para obter uma única planilha .