El generador de integración admite tipos de autorización estándar, como claves de API, tokens de portador, nombre de usuario y contraseña, y OAuth 2.0. Sin embargo, según las necesidades y los flujos de trabajo de su organización, la autorización estándar podría no ser suficiente. Es por eso que el generador de integraciones también admite un tipo de integración personalizada de solo autenticación que funciona con las soluciones de autenticación y autorización de su organización.
En este artículo se tratan los siguientes temas:
- Acerca de la autorización personalizada
- Configurar la autorización personalizada
- Probar la autorización personalizada
Acerca de la autorización personalizada
La integración personalizada de solo autenticación hace una solicitud de un token y su vencimiento, que luego pasa a la integración de datos o principal para obtener autorización y luego hacer la solicitud de los datos.
En general, el flujo de autorización personalizado es el siguiente:
- Solicitud de autorización. La integración configurada de solo autenticación envía una solicitud al servidor, solicitando permiso para recuperar un token de acceso. Si el servidor autentica la solicitud (procedente de Agentes IA – Avanzado), autoriza la recuperación del token de acceso y, si está disponible, su tiempo de vencimiento.
- Manejo del token. Después de que el servidor responde con el token de acceso, la integración almacena dos datos clave: el parámetro token en sí mismo y su parámetro expiresIn, que determina cuánto tiempo es válido el token.
- Pasar el token a la integración de datos. Estos dos parámetros (token y expiresIn) se pasan al siguiente paso, que es la integración de datos. El token se usa para autenticar las solicitudes subsiguientes realizadas por la integración de datos. El token se configura y maneja internamente, y nunca se expone a los datos de la sesión o la conversación.
- Solicitud de autorización personalizada para datos. Con el token de acceso en su lugar, la integración de datos ahora está autorizada para recuperar los datos necesarios, que se usan para enriquecer la conversación.
El diagrama de flujo a continuación ilustra el flujo de autorización personalizado.
Configurar la autorización personalizada
La autorización personalizada se configura como parte del proceso normal de creación de una integración en el generador de integración.
Para configurar la autorización personalizada en el generador de integración
- En el menú principal, haga clic en API Integrations.
- 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, asigne un nombre descriptivo a la integración.
- (Opcional) En el campo Descripción, ingrese una descripción de la integración que le ayude a recordar para qué sirve.
- Seleccione Configuración como una integración de “solo autenticación".
- Haga clic en Guardar.
- En la barra lateral izquierda, en Escenarios, pase el mouse por encima de Falla y seleccione el menú de opciones (
) y seleccione 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, cree dos parámetros de sesión (haciendo clic en el botón +) con los siguientes detalles:
- token
- Clave: token (debe escribirse exactamente así)
- Consulta: Ingrese un valor que defina el token. Por ejemplo: data.access_token
- expiresIn
- Clave: expiresIn (debe escribirse 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 sea parte de su respuesta de datos. En ese caso, puede codificar un valor (en segundos) de su elección. Por ejemplo: 3600
Recomendamos encarecidamente establecer una fecha de vencimiento del token. Si se encuentra con un error durante la prueba, este es el tiempo que tendrá que esperar antes de que se emita un nuevo token. Sin vencimiento, el token se establece indefinidamente, lo que significa que no podrá emitir uno nuevo durante la resolución de problemas.
- token
- Continúe creando la integración como lo haría normalmente. Si desea ayuda, consulte Explicación del Generador de integraciones.
- En la barra lateral izquierda, bajo Entornos, seleccione un entorno (como Producción).
- En la pestaña Autorización, en el campo desplegable Tipo de autorización, seleccione Personalizada.
- En el campo desplegable Integración de autorización de API, seleccione la integración personalizada de solo autenticación que creó anteriormente.
- Seleccione la pestaña Encabezados y haga clic en Agregar encabezado.
- Llene los siguientes campos:
- Clave: Autorización
-
Valor: Portador {{apiToken}} (debe escribirse exactamente así)
- Haga clic en Guardar.
Probar la autorización personalizada
Después de configurar la integración personalizada de solo autenticación, recomendamos probarla. Si desea ayuda, consulte Prueba de funcionalidad.
Resolución de problemas statusCode: null
Además, al probar la integración, es posible que encuentre un mensaje “statusCode: null”, como se muestra en la imagen a continuación:
Primero, verifique que la integración personalizada de solo autenticación se haya configurado correctamente de acuerdo con los pasos anteriores.
Luego, tome nota de dónde está ocurriendo el error. Si está en la integración de autenticación, es probable que algo no esté configurado correctamente, o que el URL al que se envía la solicitud sea incorrecto. En este caso, recomendamos consultar con los técnicos de su lado, ya que pueden proporcionar más información sobre lo que está mal.
Si ha seguido los pasos anteriores y sigue apareciendo este error, espere hasta que el token venza y vuelva a intentarlo.
Si ya probó todos estos pasos de solución de problemas y la integración sigue sin funcionar, comuníquese con su CSM para obtener más ayuda.