Autentisering för dokumentwebbhooks
Autentisering
Adobe 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
behörighet att agera å deras vägnar. Den här handskakningsprocessen utförs bara en gång för varje användare. Så här fungerar det:
-
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.
-
Workfront navigerar till användaren via 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.
-
När användaren har loggat in på det externa systemet (eller om användaren redan är inloggad) visas sidan Autentisering, som förklarar att Workfront begär åtkomst för att utföra en uppsättning åtgärder för användarens räkning.
-
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>". -
Workfront behandlar denna begäran och gör ett API-anrop till Token Endpoint URL med auktoriseringskoden.
-
Token Endpoint URL returnerar en uppdateringstoken och åtkomsttoken.
-
Workfront lagrar en sådan token och tillhandahåller webbkrokintegreringen för den här användaren.
-
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:
code language-none ------------------------------- Authorization: Bearer [access_token] ------------------------------- -
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.
ApiKey
Det är mycket enklare än OAuth2 att göra auktoriserade API-anrop till en webbkrokleverantör med en ApiKey. När du gör ett API-anrop skickar Workfront bara ApiKey och Workfront-användarnamn i HTTP-begärandehuvudet:
-------------------------------
apiKey: 12345
username: johndoe@foo.com
-------------------------------
Webkrockprovidern kan använda användarnamnet för att tillämpa användarspecifika behörigheter. Detta fungerar bäst när båda systemen ansluter till LDAP med enkel inloggning (SSO).