Proteger un flipbook con contraseña
Control de accesoActiva o desactiva la protección con contraseña de un flipbook y personaliza la pantalla de contraseña —el título, el placeholder del campo y el botón— con una sola llamada a la API.
APIs usadas en esta discusión
Qué puedes hacer
La protección con contraseña pone una barrera delante de un flipbook: los visitantes deben introducir la contraseña correcta antes de que cargue el contenido. Con una sola llamada a la API puedes:
- Activar la protección y fijar la contraseña de acceso.
- Desactivar la protección de nuevo.
- Personalizar la pantalla de contraseña — el encabezado, el placeholder del campo y la etiqueta del botón.
Antes de empezar
Vas a necesitar:
- Una clave de API — se envía en el encabezado
X-Api-Keyen cada solicitud. - El
flipbookId— el id numérico que se devuelve al crear un flipbook (comoID) o desde los endpoints de listado. - Las solicitudes van a la URL base
https://go.fliplink.me.
El cuerpo es form-urlencoded (no JSON).
Parámetros
Envía estos como campos urlencoded en PUT /api/set-password-access/{flipbookId}:
| Campo | Tipo | Qué hace |
|---|---|---|
IsPasswordProtected | boolean | true activa la barrera de contraseña; false la desactiva |
Password | text | La contraseña de acceso que deben introducir los visitantes |
PwdTitle | text | Encabezado que se muestra en la pantalla de contraseña (opcional) |
PwdPlaceholder | text | Texto del placeholder dentro del campo de contraseña (opcional) |
PwdButton | text | Etiqueta del botón de envío (opcional) |
Activa la protección con contraseña
Fija IsPasswordProtected=true y proporciona la Password. Los tres campos Pwd* son opcionales: inclúyelos
para personalizar lo que ve el visitante.
curl -X PUT 'https://go.fliplink.me/api/set-password-access/96216' \
-H 'X-Api-Key: YOUR_API_KEY' \
--data-urlencode 'IsPasswordProtected=true' \
--data-urlencode 'Password=spring-2026' \
--data-urlencode 'PwdTitle=Enter the access code' \
--data-urlencode 'PwdPlaceholder=Access code' \
--data-urlencode 'PwdButton=View document'
Respuesta:
{ "Result": "OK", "Message": "Updated successfully" }
Desactiva la protección con contraseña
Fija IsPasswordProtected=false. Puedes dejar los demás campos vacíos.
curl -X PUT 'https://go.fliplink.me/api/set-password-access/96216' \
-H 'X-Api-Key: YOUR_API_KEY' \
--data-urlencode 'IsPasswordProtected=false' \
--data-urlencode 'Password=' \
--data-urlencode 'PwdTitle=' \
--data-urlencode 'PwdPlaceholder=' \
--data-urlencode 'PwdButton='
Respuesta:
{ "Result": "OK", "Message": "Updated successfully" }
Personalizar la pantalla de contraseña
Los campos PwdTitle, PwdPlaceholder y PwdButton te permiten adaptar la barrera a tu audiencia — por
ejemplo, llamarla "código de acceso" en un portal de cliente, o ajustarla al tono de tu marca. Son opcionales;
omítelos (o envíalos vacíos) para usar los valores por defecto.
Errores posibles
- Clave de API ausente o no válida → HTTP
401. Esto devuelve una página HTML de "Unauthorized" sin formato — no hay cuerpo JSON. Comprueba que el encabezadoX-Api-Keyesté presente y sea correcto. flipbookIddesconocido (o uno que tu clave no posee) → HTTP200con{ "Result": "ERROR", "Message": "Item not found" }.- Campo del cuerpo mal escrito → HTTP
200con{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }. Vuelve a comprobar los nombres de los campos con la tabla de arriba.
Notas
- Comparte la contraseña por un canal aparte. Envía el enlace del flipbook y la contraseña por canales distintos — una contraseña incluida en el mismo correo que el enlace ofrece poca protección.
- La protección con contraseña es una sola capa. Controla la entrada, no quién es el visitante. Para restringir el acceso a personas concretas, combínala con una lista de correos permitidos; para limitar el acceso en el tiempo, combínala con la caducidad del enlace.