Configuración de personalización
Choosing a handshake
Esta es la documentación para los métodos de Personalization Handshake. La autenticación ofrece un conjunto diferente de métodos Handshake.
Antes de que sus usuarios puedan acceder al contenido personalizado, deben estar autenticados. Mintlify admite tres métodos de Personalization Handshake:
- Shared Session: Utilice el mismo token de sesión utilizado por su panel para autenticar usuarios.
- JWT: Use su propio flujo de inicio de sesión para enviar información del usuario a sus documentos a través de un JWT en la URL.
- OAuth 2.0: Intégrese con su servidor OAuth para habilitar el inicio de sesión del usuario a través del flujo PKCE.
Requisitos previos
Pros y Contras
Pros:
- Los usuarios que han iniciado sesión en tu panel de control automáticamente inician sesión en tus docs
- Las sesiones de tus usuarios son persistentes, lo que significa que puedes actualizar datos sin requerir inicio de sesión adicional
- Configuración mínima requerida
Cons:
- Tus docs harán una solicitud a tu backend, lo cual puede ser indeseable
- Debes tener un panel de control que use autenticación de sesión
- Generalmente se requiere configuración CORS
Pros:
- Los usuarios que han iniciado sesión en tu panel de control automáticamente inician sesión en tus docs
- Las sesiones de tus usuarios son persistentes, lo que significa que puedes actualizar datos sin requerir inicio de sesión adicional
- Configuración mínima requerida
Cons:
- Tus docs harán una solicitud a tu backend, lo cual puede ser indeseable
- Debes tener un panel de control que use autenticación de sesión
- Generalmente se requiere configuración CORS
Pros:
- Riesgo reducido de abuso del endpoint de API
- Cero configuración CORS
- Sin restricciones en las URLs de API
Cons:
- Debe ser capaz de conectarse a tu flujo de inicio de sesión existente
- Las sesiones del panel de control y la autenticación de docs están completamente desacopladas, por lo que los usuarios necesitarán iniciar sesión en tu panel de control y en tus docs por separado
- Cada vez que quieras actualizar los datos del usuario, tus usuarios deben volver a iniciar sesión en tus docs
- Si los datos de tus usuarios cambian con frecuencia, debes requerir que tus usuarios inicien sesión frecuentemente o arriesgarte a tener datos obsoletos en los docs
- Si los datos de tus usuarios rara vez cambian, esto no debería ser un problema
Pros:
- Estándar de seguridad elevado
- Sin restricciones en las URLs de API
Cons:
- Requiere trabajo significativo si se configura el servidor OAuth por primera vez
- Las sesiones del panel de control y la autenticación de docs están completamente desacopladas, por lo que los usuarios necesitarán iniciar sesión en tu panel de control y en tus docs por separado
- Puede ser excesivo para algunas aplicaciones