HTTP Request

UiPath.Web.Activities.Http.NetHttpClient

Importante: esta atividade está disponível em versões do pacote WebAPI a partir da 2.0.0-preview e da 2.3.0 GA. Para a experiência legada, use a atividade HTTP Request (legado) anterior incluída nas versões do WebAPI anteriores à 2.0.0-preview.

Description

Use a atividade HTTP Request na pré-visualização da WebAPI 2.0.0 para automatizar e simplificar a execução de solicitações para servidores da Web ou APIs. A atividade HTTP Request ajuda a:

• Envie e receba dados com segurança entre sistemas.
• Carregar arquivos e dados usando formulários.
• Lide com os erros de forma graciosa ao repetir as solicitações se algo der errado.
• Conecte-se com segurança usando SSL para proteger seus dados.
• Gerenciar cookies e proxies automaticamente para lidar com sessões e restrições de rede.

Compatibilidade do projeto

Windows | Multiplataforma

Windows, configuração multiplataforma

Propriedades do corpo da atividade
Método de Solicitação *	Selecione como sua solicitação HTTP deve interagir com o servidor: GET— recupera dados sem modificá-los. POST— Envia dados para o servidor, geralmente para criar ou atualizar um recurso. PUT— atualiza um recurso existente. DELETE— remove um recurso especificado do servidor. HEAD— Semelhante a GET, mas recupera apenas cabeçalhos sem o conteúdo do corpo. OPÇÕES— fornece informações sobre as opções de comunicação disponíveis no servidor. PATCH— Atualiza parcialmente um recurso existente. TRACE—Usado para fins de diagnóstico, retornando a solicitação recebida de volta para o cliente.
URL da Solicitação *	Forneça o endereço web do servidor para onde você deseja enviar sua solicitação. Por exemplo, https://store.example.com/search.
Parâmetros	Adicione detalhes específicos do servidor à sua solicitação como pares de chave-valor. Por exemplo, query: "laptop", sortBy: "price".
Cabeçalhos	Adicione instruções específicas do servidor ou detalhes de autenticação como pares de chave-valor. Por exemplo, Authorization: "Bearer <your_access_token>", Accept: "application/json".
Tipo de corpo da solicitação *	Selecione o tipo de conteúdo que você deseja enviar para o servidor: Nenhum— não envia dados, geralmente para métodos de recuperação. Texto— Envia dados em texto simples, geralmente para métodos POST e PUT. Após terem sido selecionados, os seguintes campos serão exibidos: Tipo de conteúdo de texto— Selecione o formato do texto que você deseja enviar em sua solicitação HTTP, para que o servidor saiba como interpretá-lo: text/simples— Texto simples regular. text/html—Texto formatado em HTML. text/css— Texto formatado em CSS. text/csv— dados estruturados formatados como CSV. text/xml—Texto formatado em XML, destinado para leitura humana. application/xml— texto formatado em XML, destinado para aplicativos processarem. application/json— texto formatado em JSON. Texto— escreva o texto ou os dados reais que deseja enviar em sua solicitação. Codificação de texto— selecione o formato de codificação para a carga de texto, como Unicode, ASCII ou ISO. Isso garante que o servidor de recebimento leia com precisão sua carga de texto. URL do formulário codificado— envia dados formatados como pares simples de valor-chave. Após selecionado, o seguinte campo é exibido: Dados de formulário codificados por URL— Forneça os pares de chave-valor. Por exemplo, searchQuery: "Smartphone", brand: "XYZ", inStock: "true". Dados de formulário multipart— envia arquivos ou dados complexos. Use-o quando precisar combinar diferentes tipos de dados em sua solicitação. Após terem sido selecionados, os seguintes campos serão exibidos: Arquivos de recursos— Forneça o nome dos arquivos armazenados em seu projeto como objetos IResource. Arquivos locais— Forneça o caminho para um arquivo localizado no seu dispositivo. Por exemplo, "C:/Images/product-photo.jpg". Partes de dados do formulário— Fornece uma coleção de FormDataPart Objetos: TextFormDataPart— Para cargas úteis de strings, como JSON ou texto simples. BinaryFormDataPart — Para matrizes de bytes brutos. FileFormDataPart—Para fluxos de arquivos baseados em um determinado caminho. Por exemplo, uma coleção FormDataPart usando o Editor de Expressão: #VB New List(Of FormDataPart) From { New TextFormDataPart("{""jsonKey"":""jsonValue""}", "textPart", Encoding.UTF8, "application/json"), New BinaryFormDataPart(Encoding.UTF8.GetBytes("binaryContent"), "binaryPart", "application/octet-stream"), New FileFormDataPart("C:/Work/testfile.txt", "filePart", "text/plain") } Cada tipo FormDataPart vem com vários construtores, permitindo que você se beneficie de padrões comumente usados. A atividade atribui automaticamente o cabeçalho Content-Type correto para cada FileFormDataPart. É possível substituir esse cabeçalho manualmente. Para listas de arquivos, você não pode substituir o cabeçalho atribuído automaticamente. Para listas de arquivos de recursos, a atividade usa o tipo MIME disponível. Dados de formulário codificados para URL— Fornecem pares simples de chave-valor. Binário— Envia dados brutos. Após selecionado, o seguinte campo é exibido: Carga binária— forneça a carga de dados brutos, como imagens, vídeos, arquivos grandes ou dados de streaming. Por exemplo, enviando uma imagem em binário: File.ReadAllBytes("C:/Images/product-image.jpg") Stream— Envia dados contínuos, como carregar um arquivo grande (áudio ou vídeo), quando os dados não podem ser carregados totalmente na memória de uma vez. Após selecionado, o seguinte campo é exibido: Arquivo local— Forneça o caminho do arquivo grande, por exemplo: File.OpenRead("C:/Videos/large-video.mp4") A atividade atribui automaticamente o cabeçalho Content-Type correto ao arquivo carregado. É possível substituir esse cabeçalho manualmente.

Painel de Propriedades
Importação cURL e testes de tempo de design Esta seção ajuda você a configurar a atividade por meio dos fragmentos de código cURL e realizar testes de tempo de design da solicitação.	Texto do comando cURL— Campo de texto de tempo de design multilinha onde um comando cURL completo pode ser colado. Compatível com os estilos `cm e bash. Botão de importação cURL —botão de ação que dispara imediatamente a análise/importação do Texto de comando do cURL atual para a atividade (método, URL, cabeçalhos, corpo, autenticação, arquivos). Botão de solicitação de teste —botão de ação que executa a solicitação configurada no momento do design. Ao executar, ele alterna para Cancelar. Na conclusão ou cancelamento, ele é revertido para Teste e atualiza o campo Relatório com resposta ou erro formatado. Relatório —área de texto de várias linhas usada para exibir o resultado da última importação do cURL ou execução de teste em tempo de design (resumo do sucesso, detalhes do mapeamento, avisos ou erros).
Opções do cliente Esta seção ajuda você a definir as configurações relacionadas à conexão.	Desabilitar verificação de SSL— Ignora as verificações de segurança de SSL. Útil para testes (True), não recomendada para produção (False, padrão). Protocolo TLS— Seleciona o protocolo TLS para conexões seguras. As opções disponíveis são Automático (padrão), TLS 1.2 e TLS 1.3. Habilitar cookies— Por padrão, habilita o manuseio automático de cookies (Verdadeiro). Defina como False para desabilitar o processamento automático de cookies. Certificado de cliente— Indica o caminho para o certificado de cliente para autenticação com APIs seguras. Por exemplo, "C:/certificates/client-cert.pfx". Senha segura do certificado do cliente— Armazena a senha segura para o certificado do cliente fornecido. Por exemplo, "certPassword". Alterne entre senhas simples e seguras selecionando o ícone de mais e escolhendo a opção desejada: Usar string simples e Usar string segura. Configuração de proxy— Configura proxies personalizados, incluindo suporte para autenticação e listas de ignorados. Por exemplo, "http://proxy.example.com:8080".
Autenticação Esta seção ajuda a definir como a atividade se autentica no servidor.	Autenticação— selecione o método de autenticação. As opções disponíveis são: Sem autenticação— O servidor não requer validação do usuário para aceitar sua solicitação. Autenticação básica— Fornece a validação do usuário para o servidor de recebimento por meio do Nome de usuário e da Senha segura. Alterne entre senhas simples e seguras selecionando o ícone de mais e escolhendo a opção desejada: Usar string simples e Usar string segura. Token do portador— fornece validação do usuário para o servidor de recebimento por meio de um token do portador exclusivo gerado após o logon. Autenticação negociada—Use o esquema HTTP Necessário para o runtime selecionar Kerberos ou NTLM (e opcionalmente Resumir) com base em desafios do servidor. Quando a Autenticação estiver definida como Autenticação negociada e Usar credenciais do sistema operacional = True, o contexto atual do usuário do sistema operacional será usado (token de logon do Windows; no Linux/macOS, um tíquete do Kerberos existente, por exemplo, do kinit). Defina Usar credenciais do sistema operacional = False para habilitar o campo Credenciais personalizadas; forneça uma CredentialDeRede (domínio/nome de usuário/senha ou senha segura).
Opções de solicitação Esta seção ajuda a definir o comportamento da solicitação.	Cookies adicionais— especifique manualmente cookies extras como pares de chave-valor. Tempo limite da solicitação— Especifique o tempo máximo de espera, em milissegundos, antes que a solicitação seja anulada. O valor padrão é 10.000 milissegundos (10 segundos). Continuar com erro— Decida se a automação deve continuar mesmo quando a atividade gerar um erro ( Opção padrão). Para interromper a automação quando ocorrer um erro, use False. Seguir redirecionamentos— Decida se sua solicitação deve seguir automaticamente os redirecionamentos de URL fornecidos pelo servidor (True, opção padrão). Para ignorar os redirecionamentos e usar a resposta inicial, use False. Redirecionamentos máximos— especifique quantos redirecionamentos automáticos sua solicitação deve seguir antes de parar. O valor padrão é 3.
Política de nova tentativa Esta seção ajuda você a definir o mecanismo de nova tentativa em caso de falha da solicitação.	Tipo de política de repetição— Especifique o método para repetir as solicitações. As opções disponíveis são: Sem nova tentativa— Sua solicitação chama o servidor apenas uma vez. Se ela falhar, nenhuma tentativa adicional ocorrerá. Nova tentativa básica— repete a solicitação após falhas usando um atraso fixo. Contagem de novas tentativas— especifique o número de vezes a tentar novamente. O valor padrão é 3. Atraso— especifique o tempo fixo entre tentativas em milissegundos. O valor padrão é 500 milissegundos (0,5 segundo). Usar cabeçalho Repetir-Após— Decida se a solicitação deve usar o cabeçalho Tentar-Após recomendado pelo servidor ( Opção padrão). Para ignorar o valor do cabeçalho Retry-After , use False. Limite de atraso— especifique o atraso máximo permitido entre as tentativas Repetição-Após , em milissegundos. O valor padrão é 30.000 milissegundos (30 segundos). Tentar novamente códigos de status— especifique os códigos de status que devem acionar novas tentativas. Backoff exponencial— Novas tentativas com atrasos crescentes entre cada tentativa. Contagem de novas tentativas— especifique o número de vezes a tentar novamente. O valor padrão é 3. Atraso inicial— Especifique o tempo de atraso antes da primeira tentativa, em milissegundos. O valor padrão é 500 milissegundos (0,5 segundo). Multiplicador— especifique o número usado para aumentar o atraso após cada solicitação com falha. O valor padrão é 2, o que duplica o atraso a cada vez. Usar instabilidade— para atrasos, decida se você quer adicionar um deslocamento aleatório entre 0 e 100 milissegundos para evitar novas tentativas sincronizadas (Verdadeiro, padrão). Usar cabeçalho Repetir-Após— Decida se a solicitação deve usar o cabeçalho Tentar-Após recomendado pelo servidor ( Opção padrão). Para ignorar o valor do cabeçalho Retry-After , use False. Limite de atraso— especifique o atraso máximo permitido entre as tentativas Repetição-Após , em milissegundos. O valor padrão é 30.000 milissegundos (30 segundos). Tentar novamente códigos de status— especifique os códigos de status que devem acionar novas tentativas.
Opções de resposta Esta seção ajuda você a personalizar como a resposta será retornada pelo servidor.	Sempre salvar resposta como arquivo— Forçar a gravação do corpo da resposta no disco mesmo quando um nome de arquivo de anexo não é inferido. Habilitar informações de depuração—Habilitar a captura de depuração estendida (metadados brutos de solicitação/resposta, instantâneo de cabeçalhos, tempo, detalhes de nova tentativa) e saída para o objeto de resposta ou durante o teste de tempo de design. Nome do arquivo de saída— Substitua o nome do arquivo fornecido pelo servidor (por exemplo, Content-Disposition). Pasta de destino do arquivo de saída—Controle a pasta de destino para os arquivos de resposta salvos. Se o arquivo já existir — defina a estratégia de colisões quando um arquivo com o nome resolvido já existir na pasta de destino. Opções: Renomeação automática — acrescente um sufixo incremental (_1, _2, …) para produzir um nome de arquivo exclusivo. Substituir — substitua o arquivo existente. Parar e descartar — Anula a operação de salvamento (e fluxo de trabalho se a exceção não for tratada) deixando o arquivo existente intacto.
Saída Esta seção ajuda a capturar e armazenar a resposta retornada pelo servidor.	Conteúdo da resposta— Captura a resposta do servidor e a armazena em uma variável, para processamento futuro. Ela inclui: StatusCode— Código de status de resposta HTTP. TextContent— Resposta como texto simples (se disponível). BinaryContent— Dados de resposta brutos para conteúdo que não seja de texto. Arquivo— Resposta salva como arquivo (ILocalResource) em sua pasta Downloads. Os nomes de arquivo são provenientes de cabeçalhos de resposta ou gerados automaticamente para evitar que os arquivos sejam substituídos. Cabeçalhos— Todos os cabeçalhos de resposta HTTP. CabeçalhosDeConteúdo—Cabeçalhos especificamente relacionados ao conteúdo da resposta. Por exemplo, Content-Type e Content-Length. RawRequestDebuggingInfo—String opcional contendo detalhes de solicitação/resposta de baixo nível capturados (por exemplo linha de solicitação construída, cabeçalhos, novas tentativas, tempo) preenchida apenas quando a depuração estiver habilitada; Caso contrário, string vazia.