activities
latest
false
Importante :
A tradução automática foi aplicada parcialmente neste conteúdo.
UiPath logo, featuring letters U and I in white
Atividades de Desenvolvedor
Last updated 26 de nov de 2024

HTTP Request

UiPath.WebAPI.Activities.HttpClient

Description

Permite que você execute solicitações HTTP para uma API da web especificada. Ao arrastar pela primeira vez esta atividade para o painel Designer , a janela Assistente de solicitação HTTP é exibida, fornecendo uma maneira mais fácil de criar solicitações e visualizar as respostas do servidor.

Nota: Se o código de status HTTP retornado (StatusCode) for 0, isso significa que o servidor não retornou uma resposta real por algum motivo. Isso geralmente aponta para alguns problemas de conectividade ou rede que você pode estar tendo.
Importante: o pacote da WebAPI não é compatível com as seguintes atividades: UiPath.Salesforce.Activities e UiPath.Jira.Activities.

Compatibilidade do projeto

Windows - Legada | Windows | Multiplataforma

Windows, Windows - configuração herdada

A Janela do Assistente de Importação

Isso pode ser usado para importar uma solicitação HTTP em um formato CURL.

A janela do assistente de solicitação HTTP

Todos os campos presentes no assistente também estão disponíveis no painel de Propriedades. Como resultado, você ainda pode editar suas preferências após fechar o assistente. Você pode configurar a atividade no assistente usando valores codificados ou variáveis.

Observação: quando variáveis são usadas, a funcionalidade de visualização não está disponível.
docs image

A guia Criador de solicitações

  • End Point — O URL para o qual deseja fazer a solicitação. Os segmentos personalizados dever ser colocados entre chaves "{}" e definidos na seção Parâmetros. Por exemplo, esse URL https://platform.uipath.com/odata/Robots(28) pode ser escrito como https://platform.uipath.com/odata/Robots({id}), e o valor do parâmetro id pode ser fornecido na seção Parâmetros como um UrlSegment.
  • URL de visualização - Uma visualização da URL fornecida no campo End Point , levando em consideração as informações fornecidas na seção Parâmetros .
  • Enable SSL certificate verification — Marcar essa caixa para verificar os certificados SSL ao enviar uma solicitação. Falhas de verificação resultarão no cancelamento da solicitação.
  • Tempo limite — especifica a quantidade de tempo (em milissegundos) para aguardar que a atividade seja executada antes de gerar um erro. O valor padrão é de 6000 milissegundos (6 segundos).
  • Certificado do cliente – O local no qual o arquivo do Certificado do cliente é armazenado. O caminho completo deve ser fornecido. A codificação de certificados compatível é X.509 e as extensões compatíveis são .pfx e .p12. É compatível com a verificação de handshake bidirecional.
    Observação: o caminho não deve ser escrito entre aspas.
  • Senha do Certificado do Cliente - A senha que corresponde ao arquivo do Certificado do Cliente que você está usando.
  • Método de solicitação - O método de solicitação a ser usado ao chamar a API. Os seguintes verbos HTTP são suportados: GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH e MERGE. Por padrão, o método GET é selecionado.
  • Autenticação - Especifica o protocolo de autenticação a ser usado ao chamar a API. Os seguintes protocolos são suportados:

    • Nenhum - A opção padrão. Ele deve ser usado se o servidor da web para o qual você está enviando solicitações não requer um protocolo de autenticação.
    • Http simples - esta opção deve ser selecionada se a API para a qual você está fazendo solicitações usa um protocolo de autenticação HTTP simples. Se escolhido, dois campos adicionais são exibidos - Username e Password, que devem ser preenchidos com credenciais válidas para a API especificada.
    • OAuth1 - Esta opção deve ser selecionada se a API para a qual você está fazendo solicitações usa um protocolo OAuth1. Se escolhido, quatro campos são exibidos: Chave do Consumidor, Segredo do Consumidor, Token de Acesso, Segredo do Token de Acesso.
    • OAuth2 - Esta opção deve ser selecionada se a API para a qual você está fazendo solicitações usa um protocolo OAuth2. Se escolhido, o campo Access Token é exibido. Esse token de acesso geralmente é gerado como resposta a outra solicitação HTTP para a API indicada.

A Seção de Parâmetros

  • Adicionar Parâmetro - Adiciona uma nova linha na tabela Parâmetros, do tipo GetOrPost . Uma nova linha não é adicionada se a linha anterior não for preenchida.
  • Adicionar cabeçalho — Adiciona uma nova linha na Tabela de Parâmetros, com o tipo HttpHeader. Uma nova linha não é adicionada se a linha anterior não for preenchida.

    Observação: Caso você queira adicionar vários valores para um cabeçalho, eles devem ser concatenados por vírgula (,).
  • Adicionar segmento de URL — Adiciona uma nova linha na Tabela Parâmetros, com o tipo SegmentosDeURL.Uma nova linha não é adicionada se a linha anterior não for preenchida.
  • Excluir - Remove uma linha selecionada na tabela Parâmetros. Se uma linha não for selecionada, este botão é desabilitado.

A Tabela de Parâmetros

  • Nome - O nome do parâmetro, cabeçalho ou segmento de URL.
  • Valor — O valor do parâmetro, cabeçalho ou segmento de URL.
  • Tipo - O tipo de linha. As seguintes opções estão disponíveis:

    • GetOrPost - Indica que a linha é um parâmetro que pode ser utilizado em requisições.
    • HttpHeader - Indica que a linha adicionada na tabela Parâmetros é um cabeçalho de solicitação a ser enviado ao fazer a chamada da API.
    • UrlSegment - Indica que a linha adicionada é um fragmento ou a URL fornecida no campo Ponto final .

      Observação: em alguns casos, pode ser retornado um erro informando que não podem existir parâmetros duplicados. Isso pode ser causado por solicitações de autenticação que precisam conter os parâmetros Senha e Nome de usuário . Nesses casos, recomendamos passá-los usando a propriedade Body .

A Seção de Anexos

  • Add Attachment - Permite adicionar um arquivo à requisição HTTP realizada, criando uma nova linha. Ativado somente quando o Método de solicitação é definido como POST ou PUT.
  • Excluir Anexo - Permite excluir uma linha adicionada anteriormente, na seção Anexos .
  • Nome - O nome do arquivo que você deseja anexar.
  • Caminho do arquivo — O caminho completo do arquivo que você deseja anexar.
  • Tipo - Indica que tipo de informação você está enviando. Este campo é preenchido automaticamente com Anexo.Visualização - permite visualizar a solicitação HTTP criada e abre a guia Resposta .

A guia Resposta

Essa guia permite que você visualize a solicitação que você deseja incluir em seu fluxo de trabalho. Pode ser acessada selecionando o botão Pré-visualização no assistente de Solicitação HTTP assim que você preencher todos os campos e configurar a solicitação. Ou então, você também pode alterar a guia na parte superior do assistente.



Esta página compreende o seguinte:

  • Informações da Solicitação - Esta seção exibe detalhes sobre a solicitação que foi executada. Ele exibe a URL da solicitação, o método e o código de status.
  • Preview Response - Exibe a resposta do servidor web.
  • Raw Body - Exibe a resposta do servidor web, de forma bruta.
  • Response Info - Exibe detalhes sobre a resposta do servidor web. Ele exibe o status e o código da resposta e o cabeçalho do tipo de conteúdo suportado.
  • Baixar Recurso - Permite baixar os recursos solicitados para um arquivo indicado.
  • Atualizar - permite que você execute a solicitação novamente.
Painel de Propriedades

CertificateAuthentication do Cliente

  • CertificadoDoCliente – O local no qual o arquivo do Certificado do Cliente é armazenado. O caminho completo deve ser fornecido. A codificação de certificados compatível é X.509 e as extensões compatíveis são .pfx e .p12. É compatível com a verificação de handshake bidirecional.
  • SenhaDoCertificadoDoCliente - A senha que corresponde ao arquivo do Certificado do Cliente que você está usando.
  • Ativar verificação de certificado SSL - Verifique os certificados SSL ao enviar uma solicitação. Falhas de verificação resultarão no cancelamento da solicitação. Este campo suporta apenas valores booleanos (Verdadeiro, Falso).
  • SenhaSeguraDoCertificadoDoCliente - A senha para o arquivo do Certificado do Cliente especificado, na forma de uma string de segurança. Este campo é compatível apenas com variáveis SecureString.

Comum

  • ContinuarComErro — especifica se a automação deve continuar mesmo quando a atividade gera um erro. Este campo só aceita valores booleanos (True, False). O valor padrão é False. Como resultado, se o campo estiver em branco e um erro for lançado, a execução do projeto será interrompida. Se o valor for definido como True, a execução do projeto prosseguirá mesmo com erros.

    Observação: se essa atividade estiver incluída na atividade Try Catch e o valor da propriedade ContinuarComErro for True, nenhum erro será capturado quando o projeto for executado.
  • NomeDeExibição - o nome de exibição da atividade.
  • Tempo limite (milissegundos) — especifica a quantidade de tempo (em milissegundos) para aguardar que a atividade seja executada antes de gerar um erro. O valor padrão é de 6000 milissegundos (6 segundos).

Entrada

  • AcceptFormat - O formato no qual receber a resposta do servidor web. As seguintes opções são suportadas: ANY - o valor padrão, XML, JSONe CUSTOM. Ao escolher o CUSTOM AcceptFormat, se um parâmetro de cabeçalho Accept ou accept estiver presente, ele será enviado como o formato de aceitação personalizado. Se nenhum parâmetro de cabeçalho for definido, accept obterá o valor padrão RestSharp: application/json, aboveapplication/xml, text/json, text/x-json, text/javascript, text/xml.
  • Método de solicitação - O método de solicitação a ser usado ao chamar a API. Os seguintes verbos HTTP são suportados: GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH e MERGE. Por padrão, o método GET é selecionado.
    Observação: a solicitação HTTP funciona corretamente apenas com o pacote RestSharp versão 106.11.2 ou inferior. Ele retorna um erro quando o RestSharp versão 106.11.4 ou superior é instalado.
  • URL de solicitação - a URL para a qual você deseja fazer a solicitação. Os segmentos personalizados devem ser colocados entre chaves "{}" e definidos na seção Parâmetros . Por exemplo, este URL https://platform.uipath.com/odata/Robots(28) pode ser escrito como https://platform.uipath.com/odata/Robots{id}e o valor do parâmetro id pode ser fornecido na janela URLSegments .

Diversos

  • Privado - Se selecionado, os valores de variáveis e argumentos não são mais registrados no nível Verbose.

OAuth1

  • ConsumerKey - A chave do consumidor a ser usada se a API para a qual você está fazendo solicitações for baseada no protocolo de autenticação OAuth1.
  • SegredoDoConsumidor — O segredo do consumidor a ser usado se a API para a qual estiver fazendo solicitações for baseada no Protocolo de autenticação OAuth1.
  • OAuth1Token - O token de acesso a ser utilizado se a API para a qual você está fazendo solicitações for baseada no protocolo de autenticação OAuth1, após a aprovação de uma solicitação de autorização para o consumidor.
  • SegredoDoTokenDoOAuth1 — O segredo para ser usado se a API para a qual você estiver fazendo solicitações for baseada no protocolo para autenticação OAuth1, após a aprovação de uma solicitação de autorização para o consumidor.

OAuth2

  • OAuth2Token - O token de acesso a ser usado se a API para a qual você está fazendo solicitações for baseada no protocolo de autenticação OAuth2. Esse token de acesso geralmente é gerado como resposta a outra solicitação HTTP para a API indicada.

Opções

  • Anexos - Permite que você anexe arquivos a solicitações. Selecione o botão Reticências para abrir a janela Anexos e adicionar todos os arquivos necessários.
  • Corpo - O corpo da solicitação.
  • BodyFormat - O formato em que o corpo deve estar. Por padrão, é preenchido com application/xml. Este campo suporta strings e variáveis de string.
  • Cookies - Os cookies na solicitação HTTP. Selecione o botão Reticências para abrir a janela Cookies.
  • Anexos de arquivo — Listagem de anexos para a solicitação.
  • Nome do arquivo para anexo de resposta - O nome do arquivo a ser usado para o arquivo retornado pela solicitação.
  • Cabeçalhos - Permite que você inclua cabeçalhos personalizados na solicitação HTTP. Selecione o botão Reticências para abrir a janela Cabeçalhos.
  • Parâmetros - Os parâmetros da solicitação. Selecione o botão Reticências para abrir a janela Parâmetros, que corresponde à seção Parâmetros.
  • SegmentosDeURL - Segmentos personalizados adicionados ao URL do ponto de extremidade entre chaves "{}". Selecione o botão Reticências para abrir a janela SegmentosDeURL. Por exemplo, a URL https://platform.uipath.com/odata/Robots(28) pode ser escrita como https://platform.uipath.com/odata/Robots{id}, e o valor do parâmetroid pode ser fornecido na janela SegmentosDeURL. Este campo é compatível apenas com strings e variáveis string.

Saída

  • Cabeçalhos — A resposta recebida da solicitação HTTP.
  • Anexo de resposta - O anexo salvo da resposta.
  • Conteúdo da resposta - A resposta recebida da solicitação HTTP, como uma variável de string.
  • Status da resposta - o código de status recebido da solicitação HTTP, como uma variável inteira.

Autenticação Simples

  • Senha — Indica que o serviço Web usa autenticação simples e permite que você insira a sua senha. Adicionar o nome de usuário também é necessário. Esta propriedade é compatível com strings e variáveis string.
  • SenhaSegura — Indica que o serviço Web usa autenticação segura e permite que você insira a sua senha de string segura. Adicionar o nome de usuário também é necessário. Essa propriedade é compatível com variáveis de string seguras.
  • Nome de usuário - indica que o serviço da Web usa autenticação simples e permite que você insira seu nome de usuário. Adicionar uma senha também é necessário. Esta propriedade suporta strings e variáveis de string.

Configuração multiplataforma

  • Método de solicitação - O método de solicitação a ser usado ao chamar a API. Os seguintes verbos HTTP são suportados: GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH e MERGE. Por padrão, o método GET é selecionado.
  • URL de solicitação - a URL para a qual você deseja fazer a solicitação. Os segmentos personalizados devem ser colocados entre chaves "{}" e definidos na seção Parâmetros . Por exemplo, este URL https://platform.uipath.com/odata/Robots(28) pode ser escrito como https://platform.uipath.com/odata/Robots{id}e o valor do parâmetro id pode ser fornecido na janela URLSegments .
  • Parâmetros - Os parâmetros da solicitação. Selecione o campo para abrir a janela Dicionário.
  • Cabeçalhos - Permite que você inclua cabeçalhos personalizados na solicitação HTTP. Selecione o campo para abrir a janela Dicionário.
  • Corpo - O corpo da solicitação.
  • Autenticação - Especifica o protocolo de autenticação a ser usado ao chamar a API. Os seguintes protocolos são suportados:
    • Nenhum - A opção padrão. Ele deve ser usado se o servidor da web para o qual você está enviando solicitações não requer um protocolo de autenticação.
    • Http simples - esta opção deve ser selecionada se a API para a qual você está fazendo solicitações usa um protocolo de autenticação HTTP simples. Se escolhido, dois campos adicionais são exibidos - Username e Password, que devem ser preenchidos com credenciais válidas para a API especificada.
    • OAuth1 — essa opção deve ser selecionada se a API para a qual você está fazendo solicitações usa um protocolo OAuth1. Se escolhido, quatro campos adicionais serão exibidos: Chave do Consumidor , Segredo do Consumidor, Token de Acesso, Segredo do Token de Acesso.
    • OAuth2 - Esta opção deve ser selecionada se a API para a qual você está fazendo solicitações usa um protocolo OAuth2. Se escolhido, o campo Access Token é exibido. Esse token de acesso geralmente é gerado como resposta a outra solicitação HTTP para a API indicada.
    • Certificado de cliente – Essa opção deve ser selecionada se um certificado de cliente for necessário para concluir a chamada de API. Se selecionada, dois campos adicionais serão exibidos:
      • CertificadoDoCliente – O local no qual o arquivo do Certificado do Cliente é armazenado. O caminho completo deve ser fornecido. A codificação de certificados compatível é X.509 e as extensões compatíveis são .pfx e .p12. É compatível com a verificação de handshake bidirecional.
      • SenhaDoCertificadoDoCliente - A senha que corresponde ao arquivo do Certificado do Cliente que você está usando.

Avançado

Opções

  • Tempo limite (milissegundos) — especifica a quantidade de tempo (em milissegundos) para aguardar que a atividade seja executada antes de gerar um erro. O valor padrão é de 6000 milissegundos (6 segundos).
  • Continuar com erro - Especifica se a automação deve continuar mesmo quando a atividade gera um erro. Este campo só aceita valores booleanos (True, False). O valor padrão é False. Como resultado, se o campo não estiver configurado e ocorrer um erro, a execução do projeto será interrompida. Se o valor for definido como True, a execução do projeto prosseguirá mesmo com erros.
  • Verificação de certificado SSL - Se selecionado, verifica os certificados SSL ao enviar uma solicitação. Falhas de verificação resultarão no cancelamento da solicitação.
  • Formato aceito - O formato no qual receber a resposta do servidor da Web. As seguintes opções são compatíveis: QUALQUER - o valor padrão, XML, JSON e CUSTOM. Ao escolher o FormatoAceitoPersonalizado , se um parâmetro de Cabeçalho Accept ou accept estiver presente, ele será enviado como o formato aceito personalizado. Se nenhum parâmetro do cabeçalho for definido, accept receberá o valor padrão do RestSharp:
    application/json, application/xml, text/json, text/x-json, text/javascript,
                            text/xmlapplication/json, application/xml, text/json, text/x-json, text/javascript,
                            text/xml
  • Anexos de arquivo - Lista de anexos da solicitação.
  • Nome do arquivo para anexo de resposta - O nome do arquivo a ser usado para o arquivo retornado pela solicitação.
  • BodyFormat - O formato em que o corpo deve estar. Por padrão, é preenchido com application/xml. Este campo suporta strings e variáveis de string.
  • Cookies - Os cookies na solicitação HTTP. Selecione o campo para abrir a janela Dicionário.
  • Segmentos de URL - Segmentos personalizados adicionados ao URL do ponto de extremidade entre chaves "{}". Selecione o campo para abrir a janela Dicionário. Por exemplo, a URL https://platform.uipath.com/odata/Robots(28) pode ser escrita como https://platform.uipath.com/odata/Robots{id}, e o valor do parâmetro id pode ser fornecido na janela Dicionário. Este campo é compatível apenas com strings e variáveis string.

Saída

  • Conteúdo da resposta - A resposta recebida da solicitação HTTP, como uma variável de string.
  • Status da resposta - o código de status recebido da solicitação HTTP, como uma variável inteira.
  • Cabeçalhos de resposta - A resposta recebida da solicitação HTTP.
  • Anexo de resposta - O anexo salvo da resposta.

Esta página foi útil?

Obtenha a ajuda que você precisa
Aprendendo RPA - Cursos de automação
Fórum da comunidade da Uipath
Uipath Logo White
Confiança e segurança
© 2005-2024 UiPath. Todos os direitos reservados.