|
Klassieke bestandstypen zijn vanaf januari 2021 niet meer beschikbaar voor gebruik. U kunt uw klassieke bestanden omzetten of een PDF downloaden. Meer informatie

Workiva-ondersteuningscentrum

CLP - HTTP-verzoek om toegangstoken te genereren

CLP - HTTP-verzoek om toegangstoken te genereren

  • Laatst bijgewerkt op
Gerelateerd aan chains Http

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 creëren we een blockchain die authenticatie uitvoert met een API van een derde partij om een ​​bearer-token te verkrijgen. Hoewel we dit zullen demonstreren met behulp van de Workiva API, kunnen de principes en het proces worden toegepast om verbinding te maken met diverse andere API's.

Belangrijkste zakelijke toepassing Verbinding maken met systemen van derden
Hoofdleerdoel Leer de basisprincipes van Chains en gebruik de HTTP Request Connector Commands van Workiva om verbinding te maken met REST API's van derden en je daarbij te authenticeren.
Leerdoel voor het voortgezet onderwijs Werkruimtevariabelen aanmaken
Voorwaarden Configureer Workiva API Grant
Configureer HTTP Request Connector
Ondersteunend sjabloon CLP | Toegangstoken genereren

 

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 maken drie werkruimtevariabelen aan voor de volgende gegevens: API Grant Client ID en Client Secret, en IAM (identity and access management) Base URL.

  1. Ga vanuit Chain Buildernaar Werkruimte-instellingen.
  2. Klik in Werkruimtevariabelendrie keer op het plusteken (+) om drie werkruimtevariabelen aan te maken en configureer ze als volgt:
    • Variabele 1:
    • Variabele 2:
      • Naam: wsv-Workiva API Client Secret
      • Waarde: Voer de Client-ID van uw API Grant in.
        Om het Client Secret te vinden, ga je naar je profiel in het Workiva-platform en zoek je de API Grant onder het tabblad Beveiliging.
        Volg deze instructies voor meer hulp bij het vinden van uw klantgeheim.

      • Klik op de vergrendelingsknop om uw clientgeheim te versleutelen.

        Het is belangrijk om klantgeheimen veilig te bewaren; sla het klantgeheim op een veilige plek op voor het geval u er in de toekomst weer toegang toe nodig hebt.

    • Variabele 3:

      • Naam: wsv-BaseURL-IAM
      • Waarde: Voer hieronder de waarde in op basis van uw regio. Je kunt de regio controleren door de URL te bekijken. Als de URL EU of APACbevat, gebruik dan de bijbehorende URL.
      Opmerking: De regio VS bevat alleen "app".
      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
    • Sla de werkruimte-instellingen op.

Stap 2: Maak een ketting

Om de Bearer Token te genereren, maken we een nieuwe Chain aan met een POST Command; hiermee krijgen we de Bearer Token die we nodig hebben.

  1. Ga naar het tabblad Ketens in de Ketenbouwer.
  2. Maak een nieuwe Chain aan en geef de Chain de naam: CLP | Genereer toegangstoken.
  3. Voeg een Beschrijving toe: 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.
  4. Red de ketting.

Stap 3: Een token ophalen

Deze keten gebruikt een POST Commando van de HTTP Request Connector om ons Bearer Token op te halen. Een Bearer Token is een cruciaal authenticatiemiddel dat nodig is voor toegang tot API's. Zodra het token binnen de blockchain is verkregen, kan het in volgende commando's worden gebruikt om autorisatie te verlenen voor interactie met de API.

  1. Voeg een Post Commando van de HTTP Request Connector toe aan het Startgebied.
  2. Dubbelklik op de opdracht om deze te configureren.
    • Hernoem de opdracht: POST - Een token ophalen.
    • Vink het selectievakje Reactie weergeven aan.
    • Vul het veld URL in met de URL van het eindpunt dat u wilt benaderen. Om een ​​token voor de Workiva API op te halen, vult u de URL in met onderstaande gegevens, waarbij u de werkruimtevariabele gebruikt om de IAM-basis-URL in te vullen.
      1. Klik in URL en klik vervolgens op Werkruimte in het paneel "Selecteer een variabele" en selecteer de variabele die u in stap 1 hebt gemaakt (wsv-BaseURL-IAM).
      2. Voeg /oauth2/token toe na de variabele.
    • Voer in het veld Content Type het volgende in: application/x-www-form-urlencoded.
  • Gebruik het plusteken om een ​​ koptekstveld toe te voegen.
    • Sleutel: Accepteren
    • Waarde: applicatie/json
  • Gebruik het plusteken om nog een koptekstveld toe te voegen.
    • Sleutel: X-versie
    • Waarde: 2026-01-01

We zullen het eindpunt vertellen hoe het moet worden uitgevoerd met behulp van parameters die zijn ingevuld in het Post Form. 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 selecterenop 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 selecterenop 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 de Response met de onderstaande voorbeeldpayload. Hiermee geven we een formaat aan de uitvoer van de opdracht, waardoor elke geretourneerde variabele gemakkelijker te gebruiken is.

    { "access_token": "string", "expires_in": "integer", "scope": "string", "token_type": "string" }
  1. (Optioneel) Voer een Beschrijvingin: "Deze HTTP-opdracht voert een POST-aanroep uit om een ​​toegangstoken te genereren dat nodig is voor authenticatie in volgende HTTP-opdrachten met behulp van de Workiva IAM API. Deze opdracht maakt gebruik van werkruimtevariabelen om de basis-URL voor de Workiva IAM API en de API Grant Client ID en Client Secret op te slaan. Meer informatie is te vinden op: https://developers.workiva.com/2026-01-01/tokenrequest.html".
  2. Sla het commando op.
Tip! Om te bepalen hoe u de velden 'Formulier' en 'Reactie' moet invullen, raadpleegt u de ontwikkelaarsdocumentatie voor het API-eindpunt waarmee u verbinding maakt. Voor de Workiva API kunt u de documentatie
over Bearer Tokens hier vinden.

Stap 4: Test de oefening

Nu de keten compleet is, test het resultaat.

  1. Publiceer de keten.
  2. Klik op Uitvoeren en vervolgens op Keten uitvoeren.

  3. Zodra de Chain zijn uitvoering heeft voltooid, zou je moeten zien dat het toegangstoken is gegenereerd in het tabblad Outputs - Response Body van de Post opdracht.

 

Bekijk de volgende oefening in het leertraject HTTP Request Connected om te leren hoe je het Bearer Token kunt gebruiken in een daaropvolgendeCommand List Spreadsheets.

Wilt u verbinding maken met een applicatie van derden die geen gebruikmaakt van de vooraf gebouwde Premium Connectors...