Conexão HTTP v2 (Beta)¶
Introdução¶
Uma conexão HTTP v2 (Beta), criada usando o conector HTTP v2 (Beta), estabelece acesso a um servidor HTTP por meio de um serviço Web RESTful (REST API). Depois que uma conexão é configurada, você pode criar instâncias de atividades HTTP v2 (Beta) 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).
Nota
Este conector oferece suporte a Ativar reautenticação ao alterar política da organização. Se ativado, uma alteração no Base URL, Autorização, Chave ou Nome de usuário nesta conexão exige que os usuários insiram novamente o Valor, Bearer Token, Client Secret ou Session Token (dependendo da Autorização selecionada) para a conexão.
Nota
Este conector é atualmente lançado como uma versão beta. Comentários sobre bugs e melhorias sugeridas podem ser fornecidos por meio do seu Gerente de sucesso do cliente (CSM).
Criar Ou Editar uma Conexão HTTP v2 (Beta)¶
Uma nova conexão HTTP v2 (Beta) é criada usando o conector HTTP v2 (Beta) de um destes locais:
- A aba Conexões da paleta de componentes de design (consulte Paleta de Componentes de Design).
- A página Conexões globais (consulte Criar uma conexão global em Conexões Globais).
Uma conexão HTTP v2 (Beta) existente pode ser editada a partir destes locais:
- A aba Conexões 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 Guia Componentes do painel do projeto).
- A página Conexões globais (consulte Editar uma conexão global em Conexões globais).
Configurar uma Conexão HTTP v2 (Beta)¶
Cada elemento da interface do usuário da tela de configuração da conexão HTTP v2 (Beta) é descrito abaixo.
Dica
Campos com ícone de variável suporte usando variáveis globais, variáveis do projeto e variáveis Jitterbit. Comece digitando um colchete aberto
[
no campo ou clicando no ícone da variável para exibir uma lista das variáveis existentes para escolher.
-
Nome da conexão: Digite um nome a ser usado para identificar a conexão. O nome deve ser exclusivo para cada conexão HTTP v2 (Beta) e não deve conter barras
/
ou dois pontos:
. Esse nome também é usado para identificar o endpoint HTTP v2 (Beta), que se refere a uma conexão específica e suas atividades. -
URL Base: Digite a URL base. A URL base é usada para testar a conexão. Se este campo é usado em tempo de execução depende se o campo HTTP Activity URL de uma atividade HTTP v2 (Beta) está preenchido:
-
Se um URL parcial ou nenhum URL for fornecido no campo HTTP Activity URL, o URL usado no tempo de execução será concatenado de Base URL e HTTP Activity URL.
-
Se um URL completo for fornecido no campo HTTP Activity URL, o Base URL não será usado no tempo de execução.
-
-
Autorização: Use o menu para selecionar o tipo de autorização, resumido abaixo. A configuração de cada tipo de autorização é descrita em Tipos de autorização de conexão HTTP v2 (Beta).
-
Chave API: Especifique um par chave-valor da API para enviar em cabeçalhos ou parâmetros de consultar.
-
Assinatura da AWS: Especifique um ID de chave de acesso da AWS, chave de acesso secreta, região, serviço e token de sessão para enviar usando 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 nos cabeçalhos.
-
Token do portador: Especifique um token de portador para enviar nos cabeçalhos.
-
Digest Auth: Especifique um nome de usuário, senha, domínio, nonce, algoritmo, QOP, contagem de nonce, nonce de cliente e opaco para enviar nos 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 nos cabeçalhos.
-
Sem autenticação: Selecione para acessar o servidor HTTP anonimamente sem autorização.
-
OAuth 2.0: Especifique o tipo de concessão e forneça o endpoint do token OAuth, ID do cliente, segredo do cliente, escopo e tipo de token para enviar nos cabeçalhos ou no corpo da solicitação.
-
-
Repetir: Funciona apenas ao usar um ambiente associado a um Grupo de Agentes Privados, esta configuração é usada para repetir uma solicitação quando um endpoint HTTP v2 (Beta) retornar um destes códigos de status:
500
,502
,503
, ou504
.Esta configuração entra em vigor quando usada com Agentes Privados versão 10.34 ou posterior.
Marque a caixa de seleção Repetir para expandir as opções de configuração adicionais:
-
Retry Interval (Seconds): Insira o número de segundos (máximo de 5 segundos) para aguardar entre o reenvio de um solicitação para o endpoint HTTP v2 (Beta).
-
Max Retries: Insira o número máximo de tentativas (máximo de 5 tentativas) que uma solicitação será reenviada para o endpoint HTTP v2 (Beta). Se a solicitação ainda falhar após o número máximo de tentativas, uma exceção com um erro mensagem será retornada no log de operação. Além disso, o Agente Privado registrará cada nova tentativa no
jitterbit.log
arquivo de log.Cada nova tentativa é tratada como parte da mesma execução da operação, onde apenas um único registro aparece na operação registro. Quaisquer ações de operação configuradas para executar operações abaixo são acionadas com base no status final do operação depois de tentar novamente até o número máximo de tentativas.
-
-
Configurações opcionais: Clique para expandir as configurações opcionais adicionais:
-
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 ficam 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: Digite o domínio NTLM para autenticação do servidor proxy HTTP.
- Permitir certificados não verificados 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 existir. Se as configurações de proxy não forem especificadas na configuração do agente, a configuração Padrão terá o mesmo resultado que a configuração Desativar.
-
Desativar: As configurações de proxy estão desativadas, ignorando a configuração de proxy do Agente Privado se existir.
-
-
Propriedades HTTP avançadas: Se aplicável, defina estas opções avançadas:
-
Tipo de conteúdo: Insira o tipo de conteúdo 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 tipo de conteúdo seja especificado, deixe este campo em branco.Como alternativa, o tipo de conteúdo pode ser especificado em outros campos de configuração da interface do usuário ou fornecido na transformação de solicitação. Se o tipo de conteúdo for especificado em vários lugares, esta ordem de precedência será seguida:
- A
Content-Type
O cabeçalho fornecido na tabela Additional Settings de uma atividade HTTP v2 (Beta) substitui todos os campos abaixo. - O
bodyContentType
campo especificado em uma transformação de solicitação substitui os campos restantes abaixo. - A
Content-Type
cabeçalho fornecido na transformação de solicitaçãoheaders
nó substitui os campos restantes abaixo. - A
Content-Type
O cabeçalho fornecido no campo Request Headers de uma atividade HTTP v2 (Beta) substitui os campos restantes abaixo. - A
Content-Type
O cabeçalho fornecido no campo Request Headers de uma conexão HTTP v2 (Beta) substitui o campo restante abaixo. - A
Content-Type
cabeçalho fornecido no campo Content-Type de uma conexão HTTP v2 (Beta) (este campo) tem a menor precedência.
- A
-
Ativar codificação de conteúdo: Selecione para enviar o
Accept-Encoding
cabeçalho com codificação Gzip.Como alternativa, esse cabeçalho pode ser definido em outros campos de configuração da interface do usuário ou fornecido na transformação de solicitação. Se este cabeçalho for especificado em vários lugares, esta ordem de precedência será seguida:
- Um
Accept-Encoding
cabeçalho fornecido na transformação de solicitaçãoheaders
nó substitui todos os campos abaixo. - Um
Accept-Encoding
O cabeçalho fornecido no campo Request Headers de uma atividade HTTP v2 (Beta) substitui os campos restantes abaixo. - Um
Accept-Encoding
O cabeçalho fornecido no campo Request Headers de uma conexão HTTP v2 (Beta) substitui o campo restante abaixo. - Um
Accept-Encoding
cabeçalho ativado pelo campo Ativar codificação de conteúdo de uma conexão HTTP v2 (Beta) (este campo) tem a menor precedência.
- Um
-
Enable Chunked Transfer Encoding: Selecione para enviar o
Transfer-Encoding: chunked
cabeçalho. Use esta opção se estiver transferindo grandes conjuntos de dados.Como alternativa, esse cabeçalho pode ser definido em outros campos de configuração da interface do usuário ou fornecido na transformação de solicitação. Se este cabeçalho for especificado em vários lugares, esta ordem de precedência será seguida:
- A
Transfer-Encoding
cabeçalho fornecido na transformação de solicitaçãoheaders
nó substitui todos os campos abaixo. - A
Transfer-Encoding
O cabeçalho fornecido no campo Request Headers de uma atividade HTTP v2 (Beta) substitui os campos restantes abaixo. - A
Transfer-Encoding
O cabeçalho fornecido no campo Request Headers de uma conexão HTTP v2 (Beta) substitui o campo restante abaixo. - A
Transfer-Encoding: chunked
cabeçalho ativado no campo Ativar codificação de conteúdo de uma conexão HTTP v2 (Beta) (este campo) tem a menor precedência.
- A
-
Permitir cifras fracas: Esta opção não está funcionando no momento.
-
Keep Alive: Selecione para permitir que uma única conexão TCP permaneça aberta para várias solicitações e respostas HTTP.
-
Aplicável apenas ao usar HTTPS: Use o menu para alterar a seleção de Negociar (padrão) para uma versão TLS específica se o servidor HTTP exigir, selecionando TLS 1.0, TLS 1.1, TLS 1.2 ou TLS 1.3.
-
Request Headers: Defina cabeçalhos HTTP para a conexão. Clique no ícone de adição
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 ícone de exclusão
.
Para excluir todas as linhas, clique em Limpar tudo.
Como alternativa, os cabeçalhos podem ser definidos em outros campos de configuração da interface do usuário ou fornecidos na transformação de 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 locais, esta ordem de precedência será seguida:
- Um cabeçalho fornecido na transformação de solicitação
headers
nó substitui todos os campos abaixo. - Um cabeçalho fornecido no campo Request Headers de uma atividade HTTP v2 (Beta) substitui o campo restante abaixo.
- Um cabeçalho fornecido no campo Request Headers de uma conexão HTTP v2 (Beta) (este campo) tem a menor precedência.
Importante
Os campos na tabela Cabeçalhos de solicitação exibem o ícone de variável
apenas no modo de edição. Para que os valores das variáveis desses campos sejam preenchidos em tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.
- Um cabeçalho fornecido na transformação de solicitação
-
-
-
Test: 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
resposta também é tratada como bem-sucedida. -
Save Changes: Clique para salvar e fechar a configuração da 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 solicita que você confirme 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 solicita que você confirme que deseja excluir a conexão.
Próximos Passos¶
Após a criação de uma conexão HTTP v2 (Beta), 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 no painel do projeto e na paleta de componentes de design. Para obter detalhes, consulte Menus de ações em Noções básicas do conector.
Estes tipos de atividade estão disponíveis:
-
CORREÇÃO: Aplica modificações parciais a um recurso existente em um servidor HTTP 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 servidor HTTP e pode ser usado como origem ou destino em uma operação.
-
PUBLICAR: Cria um novo recurso em um servidor HTTP e pode ser usado como origem ou destino em uma operação.
-
PEGAR: Recupera informações sobre um recurso em um servidor HTTP e pode ser usado como fonte ou destino em uma operação.
-
OPÇÕES: Recupera informações sobre as opções de comunicação de um recurso em um servidor HTTP e pode ser usado como origem ou destino em uma operação.
-
APAGAR: Exclui um recurso em um servidor HTTP e pode ser usado como origem ou destino em uma operação.
-
COLOCAR: Substitui um recurso existente em um servidor HTTP e pode ser usado como origem ou destino em uma operação.