Conexão HTTP v2

Introdução

Uma conexão HTTP v2, criada usando o conector HTTP v2, estabelece acesso pelo protocolo HTTP ou HTTPS a um serviço como uma REST API, GraphQL API ou formulário web. Depois que uma conexão é configurada, você pode criar instâncias de atividades HTTP v2 associadas a essa conexão para serem usadas como fontes (para fornecer dados em uma operação) ou como destinos (para consumir dados em uma operação).

Crie ou edite uma conexão HTTP v2

Uma nova conexão HTTP v2 é criada usando o conector HTTP v2 de um destes locais:

• A aba endpoints e conectores do projeto da paleta de componentes de design (consulte paleta de componentes de design).
• A página Conexões globais (consulte Criar um endpoint global em Conexões Globais).

Uma conexão HTTP v2 existente pode ser editada nestes locais:

• A aba endpoints e conectores do projeto da paleta de componentes de design (consulte paleta de componentes de design).
• A aba Componentes do painel do projeto (consulte menu de ações do componente na aba Componentes do painel Projeto).
• A página Conexões globais (consulte Editar um endpoint global em Conexões Globais).

Configurar uma conexão HTTP v2

Cada elemento da interface do usuário da tela de configuração de conexão HTTP v2 é descrito abaixo.

• Nome da conexão: Insira um nome para usar para identificar a conexão. O nome deve ser exclusivo para cada conexão HTTP v2 e não deve conter barras / ou dois pontos :. Este nome também é usado para identificar o endpoint HTTP v2, que se refere a uma conexão específica e suas atividades.

• URL base: Insira a URL base. A URL base é usada para testar a conexão. Se esse campo é usado em tempo de execução depende se o campo URL de atividade HTTP de uma atividade HTTP v2 é concluído:

  • Se uma URL parcial ou nenhuma URL for fornecida no campo URL de atividade HTTP, a URL usada no tempo de execução será concatenada da URL base e da URL de atividade HTTP.

  • Se uma URL completa for fornecida no campo URL de atividade HTTP, a URL base não será usada no tempo de execução.

• Autorização: Use o menu para selecionar o tipo de autenticação, resumido abaixo. A configuração de cada tipo de autenticação é descrita em Tipos de autenticação de conexão HTTP v2.

  • Chave API: Especifique um par chave-valor de API para enviar em cabeçalhos ou parâmetros de consultar.

  • Assinatura AWS: Especifique uma ID de chave de acesso da AWS, uma chave de acesso secreta, uma região, um serviço e um token de sessão para enviar usando o Amazon Web Services (AWS) Signature Versão 2 em cabeçalhos ou parâmetros de consultar.

  • Autenticação Básica: Especifique um nome de usuário e senha para enviar em cabeçalhos.

  • Bearer Token: Especifique um token portador para enviar em cabeçalhos.

  • Digest Auth: Especifique um nome de usuário, senha, realm, nonce, algoritmo, QOP, contagem de nonce, nonce de cliente e opaco para enviar em cabeçalhos.

  • Autenticação Hawk: Especifique um ID de autenticação Hawk, chave de autenticação, informações específicas do aplicativo, um ID de aplicativo e DLG para enviar em cabeçalhos.

  • Sem autenticação: Selecione para acessar o serviço anonimamente sem autorização.

  • OAuth 2.0: Especifique o tipo de concessão e forneça o endpoint do token OAuth, o ID do cliente, o segredo do cliente e o escopo para enviar nos cabeçalhos ou no corpo da solicitação.

• Repetir: Funciona somente ao usar um ambiente associado a um grupo de agentes privados. Esta configuração é usada para tentar novamente uma solicitação quando um endpoint HTTP v2 retorna um destes códigos de status: 500, 502, 503, ou 504.

  Esta configuração entra em vigor quando usada com agentes privados versão 10.34 ou posterior.

  Selecione a caixa de seleção Repetir para expandir opções de configuração adicionais:

  

  • Intervalo de repetição (segundos): Insira o número de segundos (máximo de 5 segundos) para aguardar entre o reenvio de uma solicitação ao endpoint HTTP v2.

  • Máx. de Tentativas: Insira o número máximo de tentativas (máximo de 5 tentativas) que uma solicitação será reenviada para o endpoint HTTP v2. Se a solicitação ainda falhar após o número máximo de tentativas, uma exceção com uma mensagem de erro será retornada no log de operação. Além disso, o agente privado registrará cada tentativa no jitterbit.log arquivo de log.

    Cada nova tentativa é tratada como parte da mesma execução de operação, onde apenas um único registro aparece no log de operação. Quaisquer ações de operação configuradas para executar operações abaixo são acionadas com base no status final da operação após a nova tentativa até o número máximo de novas tentativas.

• Configurações opcionais: Clique para expandir configurações opcionais adicionais:

  

  • Obter conteúdo de resposta em string base64: Selecione para retornar codificado em base64 responseContent das atividades HTTP v2.

  • Configurações de proxy: Use o menu para selecionar as configurações de proxy, uma destas opções:

    • Personalizado: As configurações de proxy são habilitadas usando as entradas especificadas nos campos adicionais que se tornam disponíveis quando esta opção é selecionada. Esta opção ignora a configuração de proxy do agente privado se existir.

      

      • Host: Digite o nome do hospedar do servidor proxy HTTP.
      • Porta: Insira a porta do servidor proxy HTTP.
      • Usuário: Digite o nome de usuário para autenticação do servidor proxy HTTP.
      • Senha: Digite a senha para autenticação do servidor proxy HTTP.
      • Domínio NTLM: Insira o domínio NTLM para autenticação do servidor proxy HTTP.
      • Permitir que certificados não verificados sejam usados pelo proxy: Selecione para permitir que certificados não verificados sejam usados pelo servidor proxy HTTP.

    • Padrão: As configurações de proxy são habilitadas, usando a configuração de proxy do agente privado se houver. Se as configurações de proxy não forem especificadas na configuração do agente, a configuração Default terá o mesmo resultado que a configuração Disable.

    • Disable: As configurações de proxy são desabilitadas, ignorando a configuração de proxy do agente privado se existir.

  • Propriedades HTTP avançadas: Se aplicável, defina estas opções avançadas:

    • Content-Type: Insira o content-type da estrutura de solicitação que é esperado pela API específica. Por exemplo, text/plain, application/json, application/x-www-form-urlencoded, etc. Se o método que está sendo usado não aceitar dados estruturados, ou se a API não exigir que o content-type seja especificado, deixe este campo em branco. Este campo não é afetado pela configuração Enviar cabeçalhos de solicitação na execução da atividade.

      Como alternativa, o content-type pode ser especificado em outros campos de configuração da IU ou fornecido na transformação da solicitação. Se content-type for especificado em vários lugares, esta ordem de precedência será seguida:

      1. Um Content-Type O cabeçalho fornecido na tabela Configurações adicionais de uma atividade HTTP v2 substitui todos os campos abaixo.
      2. O bodyContentType o campo especificado em uma transformação de solicitação substitui os campos restantes abaixo.
      3. Um Content-Type cabeçalho fornecido na transformação da solicitação headers nó substitui os campos restantes abaixo.
      4. Um Content-Type O cabeçalho fornecido no campo Cabeçalhos de solicitação de uma atividade HTTP v2 substitui o campo restante abaixo.
      5. Um Content-Type o cabeçalho fornecido no campo Cabeçalhos de Solicitação de uma conexão HTTP v2, se Enviar Cabeçalhos de Solicitação na Execução de Atividade estiver habilitado, tem a menor precedência.

      Nota

      Se um cabeçalho for definido em vários locais, cada instância do cabeçalho será adicionada à solicitação de uma atividade seguindo a ordem de precedência acima. Essa ordem é baseada em como os serviços normalmente lidam com cabeçalhos duplicados em uma solicitação.

    • Habilitar codificação de conteúdo: Selecione para enviar o Accept-Encoding cabeçalho com codificação Gzip. Este campo não é afetado pela configuração Send Request Headers in Activity Execution.

      Como alternativa, esse cabeçalho pode ser definido em outros campos de configuração da IU ou fornecido na transformação da solicitação. Se esse cabeçalho for especificado em vários lugares, essa ordem de precedência será seguida:

      1. Um Accept-Encoding cabeçalho fornecido na transformação da solicitação headers nó substitui todos os campos abaixo.
      2. Um Accept-Encoding O cabeçalho fornecido no campo Cabeçalhos de solicitação de uma atividade HTTP v2 substitui o campo restante abaixo.
      3. Um Accept-Encoding o cabeçalho fornecido no campo Cabeçalhos de Solicitação de uma conexão HTTP v2, se Enviar Cabeçalhos de Solicitação na Execução de Atividade estiver habilitado, tem a menor precedência.

      Nota

      Se um cabeçalho for definido em vários locais, cada instância do cabeçalho será adicionada à solicitação de uma atividade seguindo a ordem de precedência acima. Essa ordem é baseada em como os serviços normalmente lidam com cabeçalhos duplicados em uma solicitação.

    • Habilitar codificação de transferência em blocos: Selecione para enviar o Transfer-Encoding: chunked cabeçalho. Use esta opção se estiver transferindo grandes conjuntos de dados. Este campo não é afetado pela configuração Send Request Headers in Activity Execution.

      Como alternativa, esse cabeçalho pode ser definido em outros campos de configuração da IU ou fornecido na transformação da solicitação. Se esse cabeçalho for especificado em vários lugares, essa ordem de precedência será seguida:

      1. Um Transfer-Encoding cabeçalho fornecido na transformação da solicitação headers nó substitui todos os campos abaixo.
      2. A Transfer-Encoding O cabeçalho fornecido no campo Cabeçalhos de solicitação de uma atividade HTTP v2 substitui o campo restante abaixo.
      3. Um Transfer-Encoding o cabeçalho fornecido no campo Cabeçalhos de Solicitação de uma conexão HTTP v2, se Enviar Cabeçalhos de Solicitação na Execução de Atividade estiver habilitado, tem a menor precedência.

      Nota

      Se um cabeçalho for definido em vários locais, cada instância do cabeçalho será adicionada à solicitação de uma atividade seguindo a ordem de precedência acima. Essa ordem é baseada em como os serviços normalmente lidam com cabeçalhos duplicados em uma solicitação.

    • Permitir cifras fracas: Esta opção não está funcional no momento.

    • Manter ativo: Selecione para permitir que uma única conexão TCP permaneça aberta para várias solicitações e respostas HTTP.

    • Verificação do certificado SSL: Selecione para verificar o serviço validando o certificado SSL/TLS apresentado durante o processo de handshake.

    • Codificar URL de solicitação: Selecione para codificar URL a URL da solicitação.

    • Seguir redirecionamentos: Selecione para permitir que o conector redirecione com quaisquer redirecionamentos presentes na URL base. Se a URL base redirecionar e esta configuração não estiver selecionada, ocorrerá um erro ao testar a conexão e na primeira execução de uma operação. Quando esta opção é selecionada, o seguinte campo se torna visível:

      • Número máximo de redirecionamentos: Insira a quantidade de redirecionamentos que a conexão seguirá antes de retornar um erro.

    • Aplicável somente ao usar HTTPS: Use o menu para alterar a seleção de Negociar (padrão) para uma versão específica do TLS, se o serviço exigir, selecionando entre TLS 1.0, TLS 1.1, TLS 1.2 ou TLS 1.3.

    • Cabeçalhos de solicitação: Defina cabeçalhos HTTP para a conexão. Clique no ícone adicionar para adicionar um cabeçalho à tabela abaixo e inserir um par chave-valor para cada parâmetro de solicitação.

      Para salvar a linha, clique no ícone de envio na coluna mais à direita.

      Para editar ou excluir uma única linha, passe o mouse sobre a coluna mais à direita e use o ícone de edição ou excluir ícone .

      Para excluir todas as linhas, clique em Limpar tudo.

      Como alternativa, os cabeçalhos podem ser definidos em outros campos de configuração da IU ou fornecidos na transformação da solicitação. Os cabeçalhos que não compartilham uma chave são enviados cumulativamente, independentemente de onde são especificados.

      Se a mesma chave de cabeçalho for especificada em vários lugares, esta ordem de precedência será seguida:

      1. Um cabeçalho fornecido na transformação da solicitação headers O nó substitui todos os campos abaixo.
      2. Um cabeçalho fornecido no campo Cabeçalhos de solicitação de uma atividade HTTP v2 substitui o campo restante abaixo.
      3. Um cabeçalho fornecido no campo Cabeçalhos de solicitação de uma conexão HTTP v2 (este campo), se Enviar cabeçalhos de solicitação na execução da atividade estiver habilitado, tem a menor precedência.

      Nota

      Se um cabeçalho for definido em vários locais, cada instância do cabeçalho será adicionada à solicitação de uma atividade seguindo a ordem de precedência acima. Essa ordem é baseada em como os serviços normalmente lidam com cabeçalhos duplicados em uma solicitação.

      Importante

      Os campos na tabela Cabeçalhos de solicitação exibem o ícone de variável somente no modo de edição. Para que os valores variáveis desses campos sejam preenchidos em tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.

    • Enviar cabeçalhos de solicitação na execução da atividade: Selecione para passar cabeçalhos definidos em Cabeçalhos de solicitação para atividades HTTP v2. Consulte as ordens de precedência acima para determinar como os cabeçalhos definidos em uma conexão HTTP v2 interagem com cabeçalhos definidos em outros locais.

• Teste: Clique para verificar a conexão enviando uma solicitação HTTP GET usando a autorização configurada. Um teste é considerado bem-sucedido se qualquer código de status HTTP 2xx for retornado. A 405 Method Not Allowed a resposta também é tratada como bem-sucedida. Quando a conexão é testada, a versão mais recente do conector é baixada pelo(s) agente(s) no grupo de agentes associado ao ambiente atual. Este conector suporta a suspensão do download da versão mais recente do conector usando a Desabilitar atualização automática do conector política da organização.

• Salvar alterações: Clique para salvar e fechar a configuração de conexão.

• Descartar alterações: Após fazer alterações em uma configuração nova ou existente, clique para fechar a configuração sem salvar. Uma mensagem pede para você confirmar que deseja descartar as alterações.

• Excluir: Após abrir uma configuração de conexão existente, clique para excluir permanentemente a conexão do projeto e fechar a configuração (consulte Dependências, exclusão e remoção de componentes). Uma mensagem pede para você confirmar que deseja excluir a conexão.

Próximos passos

Após a criação de uma conexão HTTP v2, você coloca um tipo de atividade na quadro de design para criar instâncias de atividade a serem usadas como fontes (para fornecer dados em uma operação) ou como destinos (para consumir dados em uma operação).

As ações de menu para uma conexão e seus tipos de atividade são acessíveis a partir do painel do projeto e da paleta de componentes de design. Para obter detalhes, consulte Menus de ações em Noções básicas do conector.

Esses tipos de atividade estão disponíveis:

• PATCH: Aplica modificações parciais a um recurso existente em um serviço acessível pelo protocolo HTTP ou HTTPS e pode ser usado como origem ou destino em uma operação.

• CABEÇA: Recupera a linha de status e a seção de cabeçalho de um recurso em um serviço acessível pelo protocolo HTTP ou HTTPS e pode ser usado como origem ou destino em uma operação.

• PUBLICAR: Cria um novo recurso em um serviço acessível pelo protocolo HTTP ou HTTPS e pode ser usado como origem ou destino em uma operação.

• PEGAR: Recupera informações sobre um recurso em um serviço acessível pelo protocolo HTTP ou HTTPS e pode ser usado como origem ou destino em uma operação.

• OPÇÕES: Recupera informações sobre as opções de comunicação para um recurso em um serviço acessível pelo protocolo HTTP ou HTTPS e pode ser usado como origem ou destino em uma operação.

• VOLUME: Envia várias solicitações para um serviço acessível pelo protocolo HTTP ou HTTPS e pode ser usado como origem ou destino em uma operação.

• APAGAR: Exclui um recurso em um serviço acessível pelo protocolo HTTP ou HTTPS e pode ser usado como origem ou destino em uma operação.

• COLOCAR: Substitui um recurso existente em um serviço acessível pelo protocolo HTTP ou HTTPS e pode ser usado como origem ou destino em uma operação.