Workiva-ondersteuningscentrum

Wilt u verbinding maken met een toepassing van derden buiten de vooraf gebouwde Premium Connectors van Workiva? U kunt dit bereiken door gebruik te maken van de HTTP Request Connector-commando's voor interactie met REST API's. In dit Aangesloten Leerpad zullen we onze ketting bijwerken om het Bearer Token te gebruiken in een opdracht die het eindpunt list Spreadsheets gebruikt om ons een lijst van spreadsheets in de werkruimte te geven.

Opmerking: Hoewel dit gelabeld is als HTTP Request, wordt HTTPS (Secure HTTP) ondersteund (en aanbevolen).

Stap 1: De werkruimtevariabelen maken

Om Workiva API details te kunnen gebruiken in meerdere Chains en Commands, maken we Workspace Variabelen aan om die informatie op te slaan. We zullen een nieuwe Workspace Variabele maken voor de Platform API URL.

1. Ga naar Chain Builder, navigeer naar Workspace Settings.
2. Klik onder Workspace Variables op het plusteken om een nieuwe Workspace Variable aan te maken.

3. Configureer de variabelen met behulp van de volgende informatie:

   • Naam: wsv-BaseURL-Platform
   • Waarde: Gebruik de juiste waarde op basis van uw regio. U kunt de regio controleren door de URL te controleren; als de URL EU of APAC bevat, gebruikt u de overeenkomstige URL. Gebruik anders de Amerikaanse waarde.

   Opmerking: regio VS bevat alleen "app".

   • Regio VS
   • EU-regio
   • APAC-regio

   Veld	Amerikaanse waarde
   IAM-basis URL	https://api.app.wdesk.com/platform/v1

   Veld	EU-waarde
   IAM-basis URL	https://api.eu.wdesk.com/platform/v1

   Veld	APAC-waarde
   IAM-basis URL	https://api.apac.wdesk.com/platform/v1

4. Opslaan Werkruimte-instellingen.

Opmerking: U zou alle vier deze variabelen moeten zien in uw Workspace Settings. Als dit niet het geval is, raadpleegt u de Prerequisites die hierboven is vermeld

Stap 2: Een ketting kopiëren en wijzigen

1. Navigeer naar Chain Builder en zoek de Chain met de naam CLP | Generate a Token.
2. Klik op de verticale ellips aan de rechterkant en selecteer Kopiëren.
3. Zodra de kettingkopie is aangemaakt, klikt u op het potloodpictogram om de ketting te bewerken.
4. Klik op Keteninstellingen rechtsboven.
5. Hernoem de ketting: CLP | HTTP Request List Spreadsheets.
6. (Optioneel) Voer een Beschrijving: "Deze Chain genereert een nieuw Workiva API Access Token. U moet een geldige Client ID en Client Secret van een eerder gegenereerde API Grant in de onderstaande variabele waarden invullen. Vervolgens wordt een lijst van alle werkbladen in de werkruimte opgehaald. Uw werkruimte moet ten minste één of meer Spreadsheets hebben."
7. Red de ketting.

Stap 3: Spreadsheets weergeven

Om een lijst van onze spreadsheets op te halen, gebruikt deze keten een GET Opdracht van de HTTP Request Connector.

4. Voeg een Get opdracht van de HTTP Request Connector toe aan het Chain canvas.
5. Verbind de opdracht Post - Haal een token op met de opdracht Haal.
6. Dubbelklik op de opdracht om deze te configureren.
   1. Hernoem de opdracht: Get - Lijst van spreadsheets
   2. Klik op de opdracht en vervolgens op het bijbehorende potloodpictogram om de opdracht te bewerken.
   3. Schakel het selectievakje Response weergeven in.
   4. Klik op URL en klik vervolgens op Werkruimte in het paneel "Een variabele selecteren" en selecteer de variabele die u in stap 1 hebt gemaakt (wsv-BaseURL-Platform).
   5. Voeg /spreadsheets toe na de variabele.
      
      
      Vervolgens zullen we het eindpunt vertellen hoe het moet worden uitgevoerd, door Headers te specificeren in het formulier Get.
      Deze Headers geven de Bearer Token door aan de API om aan te tonen dat we toegang hebben tot een lijst met spreadsheets.
   6. Klik twee keer op de grijze plusknop (+) naast de sectie Header en vul elk veld in met de onderstaande waarden, waarbij u vooral let op de hoofdletters en de spatie na "Bearer".
      • Kopregelveld 1:
        • Sleutel: Accepteren
        • Waarde: toepassing/json
      • Kopveld 2:
        • Sleutel: Autorisatie

        • Waarde: Bearer <Post - Retrieve a Token - Response>
          Vervang <Post - Retrieve a Token - Response> door de uitvoer van de opdracht POST - Retrieve a Token.

          

          1. Klik in het paneel Selecteer een variabele op de pijl Runtime om POST - Een token ophalen uit te vouwen
          2. Klik op de pijl omlaag naast Response om de variabele opties uit te breiden.
          3. Selecteer Access_token.

7. Vul Inhoudstype met: application/json.

   

8. Vul de Response met de voorbeeld payload hieronder. Door dit te doen, geven we een opmaak aan de uitvoer van het commando, waardoor elke geretourneerde variabele gemakkelijker te gebruiken is.

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

9. (Optioneel) Voer een Beschrijving: "Deze opdracht retourneert één pagina van een lijst met Spreadsheets. Raadpleeg voor meer informatie de documentatie voor ontwikkelaars op https://developers.workiva.com/platform-v1/platform-getspreadsheets/".

   Tip! Om te bepalen hoe de Header- en Response-velden moeten worden ingevuld, raadpleegt u de documentatie van de ontwikkelaar voor het API-eindpunt waarmee u verbinding maakt, in dit geval gebruiken wij het eindpunt "Get Spreadsheets".

10. Sla de opdracht op.

Stap 4: De oefening testen

Nu de Chain compleet is, kunt u het resultaat testen.

1. Publiceer de keten.
2. Klik op Execute en vervolgens op Run Chain.
3. Zodra de Chain is uitgevoerd, zou u een lijst met spreadsheets moeten zien op het tabblad Outputs - Response Body van de Get Command.

Om uzelf verder uit te dagen en meer te leren over het gebruik van de HTTP Request Connector om verbinding te maken met een API van een derde partij, kunt u de volgende oefening bekijken: CLP - HTTP Request Krijg een enkel spreadsheet.