Configurar la autenticación

Uno de los grandes pilares para crear un conector es identificar e integrar correctamente su configuración de autenticación. Si se hace correctamente, una vez que el conector se publique en el catálogo de Integration Service, los usuarios podrán crear conexiones con él como con cualquier otro conector dentro del catálogo.

Todos los conectores reutilizan el marco de autenticación para que el flujo de autenticación completo y la gestión de conexiones puedan gestionarse con un enfoque unificado.

El resultado final de la autenticación es que cualquier solicitud posterior dentro de este conector utiliza el resultado del proceso de autenticación para cada llamada a la API. Por ejemplo, se envía un token de portador en los encabezados de cada llamada a la API:

Connector Builder es compatible con los siguientes estándares del sector mediante una configuración sencilla en lugar de una codificación extensa:

• Código de autorización OAuth 2.0
• Código de autorización OAuth 2.0 con PKCE
• Credenciales de cliente OAuth 2.0
• Básica
• Clave API
• Token de acceso personal (PAT)
• Personalizar
• Sin autenticación

Dado que Connector Builder se vincula con el marco de Integration Service, definir tu configuración de autenticación es ahora una cuestión de configuración en lugar de un proceso complejo. Esto significa que el marco se ocupa de los intercambios de tokens, las actualizaciones y cualquier otra tarea similar. El creador de conectores utiliza de forma predeterminada el código de autorización OAuth 2.0, ya que este es el enfoque más común de los proveedores para gestionar la autenticación.

La página de autenticación consta de tres componentes:

1. El tipo de autenticación, que determina cómo se refleja el marco de autenticación con validación adicional para PKCE, intercambio completo de tokens (para OAuth), etc. Además, también reconfigura la tabla con propiedades debajo para que se describan las propiedades requeridas.
   

   

   
   
2. La tabla de propiedades puede modificarse con parámetros personalizados y/o editar los existentes. Dependiendo de la selección de Tipo de autenticación en el menú desplegable, algunos campos pueden ser obligatorios y especificarse en rojo.
   Nota: Cambiar estas propiedades dentro de esta tabla o el Tipo de autenticación invalida la conexión que podrías haber creado ya dentro del Creador de conectores. Solo hay una conexión durante el tiempo de diseño, y debe configurarse y probarse con la configuración de autenticación más reciente.

   Si actualizas tu configuración de autenticación, las conexiones existentes fallarán. Debes crear una nueva conexión y actualizar tus procesos para utilizar la nueva conexión.
3. La pantalla Autenticación se genera automáticamente en función de la configuración que has proporcionado. Lo que ves durante la configuración dentro del Creador de conectores es exactamente el resultado final que verán los usuarios de tu paquete de actividades.
   
   
   
   

Configuración de la tabla de autenticación

Sin tener en cuenta el tipo de autenticación, la tabla de propiedades cargada identifica dos elementos:

1. Lo que ve el usuario en la pantalla de autenticación.
2. Cómo gestiona la autenticación el marco de autenticación.

• Cada elemento de línea de la tabla representa una propiedad que el usuario puede o no sobrescribir. Para presentar un campo determinado en la pantalla, debe marcarse como Preguntar al usuario: Sí.
• Cada elemento de línea tiene un Nombre y un Nombre para mostrar. El nombre es lo que el proveedor espera para la configuración técnica y esto último es importante sobre cómo solicitar esta entrada al usuario en la pantalla de autenticación.
• Cada elemento de línea contiene un menú de acción que permite editar la propiedad con mucho más detalle. Aquí es donde puedes indicar que una propiedad determinada debe enviarse como encabezado. Consulta más ejemplos en la sección Clave API .

Tipos de autenticación

En la pestaña Autenticación , configuras el tipo de autenticación para tu conector. Se admiten las siguientes opciones:

• Código de autorización OAuth 2.0
• Código de autorización OAuth 2.0 con PKCE
• Credenciales de cliente OAuth 2.0
• Básica
• Clave API
• Token de acceso personal (PAT)
• Personalizar
• Sin autenticación

Nota:

Al configurar la autenticación, estás configurando cómo debe autenticarse cualquier persona que utilice tu conector. Este es usted mientras construye el conector, pero también podrían ser otros los que terminen utilizando su creación.

Código de autorización OAuth 2.0

Información general

El código de autorización OAuth 2.0 es uno de los protocolos de autenticación más utilizados.

Campos de autenticación

Los campos de URL como la URL de autorización y la URL del token no heredan la URL base del conector y requieren la URL completa. Esto permite casos de uso en los que un proveedor utiliza una URL base diferente para la autenticación que la del resto de la API.

Campos obligatorios

Nota: el ID de cliente y el secreto de cliente suelen generarse desde el proveedor de la API. Consulta la documentación del proveedor para saber cómo generar estos valores para la autenticación.

Campo	Descripción
ID de cliente	Identificador de aplicación generado por el proveedor.
Secreto de cliente	Clave secreta de la aplicación generada por el proveedor.
URL de autorización	URL que redirige al usuario para completar el proceso de autenticación. Devuelve un código de autorización.
url del token	URL que UiPath utiliza para intercambiar el código de autorización por un token.

Campos adicionales

Campo	Descripción
Ámbito	Añade los ámbitos necesarios para un conector con un espacio separando cada ámbito (es decir, read write openid).
Actualizar la URL del token	URL necesaria para generar un nuevo token de acceso si también se devuelve un token de actualización. Suele ser la misma URL que se utiliza para la URL del token.
URL de revocación del token	URL necesaria para revocar el token de acceso.
IntervaloDeActualización	Cuánto tiempo es válido el token de acceso. El valor predeterminado es 3600 segundos o 60 minutos.
Nombre de la conexión	El nombre de la conexión en UiPath una vez completada la autenticación.
Encabezado básico	Indica si el ID de cliente y el secreto se envían como un valor codificado en Base64 en el encabezado Authorization . Valor booleano (verdadero/falso); el valor predeterminado es verdadero.

Cómo funciona

Una vez añadidos o configurados todos los valores de campo para el conector, UiPath® te guía automáticamente a través de los pasos necesarios para completar el flujo de autenticación. UiPath es compatible con el protocolo y, si se le proporciona un URI de token de actualización, regenera automáticamente los tokens de acceso en segundo plano según sea necesario. Esto mantiene la conexión activa y funcional mientras el token de actualización subyacente sea válido.

Formato de solicitud posterior a la autorización

Una vez completada la configuración inicial y realizada una conexión, todas las solicitudes realizadas para ese conector tienen el encabezado de autorización incluido automáticamente en la solicitud.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {yourToken}'

Código de autorización OAuth 2.0 con PKCE

Información general

El código de autenticación OAuth 2.0 con PKCE (Proof Key for Code Exchange) es un protocolo de autenticación común que aprovechan en gran medida las aplicaciones de una sola página, las aplicaciones que no pueden almacenar de forma segura un secreto de cliente o las aplicaciones que no pueden garantizar la recuperación segura de un código de autorización.

Campos de autenticación

Los campos de URL como la URL de autorización y la URL del token no heredan la URL base del conector y requieren la URL completa. Esto permite casos de uso en los que un proveedor utiliza una URL base diferente para la autenticación que la del resto de la API.

Campos obligatorios

Nota: el ID de cliente y el secreto de cliente suelen generarse desde el proveedor de la API. Consulta la documentación del proveedor para saber cómo generar estos valores para la autenticación.

Campo	Descripción
ID de cliente	Identificador de aplicación generado por el proveedor.
Secreto de cliente	Clave secreta de la aplicación generada por el proveedor.
URL de autorización	URL que redirige al usuario para completar el proceso de autenticación. Devuelve un código de autorización.
url del token	URL que UiPath utiliza para intercambiar el código de autorización por un token.

Campos adicionales

Campo	Descripción
Ámbito	Añade los ámbitos necesarios para un conector con un espacio separando cada ámbito (es decir, read write openid).
Actualizar la URL del token	URL necesaria para generar un nuevo token de acceso si también se devuelve un token de actualización. Suele ser la misma URL que se utiliza para la URL del token.
Método de desafío del código PKCE de OAuth2	El método utilizado para generar el desafío. Puede ser S256 o plain (recomendado: S256).
URL de revocación del token	URL necesaria para revocar el token de acceso.
IntervaloDeActualización	Cuánto tiempo es válido el token de acceso. El valor predeterminado es 3600 segundos o 60 minutos.
Nombre de la conexión	El nombre de la conexión en UiPath una vez completada la autenticación.
Encabezado básico	Indica si el ID de cliente y el secreto se envían como un valor codificado en Base64 en el encabezado Authorization . Valor booleano (verdadero/falso); el valor predeterminado es verdadero.

Cómo funciona

Una vez añadidos o configurados todos los valores de campo para el conector, UiPath® te guiará automáticamente por los pasos necesarios para completar el flujo de autenticación. UiPath es compatible con el protocolo y, si se le proporciona un URI de token de actualización, regenera automáticamente los tokens de acceso en segundo plano según sea necesario. Esto mantiene la conexión activa y funcional mientras el token de actualización subyacente sea válido.

UiPath proporciona la cadena de desafío necesaria para la autorización basada en PKCE, solo se requiere el método de desafío de código PKCE de OAuth2.

Formato de solicitud posterior a la autorización

Una vez completada la configuración inicial y realizada una conexión, todas las solicitudes realizadas para ese conector tienen el encabezado de autorización incluido automáticamente en la solicitud.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
  --header 'Authorization: Bearer {yourToken}',

Credenciales de cliente OAuth 2.0

Información general

Las credenciales de cliente OAuth 2.0 son un método para devolver un token de acceso que otorga acceso a recursos protegidos utilizando credenciales específicas de la aplicación que otorgan el permiso necesario. Las credenciales de cliente se utilizan a menudo para aplicaciones de máquina a máquina (M2M) y no suelen ser representativas de los permisos de usuario.

Campos de autenticación

Los campos de URL como la URL del token no heredan la URL base del conector y requieren la URL completa. Esto permite casos de uso en los que un proveedor utiliza una URL base diferente para la autenticación que la del resto de la API.

Campos obligatorios

Nota: el ID de cliente y el secreto de cliente suelen generarse desde el proveedor de la API. Consulta la documentación del proveedor para saber cómo generar estos valores para la autenticación.

Campo	Descripción
ID de cliente	Identificador de aplicación generado por el proveedor.
Secreto de cliente	Clave secreta de la aplicación generada por el proveedor.
url del token	URL utilizada para recuperar el token de acceso.

Campos adicionales

Campo	Descripción
Ámbito	Añade los ámbitos necesarios para un conector con un espacio separando cada ámbito (es decir, read write openid).
IntervaloDeActualización	Cuánto tiempo es válido el token de acceso. El valor predeterminado es 3600 segundos o 60 minutos.
Nombre de la conexión	El nombre de la conexión en UiPath una vez completada la autenticación.
Encabezado básico	Indica si el ID de cliente y el secreto se envían como un valor codificado en Base64 en el encabezado Authorization . Valor booleano (verdadero/falso); el valor predeterminado es verdadero.

Cómo funciona

Una vez añadidos o configurados todos los valores de campo para el conector , UiPath® genera una solicitud de autorización, pasando por las credenciales necesarias para generar un token de acceso. Dado que las credenciales de cliente OAuth 2.0 están destinadas a aplicaciones M2M, solo verás la página de autorización inicial de UiPath y no tendrás más redireccionamientos.

Una vez que se detecta un flujo de autorización correcto, UiPath mantiene la conexión mientras las credenciales proporcionadas sean válidas.

Formato de solicitud posterior a la autorización

Una vez completada la configuración inicial y realizada una conexión, todas las solicitudes realizadas para ese conector tienen el encabezado de autorización incluido automáticamente en la solicitud.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
  --header 'Authorization: Bearer {yourToken}',

Autenticación básica

Información general

El tipo de autenticación básica te permite definir un nombre de usuario y una contraseña que luego están codificados en Base64 y con el prefijo Basic. El nombre de usuario y la contraseña, que pueden modificarse, se utilizan en todas las solicitudes de conector como valor para el encabezado de Autorización.

Campos de autenticación

Campo	Descripción
Nombre de usuario	El primer valor de los dos puntos delineados y el valor del encabezado Authorization codificado en Base64.
Contraseña	El segundo valor en los dos puntos delineados y el valor del encabezado Authorization codificado en Base64.
Nombre de la conexión	El nombre de la conexión en UiPath una vez completada la autenticación.

Cómo funciona

Cuando se le proporcionan los valores de nombre de usuario y contraseña, UiPath® combina y separa por dos puntos los valores, los codifica en Base64 y los prefija Basic para generar un valor de encabezado Authorization (p. ej. Authorization: Basic base64(username:password)). Este valor de encabezado se pasa a cada solicitud como medio de autenticación.

Formato de solicitud posterior a la autorización

Una vez completada la configuración inicial y realizada una conexión, todas las solicitudes realizadas para ese conector tienen el encabezado de autorización incluido automáticamente en la solicitud.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
  --header 'Authorization: Basic base64(username:password)'

Clave API

Información general

Algunos proveedores ofrecen una clave API como forma de autenticación para acceder a sus recursos API. En el Creador de conectores, este tipo de autenticación da como resultado el uso de un encabezado 'X-Acess-Token: <provider_api_key>' que se pasa a las solicitudes de conector.

Campos de autenticación

Campo	Descripción
Clave API	La clave API generada por el proveedor de API que se utilizará como valor para el encabezado X-Access-Token en todas las solicitudes de conector.
Nombre de conexión	El nombre de la conexión en UiPath una vez completada la autenticación

Cómo funciona

Cuando se utiliza el valor de la clave API generada por el proveedor para el parámetro Clave API en Configuración - Autenticación, cada solicitud realizada para ese conector incluye un encabezado X-Access-Token con la clave API proporcionada como valor de encabezado.

Formato de solicitud posterior a la autorización

Una vez completada la configuración inicial y establecida una conexión, todas las solicitudes realizadas para ese conector tienen el encabezado X-Access-Token automáticamente incluido en la solicitud.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
  --header 'X-Access-Token: {yourtoken}'

Token de acceso personal

Información general

Algunos proveedores proporcionan tokens de acceso que no caducan y utilizan el patrón de encabezado Authorization: {access_token} para autenticar las solicitudes. El método de autenticación PAT te permite proporcionar el token de acceso necesario y aplica los encabezados enumerados anteriormente, pero no mantiene el token de acceso si caduca en algún momento.

Campos de autenticación

Campo	Descripción
Token de acceso personal	El token de acceso generado por el proveedor que se utilizará como valor en el campo de encabezado Authorization en todas las solicitudes de conector. El campo prefija de forma predeterminada el token con Bearer para adaptarse al patrón de autenticación de portador común.
Nombre de la conexión	El nombre de la conexión en UiPath una vez completada la autenticación.

Cómo funciona

Cuando utilizas el valor de la clave API generada por el proveedor para el parámetro Token Personal Access en Configuración - Autenticación, cada solicitud realizada para ese conector incluye un encabezado X-Access-Token con el token de acceso personal proporcionado como valor de encabezado.

Formato de solicitud posterior a la autorización

Una vez completada la configuración inicial y establecida una conexión, todas las solicitudes realizadas para ese conector tienen el encabezado Authorization automáticamente incluido en la solicitud.

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'
  --header 'Authorization: {personal_access_token}'

Personalizar

Información general

La autenticación personalizada debe utilizarse cuando la configuración del proveedor no sigue ninguno de los estándares, pero requiere que los detalles de autenticación se intercambien y envíen en cada solicitud.

Campos de autenticación

Los campos de autenticación personalizados vienen con un parámetro Authorization como campo de ejemplo, pero se pueden personalizar para que coincidan con los patrones de autenticación del proveedor de la API.

Cualquier parámetro añadido a la autenticación desde la autenticación personalizada se aplica a las solicitudes del conector.

Nota: Por ahora, la autenticación personalizada no te permite crear un flujo de autenticación personalizado. Te permite personalizar los parámetros de autenticación estándar aplicados a las solicitudes dentro del conector.

Cómo funciona

Los parámetros añadidos a la sección de autenticación se incluyen automáticamente en cualquier solicitud de conector.

Sin autenticación

La opción Sin autenticación proporciona una selección rápida de la lista y elimina todas las propiedades de la tabla de configuración de autenticación.

Cómo usarla

Utiliza esta opción si la aplicación del proveedor a la que te estás conectando está disponible sin tener que iniciar sesión. Puede ser un servicio público en línea o una API que se expone internamente dentro de la empresa. No requiere que se envíen encabezados en ninguna solicitud que identifique quién está realizando la llamada a la API.

Resultado al enviar una solicitud

curl --request GET \
  --url https://{baseUrl}/{resource} \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'