DocumentazioneWorkfrontGuida di Workfront

Configurare e utilizzare le applicazioni OAuth 2 personalizzate della tua organizzazione utilizzando il flusso del codice di autorizzazione

Last update: Fri Aug 09 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Argomenti:

Creato per:

  • Sviluppatore

Per eseguire l’integrazione con Workfront e consentire all’app client di comunicare con Workfront per conto dell’utente, è necessario:

  • Creare un’applicazione OAuth2
  • Configurare l’applicazione di terze parti
  • Collegamento alla pagina Autorizza per i tuoi utenti
  • Configurare il flusso del codice di autorizzazione: gli utenti accedono all’istanza di Workfront e accettano di consentire all’applicazione client di connettersi a Workfront per loro conto. Di conseguenza, ottieni un codice di autorizzazione che scambierai con i token di accesso e di aggiornamento.
  • Configurare il flusso del token di aggiornamento: in questo flusso utilizzi il token di aggiornamento per ottenere un nuovo token di accesso quando quello precedente è scaduto.

Creare un'applicazione OAuth2

Per istruzioni sulla creazione dell'applicazione OAuth2, vedere Creare un'applicazione OAuth2 utilizzando le credenziali utente (flusso del codice di autorizzazione) in Creare applicazioni OAuth2 per le integrazioni Workfront

NOTE
Puoi avere fino a un totale di dieci applicazioni OAuth2 alla volta.

Collegamento alla pagina Autorizza per i tuoi utenti

Gli utenti devono effettuare l’accesso per autorizzare questa integrazione nel proprio account. La pagina da autorizzare ha un formato specifico, descritto qui. Utilizza queste informazioni per determinare l’indirizzo della pagina di autorizzazione dell’app e fornisci agli utenti tale indirizzo o un collegamento a esso.

  • L’URL completo del dominio della tua organizzazione. Esempio:

    code language-none 
    https://myorganization.my.workfront.com

  • client_id: ID client generato al momento della creazione dell'app OAuth2 in Workfront.

  • redirect_uri: questo URL deve essere uguale all'URL di reindirizzamento immesso in Workfront durante la creazione dell'app OAuth2. Gli utenti verranno indirizzati a questa pagina dopo aver autorizzato l’app per il loro account.

  • response_type: deve avere il valore code.

L’URL per la pagina di autorizzazione è quindi:

https://<URL of your organization's domain>/integrations/oauth2/authorize?client_id=<Your ClientID>&redirect_uri=<Your redirect URL>&response_type=code
NOTE
È consigliabile creare un pulsante o un altro collegamento su cui gli utenti possano fare clic per passare a questa pagina.

Configurare l’applicazione di terze parti

L’applicazione di terze parti potrebbe richiedere la configurazione. La tabella seguente contiene informazioni sui campi che potrebbero essere necessari durante la configurazione dell'applicazione di terze parti.

URI di autorizzazione

https://<the full URL of your organization's domain>/integrations/oauth2/authorize

Esempio: https://myorganization.my.workfront.com/integrations/oauth2/authorize

URL token

https://<the full URL of your organization's domain>/integrations/oauth2/api/v1/token

Esempio: https://myorganization.my.workfront.com/integrations/oauth2/api/v1/token

Ambiti
Non è necessario specificare gli ambiti.

Imposta flusso codice di autorizzazione

Per accedere agli utenti con OAuth2, utilizza la procedura seguente:

  1. Quando l’utente apre la pagina di autorizzazione, viene reindirizzato alla pagina di accesso di Workfront, in modo che possa accedere a Workfront. Se l’utente dispone di una configurazione SSO, viene aperta la pagina di accesso del provider di identità.

    Se l’utente ha già effettuato l’accesso a Workfront nello stesso browser o ha eseguito correttamente l’accesso a Workfront, viene reindirizzato alla schermata di consenso:

  2. Se l'utente consente l'accesso, la pagina verrà reindirizzata a redirect_url. Il reindirizzamento deve includere i seguenti parametri di query:

  • code: codice di autorizzazione necessario per ottenere il token di accesso/aggiornamento.

  • domain: dominio della tua organizzazione. Esempio: in myorganization.my.workfront.com, il dominio è myorganization.

  • lane: percorso della richiesta. Esempio: in myorganization.preview.workfront.com, la corsia è preview.

    note important
    IMPORTANT
    code è valido solo per 2 minuti. Pertanto, devi ottenere i token di aggiornamento e di accesso entro tale periodo di tempo.

  1. Quando si dispone di un codice, è possibile richiedere l'aggiornamento e accedere ai token inviando il codice insieme alle credenziali dell'app client all'endpoint /integrations/oauth2/api/v1/token.

    L’URL completo della richiesta del token è

    code language-none 
    https://<URL of your organization's domain></span>/integrations/oauth2/api/v1/token

    Esempi: esempio di chiamata CURL all'endpoint token:

    Esempio 1

    code language-none 
       curl --location --request POST '**<workfront host>**/integrations/oauth2/api/v1/token' \
   --header 'Authorization: Basic **<base64(client_id:client_secret)>**' \
   --header 'Content-Type: application/json' \
   --data-raw '{
   "code": "**<code>**",
   "grant_type": "**authorization_code**",
   "redirect_uri": "**<redirect_url>**"
   }'

    Esempio 2

    code language-none 
       curl --location --request POST '**<workfront host>**/integrations/oauth2/api/v1/token' \
   --header 'Content-Type: application/x-www-form-urlencoded' \
   --data-urlencode 'grant_type=**authorization_code**' \
   --data-urlencode 'redirect_uri=**<redirect_url>**' \
   --data-urlencode 'code=**<code>**' \
   --data-urlencode 'client_id=**<client_id>**' \
   --data-urlencode 'client_secret=**<client_secret>**'
    note important
    IMPORTANT
    Il segreto client è stato generato durante la registrazione dell’app in Workfront. È necessario conservarlo in un luogo sicuro, perché non può essere recuperato se viene perso.

    Quando tutti i parametri passati sono corretti, l’endpoint token restituisce il seguente payload:

    code language-none 
    {
   "token_type": "sessionID",
   "access_token": "string", // the value of sessionID
   "refresh_token": "string",
   "expires_in": 0,
   "wid": "string"
}

    Il token di accesso è uguale a sessionID e scade allo stesso modo del normale sessionID

    note important
    IMPORTANT
    Memorizza il token di aggiornamento in un luogo sicuro. Ne avrai bisogno per ottenere un nuovo token di aggiornamento quando quello vecchio è scaduto. Workfront non memorizza il token di aggiornamento.

  2. Ora, quando disponi di un token di accesso, puoi effettuare chiamate API a Workfront

    code language-none 
    curl --request GET 'https://<workfront host>/attask/api/v14.0/proj/search \
--header 'sessionID: <access_token>'

Configurare il token di accesso per l’aggiornamento

Per aggiornare access_token è necessario eseguire nuovamente una chiamata "POST" all’endpoint del token. Questa volta inviamo un modulo diverso dati come segue:

curl --location --request POST '<workfront host>/integrations/oauth2/api/v1/token' \
--header 'Authorization: Basic <base64(client_id:client_secret)>' \
--header 'Content-Type: application/json' \
--data-raw '{
   "grant_type": "refresh_token",
   "refresh_token": "<refresh_token>"
}'

###### OR

curl --location --request POST '<workfront host>/integrations/oauth2/api/v1/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=refresh_token' \
--data-urlencode 'redirect_uri=<redirect_url>' \
--data-urlencode 'refresh_token=<refresh_token>' \
--data-urlencode 'client_id=<client_id>' \
--data-urlencode 'client_secret=<client_secret>'

Restituisce il seguente risultato:

{
  "token_type": "sessionID",
  "access_token": "string", // the value of sessionID
  "refresh_token": "string",
  "expires_in": 0,
  "wid": "string"
}

Il token di accesso è sessionID, che può essere utilizzato per effettuare una richiesta API a Workfront.

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43