Document Webhooks API

Senast uppdaterad: 21 maj 2025
  • Ämnen:

Skapat för:

  • Utvecklare

Adobe Workfront Document Webhooks definierar en uppsättning API-slutpunkter genom vilka Workfront gör auktoriserade API-anrop till en extern dokumentleverantör. På så sätt kan vem som helst skapa ett plugin-program för mellanvara för alla dokumentlagringsleverantörer.

Användarupplevelsen för webkrosbaserade integreringar liknar den för befintliga dokumentintegreringar, som Google Drive, Box och Dropbox. En Workfront-användare kan till exempel utföra följande åtgärder:

  • Navigera i mappstrukturen för den externa dokumentprovidern
  • Sök efter filer
  • Länka filer till Workfront
  • Överför filer till den externa dokumentleverantören
  • Visa en miniatyrbild för dokumentet

Referenskörning

Workfront tillhandahåller en referensimplementering som hjälper dig att snabbt komma igång med utvecklingen av en ny webbhooksimplementering. Kod för detta finns på https://github.com/Workfront/webhooks-app. Implementeringen är Java-baserad och gör att Workfront kan ansluta dokument i ett nätverksfilsystem.

Registrera en Webkroks-integrering

Workfront-administratörer kan lägga till en anpassad webbkrokintegrering för sitt företag genom att gå till Inställningar > Dokument > Anpassade integreringar i Workfront. På sidan Anpassad integrering i installationsprogrammet kan administratörer visa en lista över befintliga webkrok-integreringar för dokument. Från den här sidan kan integreringar läggas till, redigeras, aktiveras och inaktiveras. Om du vill lägga till en integrering klickar du på knappen Lägg till integrering.

Tillgängliga fält

När du lägger till en integrering anger administratören värden för följande fält:

FältnamnBeskrivning
NamnNamnet på den här integreringen.
Bas-API-URLPlats för återanrops-API:t. När du anropar det externa systemet lägger Workfront till slutpunktsnamnet till den här adressen. Om administratören t.ex. angav Bas-API-URL:en, https://www.mycompany.com/api/v1, använder Workfront följande URL för att hämta ett dokuments metadata: https://www.mycompany.com/api/v1/metadata?id=1234.
Begär parametrarValfria värden som ska läggas till i frågesträngen för varje API-anrop. Till exempel access_type=offline.
AutentiseringstypOAuth2 eller ApiKey.
Autentiserings-URL(Endast OAuth2) Den fullständiga URL som används för användarautentisering. Workfront kommer att navigera användare till den här adressen som en del av OAuth-etableringsprocessen.

Obs! Workfront lägger till en state-parameter i frågesträngen. Providern måste skicka tillbaka detta till Workfront genom att lägga till det till Workfront omdirigerings-URI.
URL för tokenslutpunkt(Endast OAuth2) Den fullständiga API-URL som används för att hämta OAuth2-token. Den här är värd för webbholleverantören eller den externa dokumentleverantören.
Klient-ID(Endast OAuth2) Klient-ID:t för OAuth2 för den här integreringen.
Klienthemlighet(Endast OAuth2) OAuth2-klienthemlighet för den här integreringen.
Workfront Omdirigerings-URI(Endast OAuth2) Detta är ett skrivskyddat fält som genereras av Workfront. Det här värdet används för att registrera integreringen med den externa dokumentprovidern.

Obs! Som beskrivs ovan för autentiserings-URL måste providern lägga till parametern "state" och dess värde i frågesträngen när omdirigeringen utförs.
ApiKey(Endast ApiKey) Används för att göra auktoriserade API-anrop till webbkrokprovidern. API-nyckeln utfärdas av webbkrokprovidern.

Autentisering

Workfront dokumentwebhooks stöder två olika typer av autentisering: OAuth2 och ApiKey. I båda fallen skickar Workfront autentiseringstoken i huvudet när ett API-anrop görs.

OAuth2

Med OAuth2 kan Workfront göra auktoriserade API-anrop till en webkrok-leverantör för en användares räkning. Innan du gör det måste användaren ansluta sitt externa dokumentleverantörskonto till Workfront och bevilja Workfront åtkomst att agera för användarens räkning. Den här handskakningsprocessen utförs bara en gång för varje användare. Så här fungerar det:

  1. Användaren börjar ansluta webbkrokintegreringen till sitt konto. För närvarande gör du detta genom att klicka på listrutan Lägg till dokument > Lägg till tjänst > Anpassat integrationsnamn.

  2. Workfront navigerar användaren till autentiserings-URL:en, som kan uppmana användaren att logga in på den externa dokumentleverantören. Den här sidan hanteras av webbkrokprovidern eller det externa dokumenthanteringssystemet. När du gör det lägger Workfront till en state-parameter i autentiserings-URL:en. Detta värde måste skickas tillbaka till Workfront genom att samma värde läggs till i Workfront Retur-URI i steget nedan.

  3. När användaren har loggat in på det externa systemet (eller om användaren redan är inloggad) visas en autentiseringssida, som förklarar att Workfront begär åtkomst för att utföra en uppsättning åtgärder för användarens räkning.

  4. Om användaren klickar på Tillåt omdirigeras webbläsaren till Workfront omdirigerings-URI och"code=<code>" läggs till i frågesträngen. Enligt specifikationen OAuth2 är denna token kortlivad. Frågesträngen måste också ha följande: "state=<sent_by_workfront>".

  5. Workfront behandlar denna begäran och gör ett API-anrop till Token Endpoint URL med auktoriseringskoden.

  6. Token Endpoint URL returnerar en uppdateringstoken och åtkomsttoken.

  7. Workfront lagrar dessa tokens och tillhandahåller webbkrokintegreringen för den här användaren.

  8. Från och med nu kan Workfront göra auktoriserade API-anrop till webkrok-providern. När du ringer dessa samtal skickar Workfront åtkomsttoken i HTTP-begärandehuvudet enligt nedan:

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

  9. Om åtkomsttoken har upphört att gälla, kommer Workfront att anropa tokens slutpunkts-URL för att hämta en ny åtkomsttoken och sedan försöka med det auktoriserade API-anropet igen med den nya åtkomsttoken.