Esta es la documentación para el Handshake de Sesión CompartidaPersonalization. El Handshake de Sesión Compartida no está disponible para Autenticación.

Este método utiliza la información de autenticación de sesión ya almacenada en el navegador de tu usuario para crear una experiencia de documentación sin problemas.

​
Implementación

1

Crea tu API de Información

Crea un endpoint de API que utilice la autenticación de sesión para identificar usuarios, y responda con una carga útil JSON siguiendo el formatoUser.

Si el dominio de la API nocoincide exactamentecon el dominio de los docs:

  • Añade el dominio de los docs al encabezadoAccess-Control-Allow-Originde tu API (no debe ser*)
  • Asegúrate de que el encabezadoAccess-Control-Allow-Credentialsde tu API seatrue

Estas opciones CORS solo necesitan ser habilitadas en elúnico endpointresponsable de devolver la información del usuario. No recomendamos habilitar estas opciones en todos los endpoints del dashboard.

2

Configura tus ajustes de Personalización

Ve a tusajustes del dashboardy añade la URL de la API y tu URL de Inicio de Sesión a tus ajustes de Personalización.

​
Ejemplos

​
Dashboard en subdominio, docs en subdominio

Tengo un dashboard endash.foo.com, que utiliza autenticación de sesión basada en cookies. Mis rutas de API del dashboard están alojadas endash.foo.com/api. Quiero configurar la autenticación para mis docs alojados endocs.foo.com.

Para configurar la autenticación con Mintlify, creo otro endpoint del dashboarddash.foo.com/api/docs/user-infoque identifica al usuario usando autenticación de sesión, y responde con sus datos personalizados según la especificación de Mintlify. Luego añadohttps://docs.foo.coma la lista de permitidosAccess-Control-Allow-OriginAccess-Control-Allow-Originsolo para esta ruta, y aseguro que mi configuraciónAccess-Control-Allow-CredentialsAccess-Control-Allow-Credentialstrue solo para esta ruta.

Luego voy a los ajustes del dashboard e introduzcohttps://dash.foo.com/api/docs/user-infopara el campo URL de la API.

​
Dashboard en subdominio, docs en raíz

Tengo un dashboard endash.foo.com, que utiliza autenticación de sesión basada en cookies. Mis rutas de API del dashboard están alojadas endash.foo.com/api. Quiero configurar la autenticación para mis docs alojados enfoo.com/docs.

Para configurar la autenticación con Mintlify, creo otro endpoint del dashboarddash.foo.com/api/docs/user-infoque identifica al usuario usando autenticación de sesión, y responde con sus datos personalizados según la especificación de Mintlify. Luego añadohttps://foo.coma la lista de permitidosAccess-Control-Allow-OriginAccess-Control-Allow-Originsolo para esta ruta, y aseguro que mi configuraciónAccess-Control-Allow-CredentialsAccess-Control-Allow-Credentialstrue solo para esta ruta.

Luego voy a los ajustes del dashboard e introduzcohttps://dash.foo.com/api/docs/user-infopara el campo URL de la API.

​
Dashboard en raíz, docs en raíz

Tengo un dashboard enfoo.com/dashboard, que utiliza autenticación de sesión basada en cookies. Mis rutas de API del dashboard están alojadas enfoo.com/api. Quiero configurar la autenticación para mis docs alojados enfoo.com/docs.

Para configurar la autenticación con Mintlify, creo otro endpoint del dashboardfoo.com/api/docs/user-infoque identifica al usuario usando autenticación de sesión, y responde con sus datos personalizados según la especificación de Mintlify.

Luego voy a los ajustes del dashboard e introduzcohttps://foo.com/api/docs/user-infopara el campo URL de la API.