Verificatie voor documentwebhooks
Verificatie
Websites van Adobe 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 zijn externe account voor de documentprovider verbinden met Workfront en Workfront verlenen
toegang om namens hen te handelen. Dit handshaking proces gebeurt slechts eenmaal voor elke gebruiker. Zo werkt het:
-
De gebruiker begint de integratie met de webhaak aan te sluiten op zijn of haar account. Dit gebeurt momenteel door te klikken op het vervolgkeuzemenu Document toevoegen > Service toevoegen > Aangepaste integratienaam.
-
Workfront navigeert door 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.
-
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.
-
Als de gebruiker "toestaat"knoop klikt, zal browser aan Workfront Redirect URI opnieuw richten, toevoegend "code=
<code>"aan het querystring. Conform de OAuth2-specificatie is dit token van korte duur. Het querystring moet ook het volgende hebben, "state=<sent_by_workfront>". -
Workfront verwerkt dit verzoek en doet een API vraag aan het Symbolische Eindpunt URL met de vergunningscode.
-
De Symbolische URL van het Eindpunt keert vernieuwt teken en toegangstoken terug.
-
Workfront slaat deze tokens op en past de integratie van de webhaak volledig toe op deze gebruiker.
-
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:
code language-none ------------------------------- Authorization: Bearer [access_token] ------------------------------- -
Als het toegangstoken is verlopen, zal Workfront een vraag aan het Symbolische Eindpunt URL maken om een nieuw toegangstoken terug te winnen dan de geautoriseerde API vraag met het nieuwe toegangstoken opnieuw proberen.
ApiKey
Het maken van geautoriseerde API-aanroepen naar een webhakprovider met behulp van een ApiKey is veel eenvoudiger dan OAuth2. Wanneer Workfront een API-aanroep maakt, geeft het gewoon de gebruikersnaam van ApiKey en Workfront door in de HTTP-aanvraagheader:
-------------------------------
apiKey: 12345
username: johndoe@foo.com
-------------------------------
De leverancier Webhaak kan de gebruikersbenaming gebruiken om gebruiker-specifieke toestemmingen toe te passen. Dit werkt het beste wanneer beide systemen verbinding maken met LDAP via Single Sign On (SSO).