Documentación privada
Los administradores de planes de pago pueden configurar su portal de documentación como privado, impidiendo que cualquier persona en internet pueda acceder a él. El proyecto protegido puede ser visto por:
Quienes visiten el sitio de documentación e introduzcan una contraseña compartida.
Quienes abran un enlace compartido.
Lectores invitados mediante enlaces mágicos.
Flujo de inicio de sesión personalizado mediante JSON Web Tokens (JWT).
Inicio de sesión único (SSO).
Si tienes un plan enterprise, también ofrecemos autenticación de lectores a través de tu intranet.
También puedes mantener tu documentación pública y mostrar más contenido a los lectores que inicien sesión, con el acceso híbrido.
Comparación entre los diferentes métodos
Método | Nivel de seguridad | Facilidad de acceso | ¿Requiere un desarrollador? | Uso |
|---|---|---|---|---|
Débil. Tus lectores podrían filtrar la contraseña. | Hay que recordar una contraseña | No | Úsalo para bloquear a competidores y rastreadores. | |
Débil. Tus lectores podrían filtrar el enlace. | Fácil, basta con hacer clic en un enlace. | No | Úsalo para bloquear a competidores y rastreadores. | |
Fuerte | Fácil, los lectores van al sitio de documentación, solicitan un enlace mágico y lo abren. | No | Úsalo para proteger datos y controlar el acceso. | |
Fuerte | Fácil, el lector debe ir al sitio de documentación, pero quizá tenga que iniciar sesión en tu propio sitio. | Sí | Úsalo para proteger datos, controlar el acceso y personalizar la documentación. | |
Fuerte | Fácil, el lector debe ir al sitio de documentación, pero quizá tenga que iniciar sesión en el SSO. | No | Úsalo para proteger datos y controlar el acceso. | |
Intranet (solo Enterprise) | Fuerte | Fácil, el lector solo necesita ir al sitio de documentación. | Sí | Úsalo para proteger datos y controlar el acceso. |
Acceso híbrido
Con el acceso híbrido, tu documentación sigue siendo pública y los lectores que inician sesión ven más contenido. Los lectores con sesión iniciada ven el contenido de sus audiencias, y el resto lee la documentación pública sin iniciar sesión.
Deja el método de acceso en Público e inicia la sesión de los lectores con uno de estos métodos:
JWT: envía a los lectores a tu documentación con un token firmado en el enlace. Consulta Identificar lectores en un sitio de documentación público.
SSO de lectores: los lectores inician sesión desde tu proveedor de identidad. Contáctanos para configurarlo. Consulta Audiencias con SSO de lectores.
Configuración de la protección con contraseña
Para configurar la protección con contraseña:
Abre Project Settings → Access.
En la tarjeta Access method, selecciona Password.

Introduce la contraseña.
Haz clic en Save changes en el menú superior.

Perfecto, todas las páginas publicadas de este proyecto ahora están protegidas con una contraseña
Para probarlo, ve al modo en vivo de tu documentación. Se te mostrará una página como esta.

Una vez que un lector introduce la contraseña correcta, mantendrá la sesión iniciada durante 24 horas.
No debes guardar información confidencial o sensible en un proyecto protegido con contraseña. Esto sirve para evitar que el público general y los motores de búsqueda accedan a tus páginas, más que para proteger datos.
Compartir enlaces
Una vez que un proyecto está protegido con contraseña, puedes compartir un enlace que da acceso al proyecto sin necesidad de introducir la contraseña. Puedes usar esta función para dar acceso de lectura solo a tus clientes compartiendo este enlace internamente con ellos.
Para compartir un enlace:
Abre Project Settings → Access.
La tarjeta Sharing & invites muestra el enlace para compartir.

Haz clic en Copy link para copiarlo y pégalo donde lo necesites.
O, en Send by email, introduce las direcciones de correo de tus lectores separadas por comas y haz clic en Send.
El enlace se revocará cuando la contraseña cambie o se elimine.
Uso de la URL de inicio de sesión
Si tu documentación está protegida mediante un enlace compartido o un flujo de inicio de sesión personalizado, es probable que tus lectores deban autenticarse primero en tu propio sitio web, y debes proporcionarles una URL que les permita autenticarse en tu documentación. Para facilitarlo, podemos redirigir a los lectores no autenticados a una URL que tú especifiques, donde:
Si usas el uso compartido seguro de enlaces, los llevaría a la página donde pueden encontrar el enlace, o a la página que los redirige al enlace si están autenticados en tu propio sitio web.
Si usas el inicio de sesión personalizado, los llevaría a una página de autenticación que, si ya han iniciado sesión en tu propio sitio web, simplemente los redirige de vuelta con una URL válida al sitio de documentación; de lo contrario, les pediría iniciar sesión primero.
Para configurar la URL de inicio de sesión:
Abre Project Settings → Access.
En Login URL, introduce la URL. Un ejemplo sería
https://pied-piper.com/docs-login.Haz clic en Save changes en el menú superior.
Desactivar la protección
Para desactivar la protección con contraseña:
Abre Project Settings → Access.
En la tarjeta Access method, elige Public .
Haz clic en Save changes en el menú superior.
El proyecto quedará entonces sin protección.
Todas tus versiones publicadas seguirán publicadas. Si es necesario, asegúrate de despublicar cualquier versión que no quieras que sea accesible al público general antes de quitar la protección del proyecto.
Need help? Visit our community forums or contact us.