Leia e revise a documentação do Automation Anywhere

Automation Anywhere Automation 360

Fechar conteúdo

Contents (Conteúdo)

Abrir conteúdo

REST Web Service package

  • Atualizado: 10/14/2020
    • 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: Endereço exclusivo para um recurso de API.
  • Modo de autenticação: Há 3 modos de autenticação compatíveis.
    • Básico: Strings de texto podem ser usadas para a autenticação básica.
    • Usuário AD conectado: usuários do Active Directory (AD) autorizados a acessar a API relacionada são autenticados por meio do AD. Nenhum dado de acesso é necessário na solicitação.
    • Autenticação do Windows NT LAN Manager (NTLM) (usuário AD): método de autenticação de desafio/resposta que permite aos clientes fornecer o nome de usuário e senha como dados de acesso criptografados ou texto simples. Recomenda-se usar dados de acesso armazenados no Automation Anywhere Credential Vault.
  • 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.
  • Tipo de conteúdo: Quando um cabeçalho contém um tipo de conteúdo, define a negociação de conteúdo entre o cliente e o servidor. As actions REST Web Service são compatíveis com os seguintes tipos de conteúdo
    • aplicativo/json
    • aplicativo/xml
    • texto/sem formatação:
    • texto/html
    • texto/xml
  • Variável de saída: A saída de resposta é capturada em uma variável do dicionário. Uma variável de dicionário é um par de valores chave. Use o nome do cabeçalho de resposta como chave para capturar o valor do cabeçalho ou o “Body” como a chave para capturar o corpo de resposta.
    Nota: actions REST Web Service são compatíveis para capturar o cabeçalho de resposta na variável de dicionário. A chave de resposta com seu valor está disponível para exibir o status de resposta da API REST.
    Para obter uma lista dos nomes de cabeçalho para o recurso de 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$ e clique em Aplicar.
    5. Inserir uma action de Log To File.
    6. Forneça o caminho do arquivo para um arquivo de texto para armazenar a lista de nomes de cabeçalho.
    7. Insira $prompt-assignment$ no campo Inserir texto para log.
    8. Selecione a opção Substituir arquivo existente e clique em Aplicar.
    9. Clique em Save (Salvar)

      Quando você executa o bot, ele imprime os nomes de cabeçalho do recurso de 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 de web especificando o locker, os dados de acesso e o atributo nos seguintes campos de action compatíveis:
  • URI
  • Cabeçalhos personalizados
  • Estrutura: Para o tipo de conteúdo application/x-www-form-urlencoded, clique em Adicionar parâmetro para selecionar o valor do Credential Vault.

    Para todos os outros tipos de conteúdo, selecione a opção Select credential as parameters (Selecionar credencial como parâmetros) e clique em Pick (Selecionar).

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 seguinte:

  • O comprimento do URI é limitado a 2.048 caracteres
  • Todos os parâmetros são passados no URI
  • O método GET expõe dados que estão no URI, tornando-o menos seguro do que o método POST.
  • O GET não altera nenhum dado, tornando-o seguro para todos os usuários, independentemente da autorização.
Método Patch Modifica o recurso identificado pelo URI.
Método POST Cria um novo recurso no URI.
  • 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 registro 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. Ver Conectar o Bot agent a um dispositivo com um proxy.

Send Feedback (Enviar Feedback)