Servicio web de REST paquete

Utilice las acciones en el paquete de Servicio web de REST como métodos (ELIMINAR, OBTENER, EMPARCHAR, PUBLICAR, PONER) para enviar solicitudes y recibir respuestas de una API.

Trabajar con acciones de Servicio web de REST

Proporcione la siguiente información para enviar una solicitud EN PAUSA y recibir una respuesta. No se requieren todos los parámetros para todos los métodos.
  • Introducir el URI: Una dirección única para un recurso API.
  • Configuración del proxy: Para configurar el proxy, seleccione la pestaña Sistema o Personalizado desde Configuración del proxy.
    Opción Descripción
    Sistema

    El proxy del sistema es el proxy configurado en la máquina de ejecución de bot en la que se está ejecutando el bot.

    Si se selecciona esta opción, Agente de bot utiliza el proxy del sistema.
    Personalizado

    Esta opción le permite configurar los ajustes personalizados del proxy dentro de las acciones de Servicio web de REST. Por ejemplo, si es necesario dirigir una API REST a través de un proxy diferente al del sistema, puede seleccionar la opción Personalizado y proporcionar los detalles del proxy dentro de las acciones de REST.

    Escriba los siguientes detalles:

    • Host: El nombre del host o la dirección IP del proxy
    • Puerto: El número de puerto del proxy
    • Nombre de usuario (opcional): El nombre de usuario utilizado para la autenticación proxy
    • Contraseña (opcional): La contraseña utilizada para la autenticación proxy
      Nota: Si el proxy que se va a configurar es un proxy autenticado, debe proporcionar las credenciales de autenticación en los campos Nombre de usuario y Contraseña.
    Para los campos Host, Puerto, Nombre de usuario y Contraseña, elija entre las pestañas Credencial, Variable o String insegura:
    • Credencial: Utiliza un valor disponible en la Credential Vault.
    • Variable: Utiliza una variable que almacena un valor de credencial en una variable definida por el usuario.
    • String insegura: Especifique manualmente el valor que desea utilizar.
  • Modo de autenticación: Existen tres modos de autenticación compatibles:
    • Sin autenticación: Utilice esta opción a fin de acceder a los puntos finales que no requieren autenticación para acceder a sus servidores.
    • Token de usuario de la Control Room: Las Control Room de acciones utilizan el token generado mientras inicia sesión en la Servicio web de REST para acceder a los puntos finales.
    • Básico: Básico es la forma más sencilla de autenticar los usuarios. Si selecciona esta opción, introducirá el nombre de usuario y la contraseña. Esta técnica utiliza un encabezado llamado Autorización, con una representación codificada en base64 del nombre de usuario y la contraseña introducidos.
    • Usuario de AD con sesión abierta: Los usuarios de Active Directory (AD) autorizados para acceder a la API relacionada se autentican a través de AD. No se necesitan credenciales en la solicitud.
    • Autenticación de Windows NT LAN Manager (NTLM) (Usuario AD): Un método de autenticación de desafío/respuesta que les permite a los clientes proporcionar su nombre de usuario y contraseña como credenciales cifradas o texto sin formato. Le recomendamos que utilice credenciales almacenadas en el Automation Anywhere Credential Vault.
    • Gestión de OAuth2 - Control Room: Cuando se integra OAuth con Control Room, puede gestionar de forma centralizada y almacenar de forma segura los tokens que se utilizan para la autenticación con proveedores de terceros. Debe configurar el servicio web y tomar nota de los detalles de autenticación (como la identificación del cliente, el secreto del cliente, la URL de autorización, etc.) para usar la conexión OAuth en Control Room. Para obtener más información, consulte Configurar conexiones ‌OAuth en la Control Room.

      El siguiente video muestra cómo utilizar la conexión ‌OAuth en Servicio web de REST:

  • Encabezado: No todos los métodos requieren un encabezado. Los encabezados representan los metadatos asociados con la solicitud.
  • Tipo de contenido: Cuando un encabezado contiene un tipo de contenido, define la negociación de contenido entre el cliente y el servidor. Las acciones de Servicio web de REST admiten los siguientes tipos de contenido:
    • application/x-www-form-urlencoded: Codifique los parámetros en la dirección URL.
    • JSON (aplicación/json): Introduzca un cuerpo de solicitud JSON.
    • XML (aplicación/xml): Introduzca un cuerpo de solicitud XML.
    • Texto (texto/sin formato)
    • XML (texto/xml)
    • HTML (texto/html)
    • datos de formulario de varias partes:
      • Envía datos binarios, en la mayoría de los casos para cargar archivos al servidor. Se utiliza en casos en los que envía varias partes en una sola solicitud, que por lo general incluyen datos de texto (como campos de formulario) y potencialmente una carga de archivo. También puede utilizar una variable FileStream. Consulte a continuación para obtener más detalles.
      • FileStream: Puede leer el FileStream después de asignarlo a una variable. Por ejemplo, puede leer un FileStream asignado a una variable en una ubicación de OneDrive. Para obtener más información, consulte acción Asignar archivo.
        FileStream en los Servicios web de REST
    • Binario: Utilice Binary para enviar archivos sin procesar, como imágenes, vídeos y archivos de audio. Cuando selecciona Binary, podrá cargar un archivo binario (como variable, archivo de Control Room o archivo de escritorio).
    • Personalizado
      Personalizado: Agregue contenido personalizado que no se incluya en el tipo de contenido estándar. Por ejemplo, cuando migra de la versión 11.x a Automation 360, el siguiente valor no se incluye en ninguno de los tipos de contenido estándar: application/vnd.whispir.message-v1+json.
  • Agregar sustitución: Permite introducir variables en el cuerpo de solicitud REST. Una variable es una representación simbólica de datos y permite acceder a un valor sin tener que introducirlo manualmente cuando lo necesite. Por ejemplo, considere la siguiente solicitud de cuerpo REST:
    {
   "name":"{{name}}",
   "email":"{{email}}",
   "status":"Active"
}
    En el cuerpo de solicitud anterior, puede sustituir las variables incluidas entre corchetes dobles si hace clic en Agregar sustitución y añade los valores requeridos.
  • Opciones avanzadas:
    • Capturar respuesta ante fallas: Seleccione la casilla de verificación para capturar la respuesta antes fallas, excepto para la respuesta Éxito/Aceptar. Los detalles de la respuesta ante fallas se capturan en el cuerpo de la respuesta.
    • Permitir una conexión insegura cuando se utiliza https: Seleccione la casilla de verificación para permitir una conexión insegura cuando se utiliza https.
    • Aceptar Cookies: Seleccione la casilla de verificación para capturar automáticamente las cookies de sesión de las respuestas del servidor.
      • Capturar: Cuando está habilitada, la función captura las cookies de sesión incluidas en las respuestas del servidor.
      • Almacenamiento seguro: Las cookies capturadas se cifran dentro de la memoria del proceso, lo que garantiza que nunca se almacenen permanentemente y sean inaccesibles fuera de su sesión de automatización.
      • Reutilizar: Las cookies se incluyen automáticamente en llamadas REST posteriores, lo que elimina la gestión manual de cookies y mejora la confiabilidad de la automatización.
      • Gestión de varias cookies: La función gestiona sin problemas varias cookies devueltas por el servidor, lo que asegura que se incluyan todas las credenciales de autenticación necesarias.
      • Destrucción: Las cookies capturadas se destruyen automáticamente cuando finaliza la sesión de automatización o el bot finaliza la ejecución, lo que garantiza la seguridad y privacidad de los datos.
      Nota: Las cookies capturadas son específicas del dominio desde el que se originan y no se utilizarán automáticamente para llamadas REST posteriores realizadas a diferentes dominios. Esto significa que las cookies capturadas de domainA.com no se utilizarán para solicitudes de domainB.com.
    • Descargar archivo: (Solo disponible con el método Obtener) seleccione esta casilla de verificación para descargar el archivo a una ubicación específica. La URI debe devolver/descargar un archivo. Ingrese la carpeta deseada y el nombre del archivo con la extensión. Asegúrese de usar la extensión de archivo correcta. Por ejemplo: C:/Usuarios/Descargas/image01.jpg
      Consejo: Marque la opción Sobrescribir archivo si ya existe para sobrescribir un archivo con el mismo nombre que ya existe en la carpeta en la que está guardando el archivo.
      Manejo de errores:
      URI no válida:
      Si la URI indicada es incorrecta, se mostrará un mensaje de error.
      No se encontró el archivo:
      Si la respuesta de la API está vacía porque el archivo no existe en la ubicación especificada, se mostrará un mensaje de error.
      Permisos insuficientes:
      Si no tiene permisos de escritura para la ubicación de descarga, se mostrará un mensaje de error.
      Discrepancia de extensión de archivo:
      Si la extensión del archivo no coincide con el tipo esperado, se mostrará un mensaje de error.
  • Espere a que se complete la acción: Se puede establecer un valor de tiempo de espera cuando se envía una solicitud REST y se recibe una respuesta. Cuando realiza acciones como POST, PUT, DELETE, PATCH y GET, en el campo Esperar a que se complete la acción, puede especificar el tiempo de espera (en milisegundos). De manera predeterminada, el tiempo de espera es de 60 000 milisegundos.
  • Configuración SSL/TLS: Utilice esta opción para cargar un archivo de certificado con o sin contraseña a fin de proporcionar autenticación adicional durante las llamadas a la API REST.

    La configuración SSL/TLS utiliza el protocolo TLS mutuo (mTLS) para cifrar, autenticar y proteger las comunicaciones entre el URI de la API y el cliente. mTLS requiere que ambas entidades se autentiquen mutuamente mediante el intercambio de certificados. La transmisión de datos solo ocurre si ambas entidades autentican correctamente los certificados intercambiados.

    El Servicio web de REST admite certificados de tipo .p12 para máquinas con Windows y formato .pfx para máquinas que no tienen Windows.

    • Ruta del archivo de almacén de claves (opcional): Cargue el archivo de certificado usando la opción Variable, Archivo de Control Room o Archivo del escritorio.
    • Contraseña del almacén de claves (opcional): Si el certificado está protegido por contraseña, puede autenticar la contraseña del certificado usando la opción Credential, Variable o String insegura. Para obtener más información sobre cómo almacenar contraseñas de forma segura en el almacén de Credenciales, consulte Credenciales y casilleros en Credential Vault.
  • Variable de salida: La salida de respuesta se captura en una variable de diccionario. Una variable de diccionario es un par de valores clave. Utilice el nombre del encabezado de la respuesta como clave para devolver el valor del encabezado o “Cuerpo” como la clave para devolver el cuerpo de la respuesta.
    Nota: La clave de respuesta con su valor está disponible en la variable de diccionario para mostrar el estado de respuesta de la API REST.
    Para obtener una lista de los nombres de encabezado para el recurso API, realice estos pasos:
    1. Inserte una acción de Bucle después de la acción de Servicio web de REST.
    2. Seleccione el iterador Para cada clave en el diccionario.
    3. En el campo Variable de diccionario, seleccione la variable que contiene la salida de la acción de Servicio web de REST.
    4. Asigne el valor de cada clave a $prompt-assignment$.
    5. Inserte una Registrar en archivo acción.
    6. Proporcione la ruta del archivo a un archivo de texto para contener la lista de nombres de encabezado.
    7. Inserte $prompt-assignment$ en el campo Introducir texto a registrar.
    8. Seleccione la opción Sobrescribir archivo existente.
    9. Haga clic en Guardar.

      Cuando usted ejecuta el bot, este imprime los nombres de encabezado del recurso API al archivo seleccionado.

Pasar valores de manera segura

Usted puede pasar valores de forma segura desde la Credential Vault al servicio web especificando el casillero, la credencial y el atributo en los siguientes campos de acción compatibles:
  • URI
  • Encabezados personalizados
  • Cuerpo: Para el tipo de contenido application/x-www-form-urlencoded, haga clic en Agregar parámetro para seleccionar el valor desde la Credential Vault.

    Para todos los demás tipos de contenido, seleccione la opción Seleccionar una credencial como parámetros y haga clic en Elegir.

Acciones en el paquete de Servicio web de REST

Acción Descripción
Método DELETE Elimina el recurso que es identificado por la URI.
Método Get Recupera la información identificada por los parámetros incluidos en la URI. No hay Tipo de contenido para el método GET porque todos los parámetros se pasan como parte de la URI.

Las limitaciones y características del método GET incluyen lo siguiente:

  • La extensión de la URI se limita a 2 048 caracteres.
  • Todos los parámetros se pasan en la URI.
  • El método GET expone los datos que se encuentran en la URI, lo que hace que sea menos seguro que el método POST.
  • GET no cambia ningún dato, lo que hace que sea seguro para todos los usuarios, independientemente de la autorización.

Consulte Uso del método Get.
Método PATCH Modifica el recurso que es identificado por la URI.
Método Post Crea un nuevo recurso en la URI.
  • Los parámetros son pasados al cuerpo de la solicitud.
  • No hay límite de extensión para el cuerpo de una solicitud.

Consulte Uso del método Post.
Método PUT Actualiza o reemplaza un registro basado en los parámetros pasados en la URI o el cuerpo. Consulte Utilizar el método Put.

Compatibilidad de proxies

Si su dispositivo está configurado con un proxy, todas las solicitudes salientes de este paquete se enrutan a través del servidor proxy. Consulte Conectar Agente de bot a un dispositivo con un proxy.