Document Webhooks-API

Laatst bijgewerkt: 21 mei 2025
  • Onderwerpen:

Gemaakt voor:

  • Ontwikkelaar

Adobe Workfront Document Webhooks definieert een set API-eindpunten waarmee Workfront geoorloofde API-aanroepen uitvoert naar een externe documentprovider. Hierdoor kan iedereen een middleware-insteekmodule maken voor elke leverancier van documentopslag.

De gebruikerservaring voor integratie op basis van een webhaak is vergelijkbaar met die van bestaande documentintegratie, zoals Google Drive, Box en Dropbox. Een Workfront-gebruiker kan bijvoorbeeld de volgende handelingen uitvoeren:

  • Navigeren door de mapstructuur van de externe documentprovider
  • Bestanden zoeken
  • Bestanden koppelen naar Workfront
  • Bestanden uploaden naar de externe documentprovider
  • Een miniatuur voor het document weergeven

Referentie-implementatie

Workfront biedt een voorbeeldimplementatie om de ontwikkeling van een nieuwe webhooks-implementatie te versnellen. De code voor dit kan in https://github.com/Workfront/webhooks-appworden gevonden. Deze implementatie is gebaseerd op Java en maakt het Workfront mogelijk om verbinding te maken met documenten op een netwerkbestandssysteem.

Registreren van een Integratie Webhaak

Workfront-beheerders kunnen een aangepaste webshintegratie voor hun bedrijf toevoegen door te navigeren naar Setup > Documenten > Aangepaste integratie in Workfront. Van de pagina van de Integratie van de Douane binnen Opstelling, kunnen de beheerders een lijst van bestaande integratie van documentWebHaak bekijken. Vanaf deze pagina kunnen integraties worden toegevoegd, bewerkt, ingeschakeld en uitgeschakeld. Klik op de knop Integratie toevoegen om een integratie toe te voegen.

Beschikbare velden

Wanneer de beheerder een integratie toevoegt, zal hij waarden voor de volgende gebieden ingaan:

VeldnaamBeschrijving
NaamDe naam van deze integratie.
Basis-API-URLDe locatie van de callback-API. Wanneer het maken van vraag aan het externe systeem, zal Workfront de eindpuntnaam aan dit adres toevoegen. Als de beheerder bijvoorbeeld de URL van de basis-API, " https://www.mycompany.com/api/v1 " invoert, gebruikt Workfront de volgende URL om de metagegevens van een document op te halen: https://www.mycompany.com/api/v1/metadata?id=1234.
Parameters aanvragenOptionele waarden die aan de querytekenreeks van elke API-aanroep moeten worden toegevoegd. Bijvoorbeeld access_type=offline.
Type verificatieOAuth2 of ApiKey.
Verificatie-URL(Alleen OAuth2) De volledige URL die wordt gebruikt voor gebruikersverificatie. Workfront navigeert gebruikers naar dit adres als onderdeel van het OAuth-inrichtingsproces.

Nota: Workfront zal een "staat"parameter aan het vraagkoord toevoegen. De provider moet dit bestand teruggeven aan Workfront door het toe te voegen aan de Workfront Redirect URI.
URL van token-eindpunt(Alleen OAuth2) De volledige API-URL waarmee OAuth2-tokens worden opgehaald. Dit wordt gehost door de websiteprovider of externe documentprovider.
Client-id(Alleen OAuth2) De OAuth2 Client ID voor deze integratie.
Clientgeheim(Alleen OAuth2) Het OAuth2-clientgeheim voor deze integratie.
Workfront Redirect URI(Alleen OAuth2) Dit is een alleen-lezen veld en wordt gegenereerd door Workfront. Deze waarde wordt gebruikt om deze integratie bij de externe documentprovider te registreren.

Nota: Zoals hierboven voor Authentificatie URL wordt beschreven, moet de leverancier de "staat"parameter en zijn waarde aan het querykoord toevoegen wanneer het uitvoeren van redirect.
ApiKey(Alleen ApiKey) Wordt gebruikt om geoorloofde API-aanroepen uit te voeren naar de websiteprovider. De API-sleutel wordt uitgegeven door de websiteprovider.

Verificatie

Websites van Workfront-documenten ondersteunen twee verschillende verificatievormen: OAuth2 en ApiKey. In beide gevallen geeft Workfront verificatietokens door in de header wanneer een API-aanroep wordt uitgevoerd.

OAuth2

OAuth2 staat Workfront toe om erkende API vraag aan een websiteleverancier namens een gebruiker te maken. Voordat de gebruiker dit doet, moet hij of zij een verbinding tot stand brengen met Workfront en Workfront toegang verlenen om namens hem of haar op te treden. Dit handshaking proces gebeurt slechts eenmaal voor elke gebruiker. Zo werkt het:

  1. De gebruiker begint de integratie met de webhaak aan te sluiten op zijn of haar account. Dit gebeurt momenteel door te klikken op de vervolgkeuzelijst Document toevoegen > Service toevoegen > Aangepaste integratienaam.

  2. Workfront navigeert de gebruiker naar de verificatie-URL, die de gebruiker kan vragen zich aan te melden bij de externe documentprovider. Deze pagina wordt gehost door de websiteprovider of het externe documentbeheersysteem. Als u dit doet, voegt Workfront een parameter "state" toe aan de URL van de verificatie. Deze waarde moet worden doorgegeven aan Workfront door dezelfde waarde toe te voegen aan de Workfront Return URI in de onderstaande stap.

  3. Na het registreren aan het externe systeem (of als de gebruiker reeds het programma wordt geopend), wordt de gebruiker genomen aan een pagina van de Authentificatie, die verklaart dat Workfront toegang aanvraagt om een reeks acties namens de gebruiker uit te voeren.

  4. Als de gebruiker op de knop Toestaan klikt, leidt de browser naar de Workfront Redirect URI door "code=<code>" toe te voegen aan de querytekenreeks. Conform de OAuth2-specificatie is dit token van korte duur. Het querystring moet ook het volgende hebben: "state= <sent_by_workfront>".

  5. Workfront verwerkt dit verzoek en doet een API vraag aan het Symbolische Eindpunt URL met de vergunningscode.

  6. De Symbolische URL van het Eindpunt keert vernieuwt teken en toegangstoken terug.

  7. Workfront slaat deze tokens op en past de integratie van de webhaak volledig toe op deze gebruiker.

  8. Vanaf dat moment kan Workfront geoorloofde API-aanroepen uitvoeren naar de websiteprovider. Wanneer het maken van deze vraag, zal Workfront het toegangstoken in de HTTP- verzoekkopbal zoals hieronder getoond verzenden:

    -------------------------------
Authorization: Bearer [access_token] ­­­­­­­­­­­­­­­­­­­­­­­­­­
-------------------------------

  9. Als het toegangstoken is verlopen, zal Workfront een vraag aan het Symbolische Eindpunt URL maken om een nieuw toegangstoken terug te winnen, dan zal de geautoriseerde API vraag opnieuw met het nieuwe toegangstoken proberen.