Centro de suporte da Workiva

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.

Nota: Embora esteja etiquetado como solicitação HTTP, o HTTPS (HTTP seguro) é compatível (e recomendado).

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.

1. Em Construtor de cadeias, navegue até Configurações do espaço de trabalho/workspace.
2. Em Workspace Variables, clique no sinal de mais para criar uma nova variável de espaço de trabalho.

3. Configure as variáveis usando as seguintes informações:

   • Nome: wsv-BaseURL-Platform
   • Valor: Com base em sua região, use o valor apropriado. Você pode verificar a região verificando o URL; se o URL contiver EU ou APAC, use o URL correspondente. Caso contrário, use o valor dos EUA.

   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/platform/v1

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

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

4. Salvar Configurações do espaço de trabalho|workspace.

Nota: Você deve ver todas essas quatro variáveis nas configurações do espaço de trabalho/workspace.  Se não for o caso, você deve consultar novamente os Prerequisites notados acima

Etapa 2: copiar e alterar uma cadeia

1. Navegue até o Construtor de cadeias e localize a cadeia nomeada CLP | Generate a Token.
2. Clique na elipse vertical do lado direito e selecione Copiar.
3. Depois que a cópia da cadeia tiver sido criada, clique no ícone de lápis para editar a cadeia.
4. Clique em Chain Settings no canto superior direito.
5. Você pode renomear a Cadeia: CLP | Planilhas de lista de solicitações HTTP.
6. (Opção) Insira um Descrição: "Essa cadeia gera um novo token de acesso à API da 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."
7. Salvar a corrente

Etapa 3: Listar planilhas

Para recuperar uma lista de nossas planilhas, essa cadeia usa um comando GET do conector de solicitação HTTP.

4. Adicione um comando Get do conector HTTP Request à tela Cadeias.
5. Conecte o comando Post - Retrieve a Token ao comando Get.
6. Clique duas vezes no comando para configurá-lo.
   1. Renomeie o comando: Get - List of Spreadsheets (Obter - Lista de planilhas)
   2. Clique no comando e, em seguida, no ícone de lápis associado para editar o comando.
   3. Marque a caixa de seleção Mostrar resposta.
   4. 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-Platform).
   5. Adicione /spreadsheets após a variável.  
      
      
      Em seguida, informaremos ao ponto de extremidade como executar, especificando Cabeçalhos no formulário Get. 
      Esses cabeçalhos passarão o token do portador para a API para mostrar que você tem acesso para obter uma lista de planilhas.
   6. Clique duas vezes no botão cinza de adição (+) ao lado da seção Cabeçalho e preencha cada campo com os valores abaixo, prestando atenção especial às letras maiúsculas e minúsculas e ao espaço após "Portador".
      • Campo de cabeçalho 1:
        • Chave: Aceitar
        • Valor: application/json
      • Campo de cabeçalho 2:
        • Chave: Autorização

        • Valor: Bearer <Post>
          Substitua <Post> pela saída do comando POST - Retrieve a Token.

          

          1. No painel Select a Variable, clique na seta para baixo Runtime para expandir POST - Retrieve a Token
          2. Clique na seta para baixo ao lado de Response para expandir as opções variáveis.
          3. Selecione Access_token.

7. Preencha Content type com: application/json.

   

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

   { "dados": [ { "created": { "dateTime": "2018-10-21T15:03:27Z" }, "name": "Revisão de fim de ano", "id": "124efa2a142f472ba1ceab34ed18915f", "Alterado": {"dateTime": "2018-10-21T15:03:27Z" }, "template": false }, { "created": { "dateTime": "2020-02-20T15:03:27Z" }, "name": "Revisão Q1", "id": "164cfb2b132c4623a2cfaa31ef13925a", "Alterado": {"dateTime": "2020-03-29T13:15:27Z" }, "modelo": false } ], "@nextLink": "<opaque_url>" }

9. (Opção) Insira uma Descrição: "Esse comando retorna uma página de uma lista de planilhas. Para obter mais informações, consulte a documentação do desenvolvedor em https://developers.workiva.com/platform-v1/platform-getspreadsheets/"

   Dica Para determinar como preencher os campos Cabeçalho e Resposta, consulte a documentação do desenvolvedor do ponto de extremidade da API ao qual você está se conectando. Neste caso, estamos usando o ponto de extremidade "Get Spreadsheets".

10. Salvar o comando

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. Quando a cadeia for executada, você verá uma lista de planilhas na guia Saídas - Corpo da resposta do comando Get.

Para continuar a desafiar você e saber mais sobre como usar o conector de solicitação HTTP para se conectar a uma API de terceiros, verifique o próximo exercício: CLP - Solicitação HTTP Obter uma única planilha.