El generador de integraciones admite los tipos de autorización estándar (p. ej., claves de API, tokens de portador, nombre de usuario y contraseña, y OAuth 2.0). Sin embargo, es posible que la actualización estándar no baste para las necesidades y flujos de trabajo de su organización. Por ese motivo, el generador de integraciones también es compatible con un tipo de integración de “solo autenticación” personalizado que funciona con sus soluciones de autenticación y autorización.
En este artículo se tratan los siguientes temas:
- Acerca de la autorización personalizada
- Configuración de la autorización personalizada
- Creación de la integración de datos
- Prueba de la autorización personalizada
Acerca de la autorización personalizada
La integración de “solo autenticación” personalizada solicita un token con fecha de vencimiento, se lo pasa a la integración de datos (o a la principal) para que lo autorice y, a continuación, solicita los datos.
El flujo de autorización personalizado suele ser el siguiente:
- Se solicita la autorización. La integración de “solo autenticación” configurada envía una solicitud al servidor en la que pide permiso para recuperar un token de acceso. Si el servidor autentica la solicitud (que viene de los agentes IA), autoriza la recuperación del token de acceso y (si está disponible) de la fecha de vencimiento.
- Se procesa el token. Después de que el servidor responda con el token de acceso, la integración almacena dos elementos de información esenciales: el propio parámetro del token y su parámetro expiresIn, que determina durante cuánto tiempo es válido el token.
- Se pasa el token a la integración de datos. Estos dos parámetros (token y expiresIn) se envían a la integración de datos, que es el paso siguiente. Las solicitudes que hace la integración de datos posteriormente se autentican con el token, que se define y procesa internamente y nunca se expone a los datos de la sesión o la conversación.
- Se hace la solicitud de autorización personalizada para obtener los datos. Con el token de acceso, la integración de datos ya está autorizada para recuperar los datos necesarios, que se utilizan para enriquecer la conversación.
El siguiente diagrama de flujo ilustra el flujo de autorización personalizado.
Configuración de la autorización personalizada
La configuración de la autorización personalizada forma parte del proceso estándar para crear una integración en el generador de integraciones.
Para configurar la autorización personalizada en el generador de integraciones
- En el menú principal, haga clic en Integraciones de API.
- En la parte superior derecha, haga clic en Agregar integración.
- En la ventana Agregar integración:
- En el campo Nombre de la integración, escriba un nombre descriptivo para la integración.
- (Opcional) En el campo Descripción, describa la integración de un modo que le ayude a recordar para qué sirve.
- Seleccione Configurar como una integración de “solo autenticación”.
- Haga clic en Guardar.
- En la barra lateral izquierda, bajo Escenarios, pase el mouse por encima de Falla, seleccione el menú de opciones (
) y luego elija Borrar. Para la autorización personalizada, solo necesita escenarios de éxito. Los escenarios alternativos no se pueden borrar.
- En la página de escenarios de Éxito, haga clic en el botón + para crear dos parámetros de sesión con los siguientes datos:
- token
- Clave: token (escrito exactamente así)
- Consulta: ingrese un valor que defina el token (por ejemplo, data.access_token).
- expiresIn
- Clave: expiresIn (escrito exactamente así)
-
Consulta: ingrese un valor que defina el vencimiento del token (por ejemplo, data.expires_in).
Es posible que el vencimiento del token no forme parte de la respuesta de datos. En ese caso, dedique unos segundos a codificar el valor que desee (por ejemplo, 3600).
Siempre conviene establecer una fecha de vencimiento para el token. Si se produce un error al hacer pruebas, ese será el tiempo que tenga que esperar hasta que se emita un token nuevo. Si no se establece ninguna fecha de vencimiento, el token será válido indefinidamente y no se podrá emitir otro nuevo durante la fase de resolución de problemas.
- token
- Haga clic en Guardar.
Creación de la integración de datos
A continuación, cree la integración de datos que usará la integración de “solo autenticación” personalizada que creó en los pasos anteriores. Para ello, siga los pasos estándar para crear una nueva integración. Si necesita ayuda, consulte el artículo explicativo sobre el generador de integraciones.
Para crear la integración de datos
- En la barra lateral izquierda, bajo Entornos, seleccione un entorno (p. ej., Producción).
- En el campo desplegable Tipo de autorización de la pestaña Autorización, seleccione Personalizadas.
- En el campo desplegable Integración de autorización de API, seleccione la integración de “solo autenticación” personalizada que creó antes.
- Seleccione la pestaña Encabezados y haga clic en Agregar encabezado.
- Llene los siguientes campos:
- Clave: Authorization
-
Valor: Bearer {{apiToken}}(escrito exactamente así)
- Haga clic en Guardar.
Prueba de la autorización personalizada
Cuando termine de configurar la integración de “solo autenticación” personalizada, es aconsejable probarla. Si necesita ayuda, consulte Funcionalidad de prueba.
Resolución de problemas relacionados con el mensaje statusCode: null
Al probar la integración, podría encontrarse con el mensaje “statusCode: null” que se ve en esta imagen:
En primer lugar, verifique que la integración de “solo autenticación” personalizada esté configurada correctamente, según lo indicado en los pasos anteriores.
A continuación, fíjese en dónde se está produciendo el error. Si el error tiene su origen en la integración de autenticación, es posible que haya algo mal configurado o que el URL al que se está haciendo la solicitud sea incorrecto. En ese caso, lo mejor es que pregunte a sus propios ingenieros si pueden darle más información.
Si ha seguido los pasos anteriores y el error sigue produciéndose, espere a que venza el token y repita las pruebas.
Si la integración sigue sin funcionar después de haber seguido todos estos pasos de resolución de problemas, pida ayuda a su CSM.