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 en general invalida la conexión que podrías haber creado en el 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.
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. Las opciones compatibles son:

• 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á configurando cómo debe autenticarse cualquier persona que use su conector. Este será usted mientras crea el conector, pero también podrían ser otros los que terminen usando su creación.

Autenticación básica

1. Selecciona Editar en la columna Acción para configurar cada propiedad. El nombre de usuario y la contraseña están disponibles de forma predeterminada.

2. Selecciona Agregar parámetro si deseas agregar otro campo para ser utilizado durante la autenticación:

   • Nombre para mostrar : se le muestra al usuario cuando se conecta.
   • Tipo : define el campo de entrada en el cuadro de diálogo de conexión. Selecciona una opción del menú desplegable: verdadero / falso, contraseña, prueba, sí / no.
   • Preguntar al usuario : establézcalo en Sí cuando se requiera una entrada del usuario.
   • Valor : utiliza este campo para establecer un valor predeterminado.
   • Texto de sugerencia: guía para el usuario sobre el campo de entrada.
   • Nombre del proveedor : la clave técnica para la llamada a la API.
   • Enviar al proveedor como tipo : cómo recibe la API el valor. Seleccione una opción del menú desplegable: configuración, encabezado, ruta, cuerpo, consulta, formulario. Valor predeterminado: header.
   
   

   

   
   
3. Selecciona Guardar para guardar tu nuevo parámetro de autenticación.
4. Utilice la opción Restablecer a los valores predeterminados si desea restablecer su autenticación a los valores originales de la versión Básica. Esta operación no se puede deshacer.

Código de autorización OAuth 2.0

Para usar el código de autorización OAuth 2.0, debe crear una aplicación OAuth en la aplicación que desea integrar y recuperar desde allí las credenciales necesarias para configurar su conector.

Configure los siguientes campos:

• ID de cliente
• Secreto de cliente
• Ámbito
• URL de autorización
• url del token
• Actualizar la URL del token
• Encabezado básico
• URL de revocación del token

• IntervaloDeActualización

  Nota: Las URL de autorización, token y actualización del token deben estar disponibles en la documentación de la API de la aplicación.

Código de autorización OAuth 2.0 con PKCE

El código de autorización OAuth 2.0 con PKCE es idéntico al método del código de autorización OAuth 2.0, pero también incluye el campo Método de desafío del código PKCE de OAuth2 .

Credenciales de cliente OAuth 2.0

Para las credenciales de cliente OAuth 2.0, debe configurar los siguientes campos:

• ID de cliente
• Secreto de cliente
• Ámbito
• url del token
• Encabezado básico

• IntervaloDeActualización

Clave API

Use esta opción para integrarse con aplicaciones que requieran una clave API para realizar llamadas a la API.

Establece el campo Clave API en el valor deseado.

Token de acceso personal

Use esta opción para integrarse con aplicaciones que requieran un token de portador para realizar llamadas a la API.

Establece el campo Token de acceso personal en tu token al portador.

Personalizar

También puedes configurar una autenticación personalizada, utilizando los campos que desees.

Sin autenticación

Utilice esta opción si no necesita que los usuarios se autentiquen para utilizar el conector.