Leia e revise a documentação do Automation Anywhere

Automation 360

Fechar conteúdo

Contents (Conteúdo)

Abrir conteúdo

REST Web Service package

  • Atualizado: 2022/02/20
    • Automation 360 v.x
    • Criar
    • Espaço de trabalho RPA

REST Web Service package

Use as actions no package REST Web Service como métodos (DELETE, GET, PATCH, POST ou PUT) para enviar solicitações e receber respostas de uma API.

Como trabalhar com actions REST Web Service

Forneça as seguintes informações para enviar uma solicitação REST e receber uma resposta. Nem todos os parâmetros são necessários para todos os métodos.
  • URI: um endereço exclusivo para um recurso de API.
  • Modo de autenticação: há suporte para três modos de autenticação:
    • básico: as strings de texto podem ser usadas para uma autenticação básica.
    • Usuário logado do AD: usuários do Active Directory (AD) autorizados a acessar a API correspondente são autenticados por meio do AD. Nenhuma credencial é necessária na solicitação.
    • Autenticação (usuário do AD) do Windows NT LAN Manager (NTLM): método de autenticação de desafio/resposta que permite aos clientes fornecer o nome de usuário e senha como credenciais ou texto sem formatação criptografados. Recomenda-se usar as credenciais armazenados no Credential Vault Automation Anywhere.
  • Cabeçalho: nem todos os métodos exigem um cabeçalho. Os cabeçalhos representam os metadados associados à solicitação.
    Nota: Para usar uma chave de API em sua solicitação, insira api_key no campo Nome do cabeçalho e o valor da chave no campo Valor.
  • Capturar resposta de falha: marque esta caixa de seleção para capturar a resposta de falha, exceto para a resposta Êxito/Ok. Os detalhes da resposta de falha são capturados no corpo de resposta.
  • Permitir conexão insegura ao usar https: marque esta caixa de seleção para permitir uma conexão insegura ao usar https.
  • Tipo de conteúdo: quando um cabeçalho contém um tipo de conteúdo, ele define a negociação de conteúdo entre o cliente e o servidor. As actions do REST Web Service oferecem suporte aos seguintes tipos de conteúdo:
    • aplicativo/json
    • aplicativo/xml
    • texto/sem formatação
    • texto/html
    • texto/xml
    • dados multipartes/formato
  • Aguarde a ação para concluir: você pode definir um valor de tempo esgotado ao enviar uma solicitação REST e receber uma resposta. Ao executar actions ,tais como POST, PUT, DELETE, PATCH e GET, no campo Aguarde a ação para conclui, você pode especificar o tempo de espera (em milissegundos). Por padrão, o tempo de espera é de 60000 milissegundos.
  • Variáveis de saída: a saída de resposta é capturada em uma variável de dicionário. Uma variável de dicionário é um par de valores chave. Use o nome do cabeçalho de resposta como chave para retornar o valor do cabeçalho, ou o “Corpo”, como a chave para retornar o corpo de resposta.
    Nota: A chave de resposta, com seu valor, está disponível na variável de dicionário para exibição do status de resposta da API REST.
    Para obter uma lista dos nomes de cabeçalho para o recurso da API, execute estas etapas:
    1. Insira uma action Loop após a action REST Web Service.
    2. Selecione o iterador Para cada chave no dicionário.
    3. No campo Variável de dicionário, selecione a variável que contém a saída da action REST Web Service.
    4. Atribua o valor de cada chave a $prompt-assignment$.
    5. Insira uma action de Log To File.
    6. Forneça o caminho do arquivo para armazenar a lista de nomes de cabeçalho em um arquivo de texto.
    7. Insira $prompt-assignment$ no campo Inserir texto para log.
    8. Selecione a opção Substituir arquivo existente.
    9. Clique em Salvar.

      Quando você executa o bot, ele imprime os nomes de cabeçalho do recurso da API para o arquivo selecionado.

Como passar valores com segurança

Você pode passar valores de forma segura do Credential Vault para o serviço da web especificando o locker, as credenciais e o atributo nos seguintes campos de action compatíveis:
  • URI
  • Cabeçalhos personalizados
  • Corpo: para o tipo de conteúdo application/x-www-form-urlencoded, clique em Adicionar parâmetro para selecionar o valor no Credential Vault.

    Para todos os outros tipos de conteúdo, selecione a opção Selecionar credencial como parâmetros e clique em Escolher.

Actions no REST Web Service package

Action Descrição
Método DELETE Remove o recurso identificado pelo URI.
Método GET Recupera as informações identificadas pelos parâmetros incluídos no URI. Não há Tipo de conteúdo para o método GET, pois todos os parâmetros são passados como parte do URI.

Limitações e características do método GET incluem:

  • o comprimento do URI é limitado em 2.048 caracteres.
  • Todos os parâmetros são passados no URI.
  • O método GET expõe dados que estão no URI, o que faz dele menos seguro do que o método POST.
  • O GET não altera nenhum dado, tornando-o seguro para todos os usuários, seja qual for sua autorização.
Método Patch Modifica o recurso identificado pelo URI.
Método POST Cria um novo recurso no URI.
  • Os parâmetros são passados no corpo da solicitação.
  • Não há limite de comprimento para o corpo da solicitação.
Método PUT Atualiza ou substitui um recurso com base nos parâmetros passados no URI ou no corpo.

Suporte a proxy

Se o dispositivo estiver configurado com um proxy, todas as solicitações de saída desse package serão roteadas por meio do servidor de proxy. Consulte Conectar o Bot agent a um dispositivo com um proxy.

Send Feedback (Enviar Feedback)