CLP - HTTP-verzoeklijst spreadsheets – Supportcentrum

Wilt u verbinding maken met een applicatie van derden die geen gebruikmaakt van de vooraf gebouwde Premium Connectors van Workiva? Dit kunt u bereiken door gebruik te maken van de HTTP Request Connector Commands om te communiceren met REST API's. In dit Connected Learning Path gaan we onze Chain bijwerken om het Bearer Token te gebruiken in een Command dat het endpoint list Spreadsheets gebruikt om ons een lijst met spreadsheets binnen de Workspace te geven.

Opmerking: Hoewel dit is gelabeld als HTTP-verzoek, wordt HTTPS (beveiligde HTTP) ondersteund (en aanbevolen).

Belangrijkste zakelijke toepassing	Verbinding maken met systemen van derden
Hoofdleerdoel	Leer de basisprincipes van Chains met behulp van de HTTP Request Connector.
Voorwaarden	Configureer Workiva API Grant Configureer HTTP Request Connector CLP - HTTP Request Genereer een token
Ondersteunend sjabloon	CLP - HTTP-verzoeklijst spreadsheets

Stap 1: Werkruimtevariabelen aanmaken

Om Workiva API-gegevens in meerdere ketens en commando's te kunnen gebruiken, maken we werkruimtevariabelen aan om die informatie op te slaan. We gaan een nieuwe werkruimtevariabele aanmaken voor de URL van de platform-API.

Ga vanuit Chain Builder naar Werkruimte-instellingen .
Klik onder Werkruimtevariabelen op het plusteken om een nieuwe werkruimtevariabele aan te maken.
Configureer de variabelen met behulp van de volgende informatie:
- Naam: wsv-BaseURL-Platform
- Waarde: Gebruik de juiste waarde op basis van uw regio. Je kunt de regio controleren aan de hand van de URL; als de URL EU of APAC bevat, gebruik dan de bijbehorende URL. Gebruik anders de Amerikaanse waarde.
Let op: de regio VS bevat alleen "app".
- VS-regio
- EU-regio
- APAC-regio
- CA-regio
Veld Amerikaanse waarde

IAM-basis-URL https://api.app.wdesk.com

Veld EU-waarde

IAM-basis-URL https://api.eu.wdesk.com

Veld APAC-waarde

IAM-basis-URL https://api.apac.wdesk.com

Veld CA-waarde

IAM-basis-URL https://api.ca.wdesk.com
Werkruimte-instellingen opslaan.

Let op: je zou al deze variabelen in je werkruimte-instellingen moeten zien. Zo niet, bekijk dan de hierboven vermelde voorwaarden nog eens.

Stap 2: Een keten kopiëren en aanpassen

Ga naar Chain Builder en zoek de blockchain met de naam CLP | Genereer een token .
Klik op de verticale ellips aan de rechterkant en selecteer Kopiëren .
Zodra de kettingkopie is gemaakt, klikt u op het potloodpictogram om de ketting te bewerken.
Klik rechtsboven op Kettinginstellingen .
Hernoem de keten: CLP | HTTP-verzoeklijst spreadsheets .
( Optioneel ) Voer een beschrijving in: "Deze keten genereert een nieuw Workiva API-toegangstoken." U dient een geldige Client ID en Client Secret uit een eerder gegenereerde API Grant in de onderstaande variabelewaarden op te geven. Vervolgens wordt een lijst opgehaald van alle spreadsheets binnen de werkruimte. Je werkruimte moet minimaal één spreadsheet bevatten.
Red de ketting.

Stap 3: Lijst met spreadsheets

Om een lijst van onze spreadsheets op te halen, gebruikt deze keten een GET -opdracht vanuit de HTTP-aanvraagconnector.

Voeg een Get -opdracht van de HTTP Request Connector toe aan het Chain-canvas.
Koppel de Post - Retrieve a Token Command aan de Get Command.
Dubbelklik op de opdracht om deze te configureren.
1. Hernoem de opdracht: Get - Lijst met spreadsheets
2. Klik op de opdracht en vervolgens op het bijbehorende potloodpictogram om de opdracht te bewerken.
3. Vink het selectievakje 'Reactie weergeven' aan.
4. Klik op URL en vervolgens op Werkruimte in het paneel "Selecteer een variabele" en selecteer de variabele die je in stap 1 hebt gemaakt ( wsv-BaseURL-Platform ).
5. Voeg /spreadsheets toe na de variabele. Vervolgens vertellen we
  
  het eindpunt hoe het moet worden uitgevoerd door Headers in de Get -vorm te specificeren.
6. Klik twee keer op de grijze plus (+) knop naast het koptekstgedeelte en vul elk veld in met de onderstaande waarden. Let daarbij goed op de hoofdletters en kleine letters en de spatie na "Bearer".
  - Koptekstveld 1:
  - Gebruik het plusteken om een koptekstveld toe te voegen.
    - Sleutel: Accepteren
    - Waarde : applicatie/json
  - Koptekstveld 2 :
  - Gebruik het plusteken om een extra koptekstveld toe te voegen.
    - Legenda: X-versie
    - Waarde : 2026-01-01
  - We zullen het eindpunt vertellen hoe het moet worden uitgevoerd met behulp van parameters die in het POST-formulier zijn ingevuld. Klik hiervoor vier keer op de groene plusknop naast het gedeelte 'Formulier' en vul elk veld in met de onderstaande waarden, waarbij u goed let op het hoofdlettergebruik.
  - - Veld 1:
      - Naam: client_id
      - Waarde: <wsv-Workiva API Client ID>
        Klik in het paneel 'Een variabele selecteren ' op de pijl naar beneden om 'Werkruimte' uit te vouwen en selecteer 'wsv-Workiva API Client ID' .
    - Veld 2:
      - Naam: client_secret
      - Waarde: <wsv-Workiva API Client Secret>
        Klik in het paneel 'Een variabele selecteren ' op de pijl naar beneden om 'Werkruimte' uit te vouwen en selecteer 'wsv-Workiva API Client Secret' .
    - Veld 3:
      - Naam: grant_type
      - Waarde: client_credentials
    - Veld 4:
      - Naam: bereik
      - Waarde: Voeg hier optioneel een waarde toe om aan te geven tot welke scopes dit token toegang moet hebben.
Vul het antwoordveld in met de onderstaande voorbeeldgegevens. Hiermee geven we een structuur aan de uitvoer van het commando, waardoor elke geretourneerde variabele gemakkelijker te gebruiken is.

{ "access_token": "tekenreeks", "expires_in": "geheel getal", "scope": "tekenreeks", "token_type": "tekenreeks" }

( Optioneel ) Voer een beschrijving in: "Deze opdracht geeft één pagina met een lijst van spreadsheets weer." Voor meer informatie kunt u de ontwikkelaarsdocumentatie raadplegen op https://developers.workiva.com/2026-01-01/getspreadsheets.html

Tip! Om te bepalen hoe u de velden Header en Response moet invullen, raadpleegt u de ontwikkelaarsdocumentatie voor het API-eindpunt waarmee u verbinding maakt. In dit geval gebruiken we het eindpunt " Get Spreadsheets ".
Sla de opdracht op.

Stap 4: Test de oefening

Nu de keten compleet is, test het resultaat.

Publiceer de keten.
Klik op Uitvoeren en vervolgens op Keten uitvoeren .
Zodra de Chain zijn uitvoering heeft voltooid, ziet u een lijst met spreadsheets in het tabblad Uitvoer - Reactiebody van de Get-opdracht.

Om jezelf 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, kun je de volgende oefening bekijken: CLP - HTTP Request Get a Single Spreadsheet .

Workiva-ondersteuningscentrum