Requisitos de acesso
Expanda para visualizar os requisitos de acesso para a funcionalidade neste artigo.
Você deve ter o seguinte acesso para executar as etapas deste artigo:
Para obter mais detalhes sobre as informações nesta tabela, consulte Requisitos de acesso na documentação do Workfront.
Visão geral do OAuth2
Imagine que um aplicativo deve obter algumas informações específicas de Workfront. Um aplicativo que solicita informações é chamado de cliente. Para este exemplo, o nome do cliente é ClientApp. O ClientApp precisa acessar as informações de um usuário específico e, portanto, deve acessar Workfront como esse usuário. Se o usuário fornecer ao ClientApp o nome de usuário e a senha, ele poderá acessar todos os dados que o usuário puder acessar. Esse é um risco de segurança, pois o ClientApp precisa apenas de um conjunto pequeno e específico de informações.
Ao criar um aplicativo OAuth2 para ClientApp, você basicamente diz a Workfront que o ClientApp tem permissão para acessar Workfront, mas somente se o usuário cuja conta o ClientApp está acessando conceder permissão para o acesso.
Criar um aplicativo OAuth2
Ao criar um aplicativo OAuth2, escolha o tipo de aplicativo que melhor atenda às necessidades de sua integração.
Tipo de aplicativo | Melhor para | Método de autenticação |
---|---|---|
Aplicativo de máquina para máquina |
Melhor para CLIs, daemons ou scripts em execução no servidor Exemplos:
| Autenticação por meio de Token da web JSON com codificação de par de chaves pública/privada. |
Aplicativo web de página única |
Melhor para aplicativos web móveis ou de página única Exemplos:
| Autenticação por meio do fluxo de código de autorização OAuth 2.0 com chave de prova para troca de código (PKCE). |
Aplicativo web |
Melhor para aplicativos do lado do servidor que lidam com credenciais e tokens no servidor Exemplos:
| Autenticação por meio do fluxo de código de autorização OAuth 2.0. |
Criar um aplicativo OAuth2 usando autenticação de servidor (fluxo JWT)
-
Clique no ícone Menu Principal
-
No painel de navegação esquerdo, clique em Sistema e selecione Aplicativos OAuth2.
-
Clique em Criar integração de aplicativo.
A caixa Novo aplicativo OAuth2 é exibida. -
Na caixa Novo aplicativo OAuth2, selecione Computador para Aplicativo de Computador.
-
Digite um nome para o novo aplicativo, como "Workfront para ClientApp."
-
Clique em Criar.
-
Preencha os campos do novo aplicativo.
-
Clique em Salvar.
Para obter instruções sobre como configurar e usar o aplicativo OAuth2 com credenciais de usuário (fluxo de código de autorização), consulte Configurar e usar os aplicativos OAuth 2 personalizados da sua organização usando o fluxo JWT.
Criar um aplicativo OAuth2 usando credenciais do usuário (Fluxo de código de autorização)
https://app.workfrontfusion.com/oauth/cb/workfront-workfront
https://app-eu.workfrontfusion.com/oauth/cb/workfront-workfront
(Centro de dados da UE)https://app-az.workfrontfusion.com/oauth/cb/workfront-workfront
(Data Center do Azure)
-
Clique no ícone Menu Principal
-
No painel de navegação esquerdo, clique em Sistema e selecione Aplicativos OAuth2.
-
Clique em Criar integração de aplicativo.
O Novo aplicativo OAuth2 é exibido.
-
Na caixa Novo aplicativo OAuth2, selecione Aplicativo Web.
-
Digite um nome para o novo aplicativo OAuth2, como "Workfront para ClientApp."
-
Clique em Criar.
-
Preencha os campos do novo aplicativo.
-
Clique em Salvar.
Para obter instruções sobre como configurar e usar o aplicativo OAuth2 com credenciais de usuário (fluxo de código de autorização), consulte Configurar e usar os aplicativos OAuth 2 personalizados da sua organização usando o fluxo de código de autorização.
Criar um aplicativo web de página única OAuth2 usando PKCE
-
Clique no ícone Menu Principal
-
No painel de navegação esquerdo, clique em Sistema e selecione Aplicativos OAuth2.
-
Clique em Criar integração de aplicativo.
A caixa Novo aplicativo OAuth2 é exibida.
-
Na caixa Novo aplicativo OAuth2, selecione Aplicativo Web de Página Única.
-
Digite um nome para o novo aplicativo OAuth2, como "Workfront para ClientApp."
-
Clique em Criar.
-
Preencha os campos do novo aplicativo.
-
Clique em Salvar.
Configurar e usar o aplicativo OAuth2 criado
A configuração e o uso adicionais do aplicativo OAuth2 criado exigem algum conhecimento técnico, incluindo chamadas de API.
- Para obter instruções sobre como configurar e usar o aplicativo OAuth2 com credenciais de usuário (fluxo de código de autorização), consulte Configurar e usar os aplicativos OAuth 2 personalizados da sua organização usando o fluxo de código de autorização.
- Para obter instruções sobre como configurar e usar o aplicativo OAuth2 usando a autenticação de servidor (fluxo JWT), consulte Configurar e usar os aplicativos OAuth 2 personalizados da sua organização usando o fluxo JWT.
- Para obter instruções sobre como configurar e usar o aplicativo OAuth2 usando o PKCE, consulte Configurar e usar os aplicativos OAuth 2 personalizados de sua organização usando o fluxo de PKCE.
Processos OAuth2 para fluxo de código de autorização
Autorização com um código de autorização e um token de acesso
-
O ClientApp precisa de algumas informações de Workfront, por isso envia uma solicitação para o ponto de extremidade
/authorize
da API Workfront. A solicitação inclui o response_typecode
, que indica que a solicitação deve retornar um código de autorização. -
Isso aciona Workfront para enviar um prompt de autenticação ao usuário. O usuário pode inserir suas credenciais no prompt, que fornece a Workfront permissão para se comunicar com o ClientApp. Se o usuário já estiver conectado ao Workfront, esta etapa pode ser ignorada.
-
A API Workfront envia um código de autorização para o ClientApp.
-
O ClientApp envia as seguintes informações em uma solicitação para a API Workfront
/token
endpoint:- O código de autorização enviado ao ClientApp na etapa 3. Isso identifica a instância específica da permissão do usuário.
- O Segredo do Cliente gerado ao configurar o aplicativo OAuth2 do ClientApp em Workfront. Isso permite que Workfront saiba que a solicitação vem do ClientApp.
-
Se o código de autorização e o segredo do cliente estiverem corretos, Workfront enviará um token de acesso ao ClientApp. Este token de acesso é enviado diretamente de Workfront para ClientApp e não pode ser visualizado, copiado ou usado por nenhum outro usuário ou aplicativo cliente.
-
O ClientApp envia o token de acesso a Workfront junto com a solicitação específica de informações.
-
Como o token de acesso está correto, Workfront envia as informações para o ClientApp.