DocumentaçãoWorkfrontGuia do Workfront

HTTP > Fazer uma solicitação OAuth 2.0 para o módulo

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • Usuário
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

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

Adobe Workfront plano*
Pro ou superior
Adobe Workfront licença*
Plano, Trabalho
Adobe Workfront Fusion licença**

Requisito de licença atual: nenhum requisito de licença Workfront Fusion.

Ou

Requisito de licença herdada: Workfront Fusion para Automação e Integração do Trabalho

Produto

Requisito atual do produto: se você tiver o plano Select ou Prime Adobe Workfront, sua organização deve comprar Adobe Workfront Fusion e Adobe Workfront para usar a funcionalidade descrita neste artigo. Workfront Fusion está incluído no plano Workfront do Ultimate.

Ou

Requisito de produto herdado: sua organização deve comprar o Adobe Workfront Fusion e o Adobe Workfront para usar a funcionalidade descrita neste artigo.

Para saber que plano, tipo de licença ou acesso você tem, contate o administrador do Workfront.

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

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

Instruções gerais para criar uma conexão no módulo HTTP > Fazer uma solicitação OAuth 2.0

  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 Desenvolvedor 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 esses itens de 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.
    note info
    INFO
    Exemplo: endereços do Yahoo:
    • Autorizar URI:
    https://api.login.yahoo.com/oauth2/request_auth
    • URI do token:
    https://api.login.yahoo.com/oauth2/get_token

  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 módulo de processamento de solicitação e resposta HTTP(S) do OAuth 2.0 ao seu cenário.

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

  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 layout-auto html-authored no-header
    Nome da Conexão Insira o nome da conexão.
    Tipo de fluxo

    Selecione o fluxo para obter tokens.

    • Código de Autorização: Insira o Authorize URI e Token URI da documentação de API do serviço.
    • Implícito: Insira o Authorize URI da documentação da API do serviço.
    Escopo Adicionar escopos individuais. Você pode encontrar essas informações na documentação do desenvolvedor (API) do serviço específico.
    Separador de escopo

    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.
    ID do Cliente Insira a ID do cliente. Você obteve a ID do cliente ao criar um cliente OAuth no serviço que deseja conectar.
    Segredo do Cliente Digite o segredo do cliente. Você obteve o Segredo do cliente ao criar um cliente OAuth no serviço que deseja conectar.
    Autorizar parâmetros

    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:

    • tipo_resposta

      code para o fluxo de Código de Autorização e token para o fluxo Implícito

    • 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
    Parâmetros de token de acesso

    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:

    • tipo_concessão: 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.
    Atualizar parâmetros de token

    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:

    • tipo_concessão: 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 é automaticamente incluído 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.
    Cabeçalhos Personalizados

    Especifique chaves e valores adicionais para incluir no cabeçalho das etapas Token e RFresh 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.
    Inserção de token

    Selecione se o token deve ser enviado no header, na 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.
    Nome do token de cabeçalho Insira o nome do token de autorização no cabeçalho. Padrão: Bearer.
    Nome do parâmetro da cadeia de caracteres de consulta Insira o nome do token de autorização na cadeia de caracteres de consulta. Padrão: access_token.

  7. Clique em Continuar para salvar as configurações de conexão.

  8. Prossiga para a configuração do módulo de solicitação do OAuth 2.0.

Instruções para criar uma conexão com Google no HTTP >Criar um módulo de solicitação OAuth 2.0

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

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

  2. Abra o módulo HTTP >Fazer uma solicitação OAuth 2.0.

  3. Clique em Adicionar 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 layout-auto html-authored no-header
    Nome da Conexão Insira o nome da conexão.
    Tipo de fluxo Código de Autorização
    Autorizar URI https://accounts.google.com/o/oauth2/v2/auth
    Token URI https://www.googleapis.com/oauth2/v4/token
    Escopo Adicionar escopos individuais. Para obter mais informações sobre escopos, consulte Escopos do OAuth 2.O para Google APIs na documentação do Google.
    Separador de escopo ESPAÇO
    ID do Cliente

    Insira sua ID de cliente do Google.

    Para criar uma ID de cliente, consulte Criar credenciais OAuth em Connect Adobe Workfront Fusion para Google Services usando um cliente OAuth personalizado.
    Segredo do Cliente

    Insira seu Segredo do Cliente do Google.

    Para criar um segredo de cliente, consulte Criar Credenciais OAuth em Connect Adobe Workfront Fusion para Google Serviços usando um cliente OAuth personalizado.
    Autorizar parâmetros

    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 Continuar para salvar as configurações de conexão.

  6. Prossiga para a configuração do módulo de solicitação do OAuth 2.0.

Instruções para conexão com Microsoft Graph API por meio do módulo HTTP > Fazer uma solicitação OAuth 2.0

Para obter instruções sobre Microsoft Graph API, consulte Chamar MS Graph REST API via Adobe Workfront Fusion HTTP > Fazer uma solicitação OAuth 2.0 para o módulo.

Configuração do módulo de solicitação OAuth 2.0

Quando tiver estabelecido uma conexão Oauth 2.0 conforme descrito em Criando uma conexão para uma OAuth solicitação, 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 >Fazer uma solicitação OAuth 2.0, 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.

Conexão
Para obter informações sobre como configurar uma conexão, consulte Criar uma conexão para uma solicitação OAuth neste artigo.
Avaliar todos os estados como erros (exceto para 2xx e 3xx)

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

Para obter mais informações, consulte Tratamento de erros em Adobe Workfront Fusion.

URL
Insira o URL para o qual você deseja enviar uma solicitação, como um endpoint de API, site etc.
Método
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 em Adobe Workfront Fusion.
Cabeçalhos
Adicione os cabeçalhos da solicitação no formulário de um objeto JSON padrão. Por exemplo, {"Content-type":"application/json"}
Cadeia de Consulta
Insira os pares de valor-chave da consulta desejados.
Tipo de corpo

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 uma forma de análise dos 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.

  • Aplicativo/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 multipart 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.

    • Texto

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

    • Arquivo

      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 >Obter um Arquivo ou Unidade Google >Baixar um Arquivo) ou insira o nome do arquivo e os dados do arquivo manualmente.

Analisar resposta

Habilite esta opção para analisar respostas automaticamente e converter respostas JSON e XML, de modo 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.

Tempo Limite
Insira o tempo limite da solicitação em segundos (1-300). O padrão é 40 segundos.
Compartilhar cookies com outros módulos HTTP
Habilite essa opção para compartilhar cookies do servidor com todos os módulos HTTP em seu cenário.
Certificado autoassinado
Faça upload do seu certificado se quiser usar o TLS usando seu certificado autoassinado.
Rejeitar conexões que estão usando certificados não verificados (autoassinados)
Habilite esta opção para rejeitar conexões que estejam usando certificados TLS não verificados.
Seguir redirecionamento
Ative essa opção para seguir os redirecionamentos de URL com respostas 3xx.
Seguir todos os redirecionamentos
Ative essa opção para seguir os redirecionamentos de URL com todos os códigos de resposta.
Desabilitar serialização de várias chaves de cadeia de caracteres de consulta como matrizes
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.
Solicitar conteúdo compactado

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

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

Usar TLS Mútuo

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
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43