DocumentaçãoWorkfrontAdobe Workfront Fusion

Módulo HTTP > Make an OAuth 2.0 request

Last update: Thu Jan 23 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:
NOTE
Adobe Workfront Fusion requer uma licença Adobe Workfront Fusion além de uma licença Adobe Workfront.

Para fazer uma solicitação HTTP(S) Adobe Workfront Fusion para servidores que exigem uma autorização OAuth 2.0, primeiro é necessário criar uma conexão OAuth. Adobe Workfront Fusion garante que todas as chamadas feitas com esta conexão tenham os cabeçalhos de autorização apropriados e atualizem automaticamente os tokens associados quando necessário.

Workfront Fusion oferece suporte aos seguintes fluxos de autenticação do OAuth 2.0:

  • Fluxo de código de autorização
  • Fluxo implícito

Outros fluxos, como Fluxo de Credenciais de Senha do Proprietário do Recurso e Fluxo de Credenciais do Cliente, não são automaticamente compatíveis por meio desse módulo.

Para obter mais informações sobre a autenticação OAuth 2.0, consulte A Estrutura de Autorização OAuth 2.0.

NOTE
Se você estiver se conectando a um produto Adobe que não tem um conector dedicado no momento, recomendamos o uso do módulo Adobe Authenticator.
Para obter mais informações, consulte módulo Adobe Authenticator.

Requisitos de acesso

Expanda para visualizar os requisitos de acesso para a funcionalidade neste artigo.

Você deve ter o seguinte acesso para usar a funcionalidade neste artigo:

table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header
Pacote do Adobe Workfront Qualquer
Licença do Adobe Workfront

Novo: Padrão

Ou

Atual: trabalho ou superior
Licença do Adobe Workfront Fusion**

Atual: nenhum requisito de licença do Workfront Fusion.

Ou

Herdados: Automação e integração do Workfront Fusion for Work
Produto

Novo:

  • Selecionar ou pacote do Prime Workfront: sua organização deve comprar o Adobe Workfront Fusion.
  • Pacote do Ultimate Workfront: o Workfront Fusion está incluído.

Ou

Atual: sua organização deve comprar o Adobe Workfront Fusion.

Para obter mais detalhes sobre as informações nesta tabela, consulte Requisitos de acesso na documentação.

Para obter informações sobre Adobe Workfront Fusion licenças, consulte Adobe Workfront Fusion licenças.

Criar uma conexão para uma solicitação OAuth

Instruções gerais para criar uma conexão no módulo HTTP > Make an OAuth 2.0 request

  1. Crie um cliente OAuth no serviço target com o qual você deseja que Adobe Workfront Fusion se comunique. Esta opção provavelmente foi encontrada na seção Developer do serviço fornecido.

    1. Ao criar um cliente, insira a URL apropriada no campo Redirect URL ou Callback URL:

      table 0-row-2 1-row-2
      Américas / APAC https://app.workfrontfusion.com/oauth/cb/oauth2
      EMEA https://app-eu.workfrontfusion.com/oauth/cb/oauth2

    2. Após a criação do cliente, o serviço fornecido exibe duas chaves: Client ID e Client Secret. Alguns serviços chamam estes App Key e App Secret. Salve a chave e o segredo em um local seguro, para que você possa fornecê-los ao criar a conexão no Workfront Fusion.

  2. Localize o Authorize URI e Token URI na documentação de API do serviço especificado. Esses são endereços de URL através dos quais Workfront Fusion se comunica com o serviço target. Os endereços são usados para autorização OAuth.

    note note
    NOTE
    Se o serviço usar o Fluxo implícito, você precisará somente do Authorize URI.

  3. (Condicional) Se o serviço de destino usa escopos (direitos de acesso), verifique como o serviço separa escopos individuais e certifique-se de definir o separador nas configurações avançadas adequadamente. Se o separador não estiver definido corretamente, Workfront Fusion falhará ao criar a conexão e você receberá um erro de escopo inválido.

  4. Após concluir as etapas acima, você pode começar a criar a conexão OAuth em Workfront Fusion. Adicione o HTTP > Criar um módulo de solicitação OAuth 2 ao seu cenário.

  5. No campo Conexão do módulo, clique em Add.

  6. Preencha os seguintes campos para criar uma conexão:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2 15-row-2 16-row-2 17-row-2 18-row-2 layout-auto html-authored no-header
    Connection name Insira o nome da conexão.
    Environment Selecione se você está usando um ambiente de produção ou não.
    Type Selecione se você está usando uma conta de serviço ou uma conta pessoal.
    Flow type

    Selecione o fluxo para obter tokens.

    • Authorization Code: insira o Authorize URI e Token URI da documentação da API do serviço.
    • Implicit: insira o Authorize URI na documentação da API do serviço.
    Scope Adicionar escopos individuais. Você pode encontrar essas informações na documentação do desenvolvedor (API) do serviço específico.
    Scope separator

    Selecione os escopos inseridos acima que devem ser separados por. Você pode encontrar essas informações na documentação do desenvolvedor (API) do serviço específico.

    Aviso: se o separador não estiver definido corretamente, Workfront Fusion falhará ao criar a conexão e você receberá um erro de escopo inválido.
    Client ID Insira a ID do cliente. Você obteve a ID do cliente ao criar um cliente OAuth no serviço que deseja conectar.
    Client Secret Digite o segredo do cliente. Você obteve o Segredo do cliente ao criar um cliente OAuth no serviço que deseja conectar.
    Authorize parameters

    Adicione os parâmetros que deseja incluir na chamada de autorização. Os seguintes parâmetros padrão são sempre incluídos automaticamente e não precisam ser adicionados.

    Parâmetros padrão:

    • response_type

      code para Authorization Code flow e token para Implicit flow

    • redirect_uri

      table 0-row-2 1-row-2 layout-auto html-authored no-header
      Américas / APAC https://app.workfrontfusion.com/oauth/cb/oauth2
      EMEA https://app-eu.workfrontfusion.com/oauth/cb/oauth2

    • client_id

      A ID do cliente recebida ao criar a conta
    Access token parameters

    Adicione os parâmetros que deseja incluir na chamada de token. Os seguintes parâmetros padrão são sempre incluídos automaticamente e não precisam ser adicionados.

    Parâmetros padrão:

    • grant_type: authorization_code

    • redirect_uri:

      table 0-row-2 1-row-2 layout-auto html-authored no-header
      Américas / APAC https://app.workfrontfusion.com/oauth/cb/oauth2
      EMEA https://app-eu.workfrontfusion.com/oauth/cb/oauth2

    • client_id: a ID do cliente recebida ao criar a conta é incluída automaticamente no corpo da solicitação

    • client_secret: o Segredo do Cliente recebido ao criar a conta é automaticamente incluído no corpo da solicitação

    • código: o código retornado pela solicitação de autorização

    Nota:

    O padrão OAuth 2.0 oferece suporte a pelo menos dois métodos de autenticação de cliente durante esta etapa (client_secret_basic e client_secret_post). Workfront Fusion envia automaticamente a ID de cliente e a senha especificadas pelo método client_secret_post. Portanto, esses parâmetros são incluídos automaticamente como parte do corpo da solicitação de token.

    Para obter mais informações sobre a autenticação OAuth 2.0, consulte A Estrutura de Autorização OAuth 2.0.
    Refresh token parameters

    Adicione os parâmetros que deseja incluir na chamada de token. Os seguintes parâmetros padrão são sempre incluídos automaticamente e não precisam ser adicionados.

    Parâmetros padrão:

    • grant_type: refresh_token

    • refresh_token: o token de atualização mais recente obtido pelo serviço ao qual você está se conectando

    • client_id: a ID do cliente recebida ao criar a conta é incluída automaticamente no corpo da solicitação

    • client_secret: o segredo do cliente recebido ao criar a conta é incluído automaticamente no corpo da solicitação

    Nota:

    O padrão OAuth 2.0 oferece suporte a pelo menos dois métodos de autenticação de cliente durante esta etapa (client_secret_basic e client_secret_post). Workfront Fusion envia automaticamente a ID de cliente e a senha especificadas pelo método client_secret_post. Portanto, esses parâmetros são incluídos automaticamente como parte do corpo da solicitação de token.

    Para obter mais informações sobre a autenticação OAuth 2.0, consulte A Estrutura de Autorização OAuth 2.0.
    Custom Headers

    Especifique quaisquer chaves e valores adicionais para incluir no cabeçalho das etapas Token e Refresh Token.

    Nota:

    O padrão OAuth 2.0 oferece suporte a pelo menos dois métodos de autenticação de cliente durante esta etapa (client_secret_basic e client_secret_post). Workfront Fusion não dá suporte automático ao método client_secret_basic. Se o serviço ao qual você está se conectando espera que a ID do cliente e o Segredo do cliente sejam combinados em uma única cadeia de caracteres e, em seguida, codificada em base64 no cabeçalho de Autorização, adicione esse cabeçalho e o valor da chave aqui.

    Para obter mais informações sobre a autenticação OAuth 2.0, consulte A Estrutura de Autorização OAuth 2.0.
    Token placement

    Selecione se deseja enviar o token no header, query string ou em ambos ao conectar-se à URL especificada.

    Os tokens são enviados com mais frequência no cabeçalho da solicitação.
    Header token name Insira o nome do token de autorização no cabeçalho. Padrão: Bearer.
    Query string parameter name Insira o nome do token de autorização na cadeia de caracteres de consulta. Padrão: access_token.

  7. Clique em Continue para salvar a conexão e retornar ao módulo.

  8. Continue em Configurar o módulo Criar uma solicitação OAuth 2.0.

Instruções para criar uma conexão com Google em HTTP >Make an OAuth 2.0 request module

O exemplo a seguir mostra como usar o módulo de solicitação HTTP > Make an OAuth 2.0 para se conectar a Google.

  1. Verifique se você criou um projeto, definiu as configurações de OAuth e gerou suas credenciais conforme descrito no artigoConectar Adobe Workfront Fusion a Google Services usando um cliente OAuth personalizado.

  2. Abra o módulo HTTP > Make an OAuth 2.0 request.

  3. Clique em Add ao lado da caixa de conexão.

  4. Insira os seguintes valores:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 layout-auto html-authored no-header
    Connection name Insira um nome para a conexão.
    Environment Selecione se você está usando um ambiente de produção ou não.
    Type Selecione se você está usando uma conta de serviço ou uma conta pessoal.
    Flow type Authorization Code
    Authorize URI https://accounts.google.com/o/oauth2/v2/auth
    Token URI https://www.googleapis.com/oauth2/v4/token
    Scope Adicionar escopos individuais. Para obter mais informações sobre escopos, consulte Escopos do OAuth 2.O para Google APIs na documentação do Google.
    Scope separator SPACE
    Client ID

    Insira sua ID de cliente do Google.

    Para criar uma ID de cliente, consulte Criar credenciais OAuth no artigo Connect Adobe Workfront Fusion para Google Services usando um cliente OAuth personalizado.
    Client Secret

    Insira seu Segredo do Cliente do Google.

    Para criar um segredo de cliente, consulte Criar credenciais OAuth no artigo Connect Adobe Workfront Fusion para Google Serviços usando um cliente OAuth personalizado.
    Authorize parameters

    Adicionar access_type - offline par de valor-chave.

    Observação: se você tiver problemas de autenticação, por exemplo, com a atualização de token, tente adicionar o par de valores-chave prompt - consent .

  5. Clique em Continue para salvar as configurações de conexão.

  6. Continue em Configurar o módulo Criar uma solicitação OAuth 2.0.

Configurar o módulo Criar uma solicitação do OAuth 2.0

Depois de estabelecer uma conexão OAuth 2.0, continue configurando o módulo conforme desejado. Todos os tokens de autorização são incluídos automaticamente nessa solicitação e em qualquer outra solicitação que use a mesma conexão.

Ao configurar o módulo HTTP > Make an OAuth 2.0 request, o Workfront Fusion exibe os campos listados abaixo. Um título em negrito em um módulo indica um campo obrigatório.

Se você vir o botão de mapa acima de um campo ou função, poderá usá-lo para definir variáveis e funções para esse campo. Para obter mais informações, consulte Mapear informações de um módulo para outro em Adobe Workfront Fusion.

Alternância de mapa

Connection
Para obter informações sobre como configurar uma conexão, consulte Criar uma conexão para uma solicitação OAuth neste artigo.
Evaluate all states as errors (except for 2xx and 3xx)

Use esta opção para configurar o tratamento de erros.

Para obter mais informações, consulte Tratamento de erros.

URL
Insira o URL para o qual você deseja enviar uma solicitação, como um endpoint de API, site etc.
Method
Selecione o método de solicitação HTTP necessário para configurar a chamada de API. Para obter mais informações, consulte Métodos de solicitação HTTP.
Headers
Adicione os cabeçalhos da solicitação no formulário de um objeto JSON padrão. Por exemplo, {"Content-type":"application/json"}
Query String
Insira os pares de valor-chave da consulta desejados.
Body type

O Corpo HTTP são os bytes de dados transmitidos em uma mensagem de transação HTTP imediatamente após os cabeçalhos, se houver algum a ser usado.

  • Raw

    O tipo de corpo bruto geralmente é adequado para a maioria das solicitações de corpo HTTP, mesmo em situações em que a documentação do desenvolvedor não especifica os dados a serem enviados.

    Especifique um formulário de análise de dados no campo Content type.

    Apesar do tipo de conteúdo selecionado, os dados são inseridos em qualquer formato estipulado ou exigido pela documentação do desenvolvedor.

  • Application/x-www-form-urlencoded

    Este tipo de corpo é para dados POST usando application/x-www-form-urlencoded.

    Para application/x-www-form-urlencoded, o corpo da mensagem HTTP enviada ao servidor é essencialmente uma cadeia de caracteres de consulta. As chaves e os valores são codificados em pares de valores chave separados por & e por um = entre a chave e o valor.

    Para dados binários, use multipart/form-data em vez disso.

    Exemplo:

    Exemplo do formato de solicitação HTTP resultante:

    field1=value1&field2=value2

  • Multipart/form-data

    O Multipart/form-data é uma solicitação HTTP de várias partes usada para enviar arquivos e dados. Normalmente, é usado para carregar arquivos no servidor.

    Adicione campos a serem enviados na solicitação. Cada campo deve conter um par de valores chave.

    • Text

      Informe a chave e o valor a serem enviados dentro do corpo da solicitação.

    • File

      Informe a chave e especifique o arquivo de origem que deseja enviar no corpo da solicitação.

      Mapeie o arquivo que você deseja carregar do módulo anterior (como HTTP >Get a File) ou insira o nome do arquivo e os dados do arquivo manualmente.

Parse response

Habilite esta opção para analisar respostas automaticamente e converter respostas JSON e XML para que você não precise usar os módulos JSON > Parse JSON ou XML > Parse XML.

Antes de usar o conteúdo JSON ou XML analisado, execute o módulo uma vez manualmente para que o módulo possa reconhecer o conteúdo da resposta e permitir que você o mapeie em módulos subsequentes.

Timeout
Insira o tempo limite da solicitação em segundos (1-300). O padrão é 40 segundos.
Share cookies with other HTTP modules
Habilite essa opção para compartilhar cookies do servidor com todos os módulos HTTP em seu cenário.
Self-signed certificate
Para usar um certificado autoassinado ou uma chave privada para TLS, clique em Extrair e forneça o arquivo e a senha do certificado ou da chave privada.
Reject connections that are using unverified (self-signed) certificates
Habilite esta opção para rejeitar conexões que estejam usando certificados TLS não verificados.
Follow redirect
Ative essa opção para seguir os redirecionamentos de URL com respostas 3xx.
Follow all redirects
Ative essa opção para seguir os redirecionamentos de URL com todos os códigos de resposta.
Disable serialization of multiple same query string keys as arrays
Por padrão, Workfront Fusion manipula vários valores para a mesma chave de parâmetro da cadeia de caracteres de consulta da URL que as matrizes. Por exemplo, www.test.com?foo=bar&foo=baz será convertido em www.test.com?foo[0]=bar&foo[1]=baz. Ative esta opção para desativar este recurso.
Request compressed content

Habilite esta opção para solicitar uma versão compactada do site.

Isso adiciona um cabeçalho Accept-Encoding para solicitar conteúdo compactado.

Use Mutual TLS

Habilite esta opção para usar o TLS mútuo na solicitação HTTP.

Para obter mais informações sobre TLS Mútuo, consulte Usar TLS Mútuo em módulos HTTP em Adobe Workfront Fusion.

recommendation-more-help
7e1891ad-4d59-4355-88ab-a2e62ed7d1a3