Configurar la experiencia del visor y el lector

Qué puedes hacer

Estos cinco endpoints configuran cómo se presenta un solo flipbook en el visor. Cada uno apunta a un flipbook por su {flipbookId} y actualiza un aspecto de la experiencia de visualización y lectura:

• Muestra u oculta botones individuales de la barra de herramientas del visor (descarga, impresión, compartir, pantalla completa, zoom, miniaturas, etc.).
• Configura la navegación del lector — miniaturas de página, tabla de contenido y cómo se desplazan los lectores entre páginas.
• Activa o desactiva el paso de página automático y define su intervalo.
• Define o quita la pista de música de fondo que suena en el visor.
• Define el contenido que se muestra en las cuatro esquinas (encabezado/pie) del marco del visor.

Antes de empezar

• Una clave de API, enviada como el encabezado X-Api-Key o como Authorization: Bearer YOUR_API_KEY en cada solicitud.
• El {flipbookId} — el ID numérico del flipbook, devuelto por create-by-file / create-by-url (como ID) o por list. Cada endpoint aquí lo recibe como parámetro de ruta.
• Todas las solicitudes van a la URL base https://go.fliplink.me.
• Cada cuerpo de solicitud aquí es form-urlencoded (no JSON). Envía cada campo con --data-urlencode.

Define los controles del visor

Muestra u oculta botones individuales de la barra de herramientas del visor (descarga, impresión, compartir, pantalla completa, zoom, miniaturas, etc.).

curl -X PUT 'https://go.fliplink.me/api/set-viewer-controls/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShowControls=true' \
  --data-urlencode 'IsPrint=false' \
  --data-urlencode 'IsDownload=false' \
  --data-urlencode 'IsThumbnails=true' \
  --data-urlencode 'IsSearch=true' \
  --data-urlencode 'IsSound=true' \
  --data-urlencode 'IsFullscreen=true' \
  --data-urlencode 'IsZoom=true' \
  --data-urlencode 'IsNotes=false'

Respuesta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Define la navegación del lector

Configura la navegación del lector en el visor — cómo se desplazan los lectores entre páginas. Los cuatro campos del cuerpo:

• BookLayout (número) — un diseño de página numérico. La API guarda el valor que envíes.
• ScrollBehaviour (número) — un modo de desplazamiento numérico; el valor por defecto es 1. El significado de cada valor se interpreta del lado del visor, y la API guarda el valor que envíes.
• IsNavFirstLast (booleano, true/false) — alterna la navegación de primera/última página.
• IsRightToLeft (booleano, true/false) — establece la lectura de derecha a izquierda.

Nota: estos ajustes de navegación del lector se aplican solo a los flipbooks. En un elemento Document se ignoran — la API responde This setting applies to Flipbook items only.

curl -X PUT 'https://go.fliplink.me/api/set-reader-navigation/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNavFirstLast=true' \
  --data-urlencode 'BookLayout=1' \
  --data-urlencode 'IsRightToLeft=false' \
  --data-urlencode 'ScrollBehaviour=1'

Respuesta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Define el paso automático

Activa o desactiva el paso de página automático en el visor y su intervalo. El valor AutoFlipInSecs va en milisegundos a pesar del nombre: 0 = desactivado, 3000 = 3 s, 5000 = 5 s, etc.

curl -X PUT 'https://go.fliplink.me/api/set-auto-flip/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AutoFlipInSecs=0'

Respuesta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Define la música de fondo

Define o quita la pista de música de fondo que suena en el visor. Usa un nombre de archivo de pista predefinida de /api/list-background-music en BackgroundMusic, o una URL de música personalizada subida en BackgroundMusicCustom.

curl -X PUT 'https://go.fliplink.me/api/set-background-music/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundMusic=' \
  --data-urlencode 'BackgroundMusicCustom=' \
  --data-urlencode 'IsBackgroundMusicLoop=false'

Respuesta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Define el diseño de encabezado/pie

Define el contenido que se muestra en las cuatro esquinas (encabezado/pie) del marco del visor: TopLeft, TopRight, BottomLeft y BottomRight.

curl -X PUT 'https://go.fliplink.me/api/set-header-footer-layout/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'TopLeft=' \
  --data-urlencode 'TopRight=' \
  --data-urlencode 'BottomLeft=' \
  --data-urlencode 'BottomRight='

Respuesta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Errores posibles

Los cinco endpoints comparten el mismo comportamiento de error:

• 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 encabezado X-Api-Key (o Authorization: Bearer) esté presente y sea correcto.
• ID de elemento no encontrado o no perteneciente a tu clave → HTTP 200 con Message "Item not found".
• Campo del cuerpo desconocido o mal escrito → HTTP 200 con Message "Unknown field(s) '…'. Expected: …".

Un Result de "OK" significa que el cambio se aplicó; de lo contrario, lee el Message para saber el motivo.