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:

  1. Shared Session: Utilice el mismo token de sesión utilizado por su panel para autenticar usuarios.
  2. 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.
  3. 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

  • Tiene un panel u otro portal de usuario alojado en su dominio.
  • Las credenciales de sesión de sus usuarios se almacenan como cookies.
  • Puede crear un nuevo punto final de API en el mismo origen o un subdominio de su panel.
    • Si su panel está en foo.com, la API URL debe comenzar con foo.com o *.foo.com
    • Si su panel está en dash.foo.com, la API URL debe comenzar con dash.foo.com o *.dash.foo.com
  • Sus documentos están alojados en el mismo dominio que su panel.
    • Si su panel está en foo.com, sus docsdebe ser alojado enfoo.como*.foo.com
    • Si tu panel de control está en*.foo.com, tusdocsdeben ser alojados enfoo.como*.foo.com

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