Autenticazione per webhook documenti

Ultimo aggiornamento: 17 luglio 2024
  • Argomenti:

Creato per:

  • Sviluppatore

Autenticazione

I webhook dei documenti di Adobe Workfront supportano due diverse forme di autenticazione: OAuth2 e ApiKey. In entrambi i casi, Workfront trasmette i token di autenticazione nell’intestazione quando effettua una chiamata API.

OAuth2

OAuth2 consente a Workfront di effettuare chiamate API autorizzate a un provider di webhook per conto di un utente. Prima di eseguire questa operazione, l'utente deve connettere l'account del provider di documenti esterno a Workfront e concedere a Workfront

poter agire per loro conto. Questo processo di handshake viene eseguito una sola volta per ogni utente. Ecco come funziona:

  1. L’utente inizia a collegare l’integrazione del webhook al proprio account. Attualmente, questo viene fatto facendo clic sul menu a discesa "Aggiungi documento" > "Aggiungi servizio" > Nome dell’integrazione personalizzata.

  2. Workfront passa all’utente tramite l’URL di autenticazione, che può richiedere all’utente di accedere al provider di documenti esterno. Questa pagina è ospitata dal provider del webhook o dal sistema esterno di gestione dei documenti. Workfront aggiunge un parametro "state" all’URL di autenticazione. Questo valore deve essere restituito a Workfront aggiungendo lo stesso valore all’URI di ritorno Workfront nel passaggio seguente.

  3. Dopo aver effettuato l’accesso al sistema esterno (o se l’utente ha già effettuato l’accesso), viene visualizzata una pagina di "Autenticazione" in cui viene spiegato che Workfront richiede l’accesso per eseguire una serie di azioni per conto dell’utente.

  4. Se l'utente fa clic sul pulsante "Consenti", il browser reindirizzerà all'URI di reindirizzamento di Workfront , aggiungendo "code=<code>" alla stringa di query. In base alla specifica OAuth2, questo token ha una durata breve. La stringa di query deve inoltre avere il seguente "state=<sent_by_workfront>".

  5. Workfront elabora questa richiesta e effettua una chiamata API all’URL dell’endpoint del token con il codice di autorizzazione.

  6. L’URL dell’endpoint token restituisce un token di aggiornamento e un token di accesso.

  7. Workfront memorizza questi token ed esegue il provisioning completo dell’integrazione del webhook per questo utente.

  8. Da questo momento in poi, Workfront sarà in grado di effettuare chiamate API autorizzate al provider del webhook. Quando effettui queste chiamate, Workfront invierà il token di accesso nell’intestazione della richiesta HTTP come mostrato di seguito:

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

  9. Se il token di accesso è scaduto, Workfront effettuerà una chiamata all’URL dell’endpoint del token per recuperare un nuovo token di accesso e quindi tenterà di nuovo la chiamata API autorizzata con il nuovo token di accesso.