|
A partire da gennaio 2021, i tipi di file classici non potranno più essere utilizzati. È possibile effettuare la transizione dei file classici o scaricare un PDF. Ulteriori informazioni

Centro assistenza di Workiva

CLP - Fogli di calcolo dell'elenco delle richieste HTTP

CLP - Fogli di calcolo dell'elenco delle richieste HTTP

  • Ultimo aggiornamento

Vuoi connetterti a un'applicazione di terze parti al di là dei connettori Premium precostituiti di Workiva? Puoi ottenere questo risultato sfruttando i comandi del connettore di richiesta HTTP per interagire con le API REST. In questo Percorso Didattico Collegato, aggiorneremo la nostra Catena per utilizzare il Token del Portatore in un Comando che utilizza l'endpoint Elenco Fogli di Calcolo per ottenere un elenco di fogli di calcolo all'interno dell'area di lavoro.

Nota: Sebbene sia etichettato come Richiesta HTTP, HTTPS (Secure HTTP) è supportato (e consigliato).
Caso d'uso primario Connessione a sistemi di terze parti
Obiettivo di apprendimento primario Imparare i concetti fondamentali di Chains utilizzando il connettore di richiesta HTTP
Prerequisiti Configurare Workiva API Grant
Configurare il connettore di richiesta HTTP
CLP - Richiesta HTTP Generare un token
Modello di supporto CLP - Fogli di calcolo dell'elenco delle richieste HTTP

 

Passo 1: Creare le variabili dell'area di lavoro

Per utilizzare i dettagli dell'API di Workiva in più catene e comandi, creeremo delle variabili dello spazio di lavoro per memorizzare tali informazioni. Creeremo una nuova variabile dello spazio di lavoro per l'URL dell'API della piattaforma.

  1. Da Chain Builder, vai a Workspace Settings.
  2. In Variabili dell'area di lavoro, clicca sul segno più per creare una nuova variabile dell'area di lavoro.

  3. Configura le variabili utilizzando le seguenti informazioni:

    • Nome: wsv-BaseURL-Platform
    • Valore: In base alla tua regione, utilizza il valore appropriato. Puoi verificare la regione controllando l'URL; se l'URL contiene EU o APAC, utilizza l'URL corrispondente. Altrimenti utilizza il valore US.
    Nota: La regione USA contiene solo "app".
    Campo Valore USA
    URL base IAM https://api.app.wdesk.com/platform/v1
    Campo Valore UE
    URL base IAM https://api.eu.wdesk.com/platform/v1
    Campo Valore APAC
    URL base IAM https://api.apac.wdesk.com/platform/v1
  4. Salva Impostazioni dell'area di lavoro.
Nota: Dovresti vedere tutte e quattro queste variabili nelle Impostazioni dell'area di lavoro.  In caso contrario, rivedi i prerequisiti indicati in precedenza.

Passo 2: Copiare e modificare una catena

  1. Vai al Chain Builder e individua la catena CLP | Generate a Token.
  2. Clicca sull'ellisse verticale a destra e seleziona Copia.
  3. Una volta creata la copia della catena, clicca sull'icona della matita per modificarla.
  4. Clicca su Impostazioni della catena in alto a destra.
  5. Rinominare la catena: CLP | HTTP Request List Spreadsheets.
  6. (Opzionale) Inserisci una Descrizione: "Questa catena genera un nuovo Token di accesso all'API di Workiva. Devi fornire un ID cliente e un Segreto cliente validi, ricavati da una concessione API generata in precedenza, nei valori delle variabili sottostanti. Quindi recupera un elenco di tutti i fogli di calcolo all'interno dell'area di lavoro. L'area di lavoro deve avere almeno uno o più fogli di calcolo".
  7. Salva la catena.

Passo 3: Elenco dei fogli di calcolo

Per recuperare un elenco di fogli di calcolo, questa catena utilizza un comando GET dal connettore di richiesta HTTP.

  1. Aggiungi un comando Get dal connettore HTTP Request all'area di disegno della catena.
  2. Collega il comando Post - Retrieve a Token al comando Get.
  3. Fai doppio clic sul comando per configurarlo.
    1. Rinomina il comando: Ottieni - Elenco dei fogli di calcolo
    2. Clicca sul comando e poi sull'icona della matita associata per modificare il comando.
    3. Seleziona la casella di controllo Show Response.
    4. Clicca su URL e poi su Workspace nel pannello "Seleziona una variabile" e seleziona la variabile creata nel passaggio 1 (wsv-BaseURL-Platform).
    5. Aggiungi /spreadsheets dopo la variabile.  


      Successivamente, indicheremo all'endpoint come eseguire l'operazione, specificando Headers nel modulo Get. 
      Queste intestazioni passeranno il Bearer Token all'API per dimostrare che abbiamo accesso a un elenco di fogli di calcolo.
    6. Clicca due volte sul pulsante grigio più (+) accanto alla sezione Header e inserisci in ogni campo i valori indicati di seguito, prestando particolare attenzione alle lettere maiuscole e minuscole e allo spazio dopo "Bearer".
      • Campo intestazione 1:
        • Chiave: Accept
        • Valore: application/json
      • Campo di intestazione 2:
        • Chiave: Autorizzazione

        • Valore: Bearer <Post>
          Sostituisci <Post> con l'output del comando POST - Retrieve a Token.

          1. Nel pannello Seleziona una variabile, clicca sulla freccia in basso Runtime per espandere POST - Recupera un token
          2. Clicca sulla freccia rivolta verso il basso accanto a Response per espandere le opzioni delle variabili.
          3. Seleziona Access_token.

  4. Popola Tipo di contenuto con: application/json.

  5. Popola la risposta con il payload di esempio qui sotto. In questo modo, forniamo un formato all'output del comando, rendendo ogni variabile restituita più facile da usare.

    {"data": [ { "created": { "dateTime": "2018-10-21T15:03:27Z" }, "name": "Revisione di fine anno", "id": "124efa2a142f472ba1ceab34ed18915f", "modified": {"dateTime": "2018-10-21T15:03:27Z" }, "template": false }, { "created": { "dateTime": "2020-02-20T15:03:27Z" }, "name": "Revisione Q1", "id": "164cfb2b132c4623a2cfaa31ef13925a", "modified": {"dateTime": "2020-03-29T13:15:27Z" }, "template": false } ], "@nextLink": "<opaque_url>" }

  6. (Opzionale) Inserisci una Descrizione: "Questo comando restituisce una pagina di un elenco di fogli di calcolo. Per maggiori informazioni, consulta la documentazione per gli sviluppatori all'indirizzo https://developers.workiva.com/platform-v1/platform-getspreadsheets/".

    Suggerimento. Per determinare come popolare i campi Intestazione e Risposta, consulta la documentazione per gli sviluppatori dell'endpoint API a cui ti stai connettendo, in questo caso stiamo usando l'endpoint "Get Spreadsheets".
  7. Salva il comando.

Passo 4: Prova l'esercitazione

Ora che la Catena è completa, verifica il risultato.

  1. Pubblica la Catena.
  2. Clicca su Execute e poi su Run Chain.
  3. Una volta completata l'esecuzione della catena, dovresti vedere un elenco di fogli di calcolo nella scheda Outputs - Response Body del comando Get.

 

Per continuare a sfidare te stesso e imparare di più sull'uso del connettore HTTP Request per connetterti a un'API di terze parti, dai un'occhiata al prossimo esercizio: CLP - Richiesta HTTP per ottenere un singolo foglio di calcolo.

Vuoi connetterti a un'applicazione di terze parti al di là dei connettori Premium precostituiti di Workiva? Puoi otte...