La personalización adapta tu documentación para cada usuario cuando inicia sesión. Por ejemplo, puedes autocompletar sus claves de API, mostrar contenido específico para su plan o rol u ocultar secciones a las que no necesitan acceder.

​
Funciones de personalización

Personaliza el contenido con estas funciones de personalización.

​
Relleno previo de la clave de API

Rellena automáticamente los campos del Área de pruebas de API con valores específicos del usuario devolviendo nombres de campo que coincidan en tus datos de usuario. Los nombres de campo en tus datos de usuario deben coincidir exactamente con los nombres del Área de pruebas de API para que el relleno previo funcione automáticamente.

​
Contenido MDX dinámico

Muestra contenido dinámico según la información del usuario, como el nombre, el plan u organización, usando la variable user. 
Welcome back, {user.firstName}! Your {user.org?.plan} plan includes...
Consulta la sección Formato de datos del usuario a continuación para ver ejemplos detallados y recomendaciones de implementación.

​
Visibilidad de páginas

Restringe qué páginas son visibles para tus usuarios añadiendo campos groups al frontmatter de tus páginas. De forma predeterminada, todas las páginas son visibles para todos los usuarios. Los usuarios solo verán las páginas de los groups a los que pertenecen. 
---
title: "Managing your users"
description: "Adding and removing users from your organization"
groups: ["admin"]
---

​
Formato de datos de usuario

Al implementar la personalización, tu sistema devuelve datos de usuario en un formato específico que habilita la personalización del contenido. Estos datos pueden enviarse como un objeto JSON sin procesar o dentro de un JWT firmado, según tu método de handshake. La estructura de los datos es la misma en ambos casos. 
type User = {
  expiresAt?: number;
  groups?: string[];
  content?: Record<string, any>;
  apiPlaygroundInputs?: {
    header?: Record<string, any>;
    query?: Record<string, any>;
    cookie?: Record<string, any>;
    server?: Record<string, string>;
  };
};
​
expiresAt
number
Tiempo de expiración de la sesión en segundos desde la época (epoch). Si el usuario carga una página después de este tiempo, sus datos almacenados se eliminan automáticamente y debe volver a autenticarse.
Para handshakes con JWT: Esto difiere del claim exp del JWT, que determina cuándo un JWT se considera inválido. Configura el claim exp del JWT con una duración corta (10 segundos o menos) por seguridad. Usa expiresAt para la duración real de la sesión (de horas a semanas).
​
groups
string[]
Lista de grupos a los que pertenece el usuario. Las páginas con groups coincidentes en su frontmatter son visibles para este usuario.Ejemplo: Un usuario con groups: ["admin", "engineering"] puede acceder a páginas etiquetadas con los grupos admin o engineering.
​
content
object
Datos personalizados accesibles en tu contenido MDX mediante la variable user. Úsalos para personalización dinámica en toda tu documentación.Ejemplo básico:
{ "firstName": "Ronan", "company": "Acme Corp", "plan": "Enterprise" }
Uso en MDX:
Welcome back, {user.firstName}! Your {user.plan} plan includes...
Con el user del ejemplo, se mostraría: Welcome back, Ronan! Your Enterprise plan includes…Renderizado condicional avanzado:
Authentication is an enterprise feature. {
  user.org === undefined
    ? <>To access this feature, first create an account at the <a href="https://dashboard.mintlify.com/login">Mintlify dashboard</a>.</>
    : user.org.plan !== 'enterprise'
      ? <>You are currently on the ${user.org.plan ?? 'free'} plan. See <a href="https://mintlify.com/pricing">our pricing page</a> for information about upgrading.</>
      : <>To request this feature for your enterprise org, contact your admin.</>
}
La información en user solo está disponible para usuarios con sesión iniciada. Para usuarios sin sesión, el valor de user será {}. Para evitar que la página falle para usuarios sin sesión, usa siempre encadenamiento opcional en los campos de user. Por ejemplo, {user.org?.plan}.
​
apiPlaygroundInputs
object
Valores específicos del usuario que rellenan previamente los campos del Área de pruebas de API. Ahorra tiempo a los usuarios al autocompletar sus datos cuando prueban APIs.Ejemplo:
{
  "header": { "X-API-Key": "user_api_key_123" },
  "server": { "subdomain": "foo" },
  "query": { "org_id": "12345" }
}
Si un usuario realiza solicitudes en un subdominio específico, puedes enviar { server: { subdomain: 'foo' } } como campo apiPlaygroundInputs. Este valor se rellenará previamente en cualquier página de API que use el valor subdomain.
Los campos header, query y cookie solo se rellenarán previamente si forman parte de tu esquema de seguridad de OpenAPI. Si un campo está en las secciones Authorization o Server, se rellenará previamente. Crear un parámetro de cabecera estándar llamado Authorization no habilitará esta función.

​
Ejemplo de datos de usuario

{
  "expiresAt": 1735689600,
  "groups": ["admin", "beta-users"],
  "content": {
    "firstName": "Jane",
    "lastName": "Smith",
    "company": "TechCorp",
    "plan": "Enterprise",
    "region": "us-west"
  },
  "apiPlaygroundInputs": {
    "header": {
      "Authorization": "Bearer abc123",
      "X-Org-ID": "techcorp"
    },
    "server": {
      "environment": "production",
      "region": "us-west"
    }
  }
}

​
Configuración de la personalización

Selecciona el método de handshake que quieres configurar.

​
Requisitos previos

  • Un sistema de inicio de sesión que pueda generar y firmar JWT
  • Un servicio backend que pueda crear URL de redirección

​
Implementación

1

Genera una clave privada.

  1. En tu panel, ve a Authentication.
  2. Selecciona Personalization.
  3. Selecciona JWT.
  4. Ingresa la URL de tu flujo de inicio de sesión existente y selecciona Save changes.
  5. Selecciona Generate new key.
  6. Almacena tu clave de forma segura donde tu backend pueda acceder a ella.
2

Integra la personalización de Mintlify en tu flujo de inicio de sesión.

Modifica tu flujo de inicio de sesión existente para incluir estos pasos después de que el usuario inicie sesión:
  • Crea un JWT que contenga la información del usuario autenticado en el formato User. Consulta la sección User data format anterior para más información.
  • Firma el JWT con la clave secreta usando el algoritmo ES256.
  • Crea una URL de redirección de vuelta a tu documentación, incluyendo el JWT en el fragmento (hash).

​
Ejemplo

Tu documentación está alojada en docs.foo.com. Quieres que tu documentación esté separada de tu panel (o no tienes un panel) y habilitar la personalización.Genera un secreto de JWT. Luego crea un endpoint de inicio de sesión en https://foo.com/docs-login que inicie un flujo de inicio de sesión hacia tu documentación.Después de verificar las credenciales del usuario:
  • Genera un JWT con los datos del usuario en el formato de Mintlify.
  • Firma el JWT y redirige a https://docs.foo.com#{SIGNED_JWT}.
import * as jose from 'jose';
import { Request, Response } from 'express';

const TWO_WEEKS_IN_MS = 1000 * 60 * 60 * 24 * 7 * 2;

const signingKey = await jose.importPKCS8(process.env.MINTLIFY_PRIVATE_KEY, 'ES256');

export async function handleRequest(req: Request, res: Response) {
  const user = {
    expiresAt: Math.floor((Date.now() + TWO_WEEKS_IN_MS) / 1000),
    groups: res.locals.user.groups,
    content: {
      firstName: res.locals.user.firstName,
      lastName: res.locals.user.lastName,
    },
  };

  const jwt = await new jose.SignJWT(user)
    .setProtectedHeader({ alg: 'ES256' })
    .setExpirationTime('10 s')
    .sign(signingKey);

  return res.redirect(`https://docs.foo.com#${jwt}`);
}

​
Conservar anclas de página

Para redirigir a los usuarios a secciones específicas después del inicio de sesión, usa este formato de URL: https://docs.foo.com/page#jwt={SIGNED_JWT}&anchor={ANCHOR}.Ejemplo:
  • URL original: https://docs.foo.com/quickstart#step-one
  • URL de redirección: https://docs.foo.com/quickstart#jwt={SIGNED_JWT}&anchor=step-one