Solicitud HTTP

UiPath.WebAPI.Activities.HttpClient

Descripción

Te permite realizar solicitudes HTTP a una API web específica. Al arrastrar esta actividad por primera vez al panel del Diseñador , se muestra la ventana del Asistente de solicitud HTTP , que proporciona una forma más sencilla de crear solicitudes y previsualizar las respuestas del servidor.

Nota: Si el código de estado HTTP devuelto (CódigoDeEstado) es 0, significa que el servidor no devolvió una respuesta real por algún motivo. Por lo general, esto indica que puedes tener problemas de conectividad o de red.

Importante: El paquete WebAPI no es compatible con las siguientes actividades: UiPath.Salesforce.Activities y UiPath.Jira.Activities.

Compatibilidad de proyectos

Windows - Heredado | Windows | Multiplataforma

Configuración multiplataforma

• Método de solicitud: el método de solicitud que se utilizará al llamar a la API. Se admiten los siguientes verbos HTTP: GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH y MERGE. De forma predeterminada, se selecciona el método GET .
• URL desolicitud : la URL a la que quieres realizar la solicitud. Los segmentos personalizados deben colocarse entre llaves "{}" y definirse en la sección Parámetros . Por ejemplo, esta URL https://platform.uipath.com/odata/Robots(28) puede escribirse como https://platform.uipath.com/odata/Robots{id}, y el valor del parámetro id se puede proporcionar en la ventana SegmentosDeURL .
• Parámetros : los parámetros de la solicitud. Haz clic en el campo para abrir la ventana Diccionario .
• Encabezados : te permite incluir encabezados personalizados en la solicitud HTTP. Haz clic en el campo para abrir la ventana Diccionario .
• Cuerpo : el cuerpo de la solicitud.
• Autenticación : especifica el protocolo de autenticación que se utilizará al llamar a la API. Se admiten los siguientes protocolos:
  • Ninguno : la opción predeterminada. Debe utilizarse si el servidor web al que envía las solicitudes no requiere un protocolo de autenticación.
  • Http simple : esta opción debe seleccionarse si la API a la que realizas las solicitudes utiliza un protocolo de autenticación HTTP simple. Si se elige, se muestran dos campos adicionales: nombre de usuario y contraseña, que deben completarse con credenciales válidas para la API especificada.
  • OAuth1 : esta opción debe seleccionarse si la API a la que realiza las solicitudes utiliza un protocolo OAuth1. Si se elige, se muestran cuatro campos adicionales: Clave del consumidor, Secreto del consumidor, Tokende acceso y Secreto del tokende acceso.
  • OAuth2 : esta opción debe seleccionarse si la API a la que realiza las solicitudes utiliza un protocolo OAuth2. Si se elige, se muestra el campo Token de acceso . Este token de acceso generalmente se genera como respuesta a otra solicitud HTTP a la API indicada.
  • Certificado del cliente: esta opción debe seleccionarse si se necesita un certificado de cliente para completar la llamada API. Si se selecciona, se muestran dos campos adicionales:
    • CertificadoDelCliente: la ruta completa a la ubicación del archivo de certificado del cliente. La codificación de certificados admitidos es X.509 y las extensiones admitidas son .pfx y .p12.
    • ContraseñaDelCertificadoDelCliente: la contraseña establecida durante la exportación del archivo de certificado del cliente.

Avanzado

Opciones

• Tiempo de espera (milisegundos): especifica la cantidad de tiempo (en milisegundos) que se debe esperar a que se ejecute la actividad antes de arrojar un error. El valor predeterminado es de 6000 milisegundos (6 segundos).
• ContinuarEnCasoDeError: especifica si la automatización debe continuar incluso cuando la actividad arroja un error. Este campo solo admite valores Boolean (Verdadero, Falso). El valor predeterminado es Falso. Como resultado, si el campo no está configurado y se produce un error, la ejecución del proyecto se detiene. Si el valor es Verdadero, la ejecución del proyecto continúa independientemente de cualquier error.
• Verificación de certificado SSL : si se selecciona, verifica los certificados SSL al enviar una solicitud. Los fallos de verificación provocarán que se anule la solicitud.
• Formato de aceptación : el formato en el que se recibirá la respuesta del servidor web. Se admiten las siguientes opciones: ANY : el valor predeterminado, XML, JSON y CUSTOM. Al elegir el formato de aceptación personalizado, si un parámetro de encabezado Accept o accept está presente, se enviará como el formato de aceptación personalizado. Si no se establece ningún parámetro de encabezado, accept obtendrá el valor predeterminado de RestSharp:

  application/json, application/xml, text/json, text/x-json, text/javascript,
        text/xml

  .
• Archivos adjuntos : lista de archivos adjuntos de la solicitud.
• Nombre de archivo para archivo adjunto de respuesta : el nombre de archivo que se utilizará para el archivo devuelto por la solicitud.
• FormatoDelCuerpo : el formato en el que tiene que estar el cuerpo. De forma predeterminada se rellena con application/xml. Este campo admite cadenas y variables de cadena.
• Cookies : las cookies de la solicitud HTTP. Haz clic en el campo para abrir la ventana Diccionario .
• Segmentos deURL: segmentos personalizados que se añaden a la URL del punto final entre llaves "{}". Haz clic en el campo para abrir la ventana Diccionario . Por ejemplo, la URL https://platform.uipath.com/odata/Robots(28) se puede escribir como https://platform.uipath.com/odata/Robots{id}y el valor del parámetro id se puede proporcionar en la ventana Diccionario . Este campo admite cadenas y variables de cadena.

Salida

• Contenido de la respuesta : la respuesta recibida de la solicitud HTTP, como una variable de cadena.
• Estado derespuesta : el código de estado recibido de la solicitud HTTP, como variable de enteros.
• Encabezados derespuesta : la respuesta recibida de la solicitud HTTP.
• Archivo adjunto de respuesta : el archivo adjunto guardado de la respuesta.

Windows, Windows: configuración heredada

La ventana del Asistente de importación

Puede usarlo para importar una solicitud HTTP en formato CURL.

La ventana del Asistente de solicitud HTTP

Todos los campos presentes en el asistente también están disponibles en el panel Propiedades. Como resultado, aún puede editar sus preferencias después de cerrar el asistente. Puede configurar la actividad en el asistente utilizando valores o variables codificados.

Nota: cuando se usan variables, la función de vista previa no está disponible.

La pestaña del creador de solicitudes

• Punto de finalización: la URL a la que quieres hacer solicitud. Los segmentos personalizados tienen que colocarse entre los corchetes "{}" y definirse en la sección Parámetros. Por ejemplo, esta URL https://platform.uipath.com/odata/Robots(28) puede escribirse como https://platform.uipath.com/odata/Robots({id}) y el valor del parámetro id puede ser proporcionado en la sección Parámetros como un SegmentoUrl.
• Vista previa de URL : una vista previa de la URL proporcionada en el campo Punto de conexión, teniendo en cuenta la información proporcionada en la sección Parámetros .
• Habilitar la verificación del certificado SSL: marca esta casilla para verificar los certificados SSL al enviar solicitud. Los fallos de verificación resultarán en que se aborte la solicitud.
• Tiempo de espera: especifica la cantidad de tiempo (en milisegundos) que se debe esperar a que se ejecute la actividad antes de arrojar un error. El valor predeterminado es de 6000 milisegundos (6 segundos).

• Certificado de cliente : la ubicación en la que se almacena el archivo del certificado de cliente. Se debe proporcionar la ruta completa.

  Nota: La ruta de acceso no se debe escribir entre comillas.
• Contraseña de certificado de cliente : la contraseña que corresponde al archivo de certificado de cliente que estás utilizando.
• Método de solicitud: el método de solicitud que se utilizará al llamar a la API. Se admiten los siguientes verbos HTTP: GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH y MERGE. De forma predeterminada, se selecciona el método GET .

• Autenticación : especifica el protocolo de autenticación que se utilizará al llamar a la API. Se admiten los siguientes protocolos:

  • Ninguno : la opción predeterminada. Debe utilizarse si el servidor web al que envía las solicitudes no requiere un protocolo de autenticación.
  • Http simple : esta opción debe seleccionarse si la API a la que realizas las solicitudes utiliza un protocolo de autenticación HTTP simple. Si se elige, se muestran dos campos adicionales: nombre de usuario y contraseña, que deben completarse con credenciales válidas para la API especificada.
  • OAuth1 : esta opción debe seleccionarse si la API a la que realiza las solicitudes utiliza un protocolo OAuth1. Si se elige, se muestran cuatro campos: Clave del consumidor, Secreto del consumidor, Token de acceso, Secreto del tokende acceso.
  • OAuth2 : esta opción debe seleccionarse si la API a la que realiza las solicitudes utiliza un protocolo OAuth2. Si se elige, se muestra el campo Token de acceso . Este token de acceso generalmente se genera como respuesta a otra solicitud HTTP a la API indicada.

La sección de parámetros

• Añadir parámetro : añade una nueva línea en la tabla de parámetros, con el tipo GetOrPost . No se añade una nueva línea si no se rellena la línea anterior.

• Añadir encabezado: añade una nueva línea en la tabla de Parámetros con el tipo EncabezadoHttp. No se añade una nueva línea si la línea anterior no está completa.

  Nota: En el caso de que desees añadir múltiples valores para un encabezado, deben concatenarse mediante una coma (,).
• Añadir segmento de URL: añade una nueva línea en la tabla de Parámetros con el tipo SegmentoUrl. No se añade una nueva línea si la línea anterior no está completa.
• Eliminar : elimina una línea seleccionada de la tabla Parámetros. Si no se selecciona una línea, este botón está deshabilitado.

La tabla de parámetros

• Nombre : el nombre del parámetro, encabezado o segmento de URL.
• Valor: valor del parámetro, encabezado o segmento de URL.

• Tipo : el tipo de línea. Están disponibles las siguientes opciones:

  • GetOrPost : indica que la línea es un parámetro que se puede utilizar en las solicitudes.
  • HttpHeader : indica que la línea añadida en la tabla Parámetros es un encabezado de solicitud que se enviará al realizar la llamada a la API.

  • SegmentoDeURL : indica que la línea añadida es un fragmento o la URL proporcionada en el campo Extremo .

    Nota: en algunos casos, se puede devolver un error que indica que los parámetros duplicados no pueden existir. Estos pueden deberse a solicitudes de autenticación que deben contener los parámetros de Contraseña y Nombre de usuario. En estos casos, recomendamos pasarlos utilizando la propiedad Cuerpo .

La sección de Archivos adjuntos

• Añadir archivo adjunto : te permite añadir un archivo a la solicitud HTTP realizada mediante la creación de una nueva línea. Solo está habilitado cuando el Método de solicitud está establecido en POST o PUT.
• Eliminar archivo adjunto : te permite eliminar una línea añadida previamente en la sección Archivos adjuntos .
• Nombre : el nombre del archivo que quieres adjuntar.
• Ruta del archivo: la ruta completa del archivo que quieres adjuntar.
• Tipo : indica el tipo de información que estás enviando. Este campo se rellena automáticamente con un archivo adjunto.Vista previa : te permite obtener una vista previa de la solicitud HTTP que has creado y abre la pestaña Respuesta .

La pestaña Respuesta

Esta pestaña te permite obtener una vista previa de la solicitud que quieres incluir en tu flujo de trabajo. Se puede acceder a él haciendo clic en el botón Vista previa en el asistente de solicitud HTTP una vez que hayas rellenado todos los campos y hayas configurado la solicitud. Alternativamente, también puede cambiar la pestaña en la parte superior del asistente.

Esta página comprende lo siguiente:

• Información de la solicitud : esta sección muestra detalles sobre la solicitud realizada. Muestra la URL de la solicitud, el método y el código de estado.
• Vista previa de la respuesta : muestra la respuesta del servidor web.
• Cuerpo sin formato: muestra la respuesta del servidor web en formato sin formato.
• Información de respuesta : muestra detalles sobre la respuesta del servidor web. Muestra el estado y el código de la respuesta, y el encabezado de tipo de contenido compatible.
• Descargar recurso : te permite descargar los recursos solicitados en un archivo indicado.
• Actualizar : te permite realizar la solicitud de nuevo.

Panel de propiedades

Autenticación de certificado del cliente

• CertificadoDelCliente: la ruta completa a la ubicación del archivo de certificado del cliente. La codificación de certificados admitidos es X.509 y las extensiones admitidas son .pfx y .p12.
• ContraseñaDelCertificadoDelCliente: la contraseña establecida durante la exportación del archivo de certificado del cliente.
• Habilitar verificación de certificado SSL: verifica los certificados SSL al enviar una solicitud. Los fallos de verificación provocarán que se anule la solicitud. Este campo solo admite valores booleanos (Verdadero, Falso).
• SecureClientCertificatePassword : la contraseña para el archivo de certificado de cliente especificado, en forma de cadena segura. Este campo solo admite variables SecureString.

Común

• ContinuarEnCasoDeError: especifica si la automatización debe continuar incluso cuando la actividad arroja un error. Este campo solo admite valores Boolean (Verdadero, Falso). El valor predeterminado es Falso. Por lo tanto, si el campo está vacío y se produce un error, se detiene la ejecución del proyecto. Si el valor es Verdadero, la ejecución del proyecto continúa independientemente de cualquier error.

  Nota: si se incluye esta actividad en Intentar capturar y el valor de la propiedad ContinuarEnCasoDeError es Verdadero, no se detectará error cuando el proyecto se ejecute.
• NombreParaMostrar: el nombre de la actividad para ser mostrado.
• Tiempo de espera (milisegundos): especifica la cantidad de tiempo (en milisegundos) que se debe esperar a que se ejecute la actividad antes de arrojar un error. El valor predeterminado es de 6000 milisegundos (6 segundos).

Entrada

• AceptarFormato : el formato en el que se recibe la respuesta del servidor web. Se admiten las siguientes opciones: ANY : el valor predeterminado, XML, JSONy CUSTOM. Al elegir el Formato de aceptación personalizado, si hay presente un parámetro de encabezado Accept o accept , se enviará como el formato de aceptación personalizado. Si no se establece ningún parámetro de encabezado, accept obtendrá el valor predeterminado de RestSharp: application/json, application/xml, text/json, text/x-json, text/javascript, text/xml.
• Método de solicitud: el método de solicitud que se utilizará al llamar a la API. Se admiten los siguientes verbos HTTP: GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH y MERGE. De forma predeterminada, se selecciona el método GET .
  Nota: La solicitud HTTP funciona correctamente solo con la versión de paquete 106.11.2 o inferior de RestSharp. Devuelve un error cuando está instalada la versión 106.11.4 o superior de RestSharp.
• URL desolicitud : la URL a la que quieres realizar la solicitud. Los segmentos personalizados deben colocarse entre llaves "{}" y definirse en la sección Parámetros . Por ejemplo, esta URL https://platform.uipath.com/odata/Robots(28) puede escribirse como https://platform.uipath.com/odata/Robots{id}, y el valor del parámetro id se puede proporcionar en la ventana SegmentosDeURL .

Otros

• Privado : si se selecciona, los valores de variables y argumentos ya no se registran en el nivel Detallado.

OAuth1

• Clave delconsumidor : la clave del consumidor que se utilizará si la API a la que realizas las solicitudes se basa en el protocolo de autenticación OAuth1.
• SecretoDeConsumidor: el secreto de consumidor que se usará si la API a la que estás haciendo solicitudes está basada en el protocolo de autenticación OAuth1.
• OAuth1Token : el token de acceso que se utilizará si la API a la que realizas solicitudes se basa en el protocolo de autenticación OAuth1, después de que se haya aprobado una solicitud de autorización para el consumidor.
• SecretoDeTokenOAuth1: el secreto que se debe utilizar si la API a la que estás haciendo solicitudes está basada en el protocolo de autenticación OAuth1, después de que se haya aprobado una solicitud de autorización para el consumidor.

OAuth2

• OAuth2Token : el token de acceso que se utilizará si la API a la que realizas las solicitudes se basa en el protocolo de autenticación OAuth2. Este token de acceso generalmente se genera como respuesta a otra solicitud HTTP a la API indicada.

Opciones

• Archivos adjuntos : te permite adjuntar archivos a las solicitudes. Haga clic en el botón de puntos suspensivos para abrir la ventana Archivos adjuntos y agregar todos los archivos necesarios.
• Cuerpo : el cuerpo de la solicitud.
• FormatoDelCuerpo : el formato en el que tiene que estar el cuerpo. De forma predeterminada se rellena con application/xml. Este campo admite cadenas y variables de cadena.
• Cookies : las cookies de la solicitud HTTP. Haga clic en el botón de puntos suspensivos para abrir la ventana Cookies .
• Archivos adjuntos: lista de archivos adjuntos para la solicitud.
• Nombre de archivo para archivo adjunto de respuesta : el nombre de archivo que se utilizará para el archivo devuelto por la solicitud.
• Encabezados : te permite incluir encabezados personalizados en la solicitud HTTP. Haga clic en el botón de puntos suspensivos para abrir la ventana Encabezados .
• Parámetros : los parámetros de la solicitud. Haga clic en el botón de puntos suspensivos para abrir la ventana Parámetros , que corresponde a la sección Parámetros.
• SegmentosDeURL : segmentos personalizados añadidos a la URL del punto final entre llaves "{}". Haga clic en el botón de puntos suspensivos para abrir la ventana SegmentosDeURL . Por ejemplo, la URL https://platform.uipath.com/odata/Robots(28) se puede escribir como https://platform.uipath.com/odata/Robots{id}y el valor del parámetro id se puede proporcionar en la ventana SegmentosDeURL . Este campo admite cadenas y variables de cadena.

Salida

• Encabezados: la respuesta recibida desde la solicitud HTTP.
• Archivo adjunto de respuesta : el archivo adjunto guardado de la respuesta.
• Contenido de la respuesta : la respuesta recibida de la solicitud HTTP, como una variable de cadena.
• Estado derespuesta : el código de estado recibido de la solicitud HTTP, como variable de enteros.

Autenticación simple

• Contraseña: indica que la Web utiliza una autenticación sencilla y te permite ingresar tu contraseña. También es necesario añadir un nombre de usuario. Esta propiedad admite cadenas y variables String.
• Contraseña segura: indica que el servicio web utiliza la autenticación segura y te permite ingresar tu contraseña de string segura. También es necesario añadir un nombre de usuario. Esta propiedad admite variables de string seguras.
• Nombre deusuario : indica que el servicio web utiliza una autenticación simple y te permite introducir tu nombre de usuario. También es necesario añadir una contraseña. Esta propiedad admite cadenas y variables de cadena.