Verbinding maken met een webservice die een API-token gebruikt

De procedure voor het verbinden van de service via een API-token is vergelijkbaar voor de meeste webservices.

  1. Creeer een toepassing op de website van de Webdienst, zoals verklaard in de sectie creeer een nieuwe toepassing en verkrijg het API tekenin dit artikel.
  2. Haal de API-sleutel of API-token op.
  3. Voeg HTTP van Workfront Fusion > een module van het Verzoek aan uw scenario toe.
  4. Opstelling de module volgens de API van de Webdienst documentatie en het runnen van het scenario, zoals die in de sectie wordt verklaard Opstelling de module van HTTPin dit artikel.
NOTE
In dit voorbeeld wordt verbinding gemaakt met de Pushover-meldingsservice.

Een nieuwe toepassing maken en het API-token ophalen

NOTE
Webservices maken en distribueren API-sleutels of API-tokens op verschillende manieren. Ga naar de website van de service en zoek naar "API-sleutel" of "API-token" voor instructies voor het verkrijgen van een API-sleutel en -token voor de gewenste webservice.
We nemen alleen instructies voor het verkrijgen van een Pushover API-sleutel op als voorbeeld van wat u zou kunnen vinden.
  1. Meld u aan bij uw Pushover-account.
  2. Klik creeer een Token van de Toepassing/API bij de bodem van de pagina.
  3. Vul de Informatie van de Toepassing in en klik creeer een Toepassing.
  4. Sla de opgegeven API-token op een veilige plaats op. U hebt deze nodig als de Workfront Fusion HTTP > Een aanvraag-module maken verbinding moet maken met de gewenste webservice (in dit geval Pushover).

De module HTTP instellen

Als u een webservice wilt koppelen aan uw Workfront Fusion-scenario, moet u HTTP > Een aanvraagmodule maken in het scenario gebruiken en de module instellen volgens de API-documentatie van de webservice.

  1. Voeg HTTP > een module van het Verzoek aan uw scenario toe.

  2. Als u een bericht wilt verzenden met Workfront Fusion, stelt u de HTTP-module als volgt in.

    NOTE
    Deze module-instellingen komen overeen met de API-documentatie van de Pushover-webservice. De instellingen voor andere webservices kunnen afwijken. De API-token kan bijvoorbeeld worden ingevoegd in de koptekst en niet in het veld Hoofdtekst.
    URL

    https://api.pushover.net/1/messages.json

    Het veld URL bevat het eindpunt dat u kunt vinden in de API-documentatie van de webservice.

    Methode

    POST

    De gebruikte methode hangt van het overeenkomstige eindpunt af. Het eindpunt van Pushover voor het duwen van berichten gebruikt de POST methode.

    KoptekstenSommige webservices kunnen headers gebruiken om de API-tokenverificatie of andere parameters op te geven. Dit is niet het geval in ons voorbeeld als eindpunt van de Pushover voor het drukken van berichten gebruikt het Lichaam (zie hieronder) voor alle verzoektypes.
    Tekenreeks querySommige webservices kunnen een queryreeks gebruiken om andere parameters op te geven. Dit is niet het geval in ons voorbeeld aangezien de Pushover Webdienst Lichaam (zie hieronder) voor alle verzoektypes gebruikt.
    Type body

    Raw

    Met deze instelling kunt u het JSON-inhoudstype selecteren in het veld Inhoudstype hieronder.

    Inhoudstype

    JSON (application/json)

    JSON is het vereiste inhoudstype voor de Pushover-app. Dit kan verschillen van andere webservices.

    Inhoud aanvragen

    Voer de inhoud van het verzoek voor Body in de JSON-indeling. U kunt JSON gebruiken > creeer JSON module zoals die in wordt verklaard Kaart het lichaam JSON gebruikend JSON > creeer JSON modulein dit artikel. Of u kunt de inhoud JSON manueel ingaan, zoals die in wordt verklaard gaat het lichaam JSON manueelin dit artikel in.

    Zie de API-documentatie van de webservice voor de vereiste parameters voor die webservice.

Typ de JSON-hoofdtekst handmatig

Geef parameters en waarden op in de JSON-indeling.

recommendation-more-help